PApaychex
Payroll

Company Checks

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

get/companies/{companyId}/checks

Request

Path parameters

companyIdstring required

ID associated with desired company.

Query parameters

payperiodidstring required

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

offsetinteger

The zero based offset of the next page of data to be presented.

limitinteger

The maximum number of elements to be returned in a page transition.

filterbyuseridboolean

Filter by User Id.

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.