InTouch Hub · Blue Isle Software

ADP

Read ADP Workforce Now workers and pay statements via the ADP HR & Payroll REST APIs.

Licensed connector — not free. ADP requires a paid licence from Blue Isle. You may download and install it, but it will not execute until a valid licence is applied — the server checks at run time. Contact Blue Isle to licence it.

Supported by Blue Isle. This is a commercially licensed connector, maintained and supported by Blue Isle Software under the terms of your licence agreement. Talk to Blue Isle about licensing and support.

adpagreementhrlevelpayrollservicestatus

ADP Tool

Read ADP Workforce Now workers and pay statements via the ADP HR & Payroll REST APIs.

Tool ID

adp-payroll

Credential Required

Yes — a server-refreshed oauth credential (auth mode oauth_user). The InTouch server resolves and refreshes the linked oauth credential and hands the tool a live access token at execution time; the tool never stores or refreshes tokens itself. Mint one with itcli.py /oauth. Every request is sent as Authorization: Bearer <access_token> to the fixed base URL https://api.adp.com.

Credential Properties

Property Type Default Description
client_id string — OAuth app client ID (your registered ADP API app)
client_secret string — OAuth app client secret (if required on refresh)
token_url string — Provider OAuth token endpoint — used to refresh
access_token string — Required. Current access token — kept fresh by the server; do not edit by hand
refresh_token string — Refresh token; enables automatic server-side refresh
token_type string Bearer Token type
scope string — Granted OAuth scopes (space-separated)
expires_at string — Access-token expiry in epoch seconds (0 = non-expiring)

Operations

1. list_workers — List all workers

Reads the workers in your ADP Workforce Now instance.

Calls GET /hr/v2/workers.

Properties:

Property Type Default Description
query string — Optional query params as a JSON object string, e.g. {"$top": 20, "$skip": 0}

Published Outputs: - result — the JSON response body - status — HTTP status code

2. get_worker — Get one worker

Reads a single worker by Associate OID.

Calls GET /hr/v2/workers/{aoid}.

Properties:

Property Type Default Description
aoid string — Required. Associate OID of the worker
query string — Optional query params as a JSON object string, e.g. {"$top": 20, "$skip": 0}

Published Outputs: - result — the JSON response body - status — HTTP status code

3. list_pay_statements — List a worker's pay statements

Reads the pay statements for one worker.

Calls GET /payroll/v1/workers/{aoid}/pay-statements.

Properties:

Property Type Default Description
aoid string — Required. Associate OID of the worker
query string — Optional query params as a JSON object string, e.g. {"$top": 20, "$skip": 0}

Published Outputs: - result — the JSON response body - status — HTTP status code

4. get_pay_statement — Get one pay statement

Reads a single pay statement for a worker.

Calls GET /payroll/v1/workers/{aoid}/pay-statements/{payStatementId}.

Properties:

Property Type Default Description
aoid string — Required. Associate OID of the worker
payStatementId string — Required. Pay statement id
query string — Optional query params as a JSON object string, e.g. {"$top": 20, "$skip": 0}

Published Outputs: - result — the JSON response body - status — HTTP status code

License

Requires a per-tool connector license on Department/Enterprise editions (Personal/Solo/Team editions are unaffected). Apply the license via the tool's Apply License action.

Self-Contained JAR

The jar bundles all runtime dependencies; only intouch-tool-api is provided by the server.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.