PApaychex
Payroll

Worker Checks

Get check(s) that are for a specific worker within a processed or unprocessed pay period.

get/workers/{workerId}/checks

Request

Path parameters

workerIdstring required

ID associated with desired worker.

Query parameters

payperiodidstring required

The id assigned to the pay period that the check will be within.

filterbyuseridboolean

Filter by User Id.

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.