Worker

Worker Direct Deposits

Array of direct deposits for an "Active" or "In-Progress" worker.

get/workers/{workerId}/directdeposits

Request

Base URL
https://api.paychex.com
Auth
none declared
TypeScript
https://skmtc.dev/paychex/apis/external-api/docs/workers/:workerId/directdeposits/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workerIdstring required

ID associated with desired worker.

Query parameters

effectivitydatestring

The effectivity date.

asofstring

Returns all direct deposits as of the date used in the request

Response

Successful operation

Example response

{
  "content": {
    "directDepositId": "1020026420675252",
    "startDate": "2017-09-11T00:00:00Z",
    "paymentType": "PERCENTAGE",
    "accountType": "CHECKING",
    "value": 75,
    "routingNumber": "222371863",
    "accountNumber": "123456",
    "priority": "1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.