Payroll

Company Checks

Add a check for one or more worker within a company for an available pay period.

post/companies/{companyId}/checks

Request

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

Path parameters

companyIdstring required

ID associated with desired company.

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.

blockAutoDistributionboolean

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

checkDatestring

The check date

Example request

{
  "workerId": "004UWBZQJ7GEB9TVWFR9",
  "paycheckId": "1020026552555444",
  "payPeriodId": "1020026427391732",
  "earnings": [
    {
      "componentId": "970000076689381",
      "code": "1",
      "name": "Hourly",
      "classificationType": "Regular",
      "description": "Use for regular pay.",
      "effectOnPay": "ADDITION",
      "startDate": "2016-01-01T00:00:00Z",
      "calculationType": "SCHEDULED_AMOUNT",
      "payRate": "7.25",
      "payHours": "4",
      "organization": {
        "organizationId": "970000055981384",
        "name": "2 Division B",
        "number": "2",
        "level": "Level 2"
      }
    }
  ],
  "deductions": [
    {
      "componentId": "970000076689381",
      "code": "1",
      "name": "Hourly",
      "classificationType": "Regular",
      "description": "Use for regular pay.",
      "effectOnPay": "ADDITION",
      "startDate": "2016-01-01T00:00:00Z",
      "calculationType": "SCHEDULED_AMOUNT",
      "payRate": "7.25",
      "payHours": "4",
      "organization": {
        "organizationId": "970000055981384",
        "name": "2 Division B",
        "number": "2",
        "level": "Level 2"
      }
    }
  ],
  "checkDate": "2019-05-12T20:00:00Z",
  "informational": [
    {
      "componentId": "970000076689381",
      "code": "1",
      "name": "Hourly",
      "classificationType": "Regular",
      "description": "Use for regular pay.",
      "effectOnPay": "ADDITION",
      "startDate": "2016-01-01T00:00:00Z",
      "calculationType": "SCHEDULED_AMOUNT",
      "payRate": "7.25",
      "payHours": "4",
      "organization": {
        "organizationId": "970000055981384",
        "name": "2 Division B",
        "number": "2",
        "level": "Level 2"
      }
    }
  ],
  "taxes": [
    {
      "componentId": "970000076689381",
      "code": "1",
      "name": "Hourly",
      "classificationType": "Regular",
      "description": "Use for regular pay.",
      "effectOnPay": "ADDITION",
      "startDate": "2016-01-01T00:00:00Z",
      "calculationType": "SCHEDULED_AMOUNT",
      "payRate": "7.25",
      "payHours": "4",
      "organization": {
        "organizationId": "970000055981384",
        "name": "2 Division B",
        "number": "2",
        "level": "Level 2"
      }
    }
  ]
}

Response

successful operation

Example response

{
  "content": {
    "workerId": "004UWBZQJ7GEB9TVWFR9",
    "paycheckId": "1020026552555444",
    "payPeriodId": "1020026427391732",
    "earnings": [
      {
        "componentId": "970000076689381",
        "code": "1",
        "name": "Hourly",
        "classificationType": "Regular",
        "description": "Use for regular pay.",
        "effectOnPay": "ADDITION",
        "startDate": "2016-01-01T00:00:00Z",
        "calculationType": "SCHEDULED_AMOUNT",
        "payRate": "7.25",
        "payHours": "4",
        "organization": {
          "organizationId": "970000055981384",
          "name": "2 Division B",
          "number": "2",
          "level": "Level 2"
        }
      }
    ],
    "deductions": [
      {
        "componentId": "970000076689381",
        "code": "1",
        "name": "Hourly",
        "classificationType": "Regular",
        "description": "Use for regular pay.",
        "effectOnPay": "ADDITION",
        "startDate": "2016-01-01T00:00:00Z",
        "calculationType": "SCHEDULED_AMOUNT",
        "payRate": "7.25",
        "payHours": "4",
        "organization": {
          "organizationId": "970000055981384",
          "name": "2 Division B",
          "number": "2",
          "level": "Level 2"
        }
      }
    ],
    "checkDate": "2019-05-12T20:00:00Z",
    "informational": [
      {
        "componentId": "970000076689381",
        "code": "1",
        "name": "Hourly",
        "classificationType": "Regular",
        "description": "Use for regular pay.",
        "effectOnPay": "ADDITION",
        "startDate": "2016-01-01T00:00:00Z",
        "calculationType": "SCHEDULED_AMOUNT",
        "payRate": "7.25",
        "payHours": "4",
        "organization": {
          "organizationId": "970000055981384",
          "name": "2 Division B",
          "number": "2",
          "level": "Level 2"
        }
      }
    ],
    "taxes": [
      {
        "componentId": "970000076689381",
        "code": "1",
        "name": "Hourly",
        "classificationType": "Regular",
        "description": "Use for regular pay.",
        "effectOnPay": "ADDITION",
        "startDate": "2016-01-01T00:00:00Z",
        "calculationType": "SCHEDULED_AMOUNT",
        "payRate": "7.25",
        "payHours": "4",
        "organization": {
          "organizationId": "970000055981384",
          "name": "2 Division B",
          "number": "2",
          "level": "Level 2"
        }
      }
    ]
  }
}

Changes

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