PApaychex
Payroll

Worker Check

Retrieve a specific unprocessed or processed check that a worker has.

get/workers/{workerId}/checks/{externalCheckId}

Request

Path parameters

workerIdstring required

ID associated with desired worker.

Response

successful operation

Example response

{
  "content": {
    "workerId": "004UWBZQJ7GEB9TVWFR9",
    "paycheckId": "1020026552555444",
    "payPeriodId": "1020026427391732",
    "checkCorrelationId": "yourID_1",
    "earnings": [
      {
        "checkComponentId": "1020026552555441",
        "name": "Hourly",
        "classificationType": "REGULAR",
        "effectOnPay": "ADDITION",
        "payRate": "40.2",
        "payUnits": "4",
        "organization": {
          "organizationId": "1020022951957523",
          "name": "2 Division B",
          "number": "1"
        }
      }
    ],
    "deductions": [
      {
        "checkComponentId": "1020026552555441",
        "name": "Hourly",
        "classificationType": "REGULAR",
        "effectOnPay": "ADDITION",
        "payRate": "40.2",
        "payUnits": "4",
        "organization": {
          "organizationId": "1020022951957523",
          "name": "2 Division B",
          "number": "1"
        }
      }
    ],
    "informational": [
      {
        "checkComponentId": "1020026552555441",
        "name": "Hourly",
        "classificationType": "REGULAR",
        "effectOnPay": "ADDITION",
        "payRate": "40.2",
        "payUnits": "4",
        "organization": {
          "organizationId": "1020022951957523",
          "name": "2 Division B",
          "number": "1"
        }
      }
    ],
    "taxes": [
      {
        "checkComponentId": "1020026552555441",
        "name": "Hourly",
        "classificationType": "REGULAR",
        "effectOnPay": "ADDITION",
        "payRate": "40.2",
        "payUnits": "4",
        "organization": {
          "organizationId": "1020022951957523",
          "name": "2 Division B",
          "number": "1"
        }
      }
    ]
  }
}

Changes

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