PApaychex
Payroll

Worker Check

Add a check to a worker for an unprocessed pay period.

post/workers/{workerId}/checks

Request

Path parameters

workerIdstring required

ID associated with desired worker.

Request body

workerIdstring

The id assigned to the worker

paycheckIdstring

The id of a single check that a workers has.

payPeriodIdstring

The id for the unprocessed payperiod.

checkCorrelationIdstring

Id that you define which is used for error handling/responses. This is not required when sending a single check.

blockAutoDistributiontrue | false

This is used optionally for blocking the auto distribution of the earnings on the workers if they are setup for auto distribution.

Example request

{
  "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"
      }
    }
  ]
}

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.