Checks

Verbs supported: POST

EndpointDescription
https://api.paychex.com/workers/{workerId}/checksAdd a check to a worker for an unprocessed pay period.
https://api.paychex.com/companies/{companyId}/checksAdd a check for one or more worker within a company for an available pay period.


Request (Body):

Element NameTypeDescription
workerIdstringThe id assigned to the worker that the requested for. This is not required when using the worker endpoint.
payPeriodIDstringThe id for the unprocessed payperiod.
checkCorrelationIdstringId that you define which is used for error handling/responses. This is not required when sending a single check.
earningsobjectThe earnings to apply to the check. Each earning needs to define as one of the following:
  • payHours: Will use the default hourly rate defined on the worker to apply the hours against.
  • payHours & payRate: Will allow you to define the monetary rate that the hours will be applied against.
  • payHours & payRateId: Will allow you to define which workers predefined pay rate the hours will be applied against.
  • payUnits: Will use the default hourly rate defined on the worker to apply the units against.
  • payUnits & payRate: Will allow you to define the monetary rate that the units will be applied against.
  • payUnits & payRateId: Will allow you to define which workers predefined pay rate the units will be applied against.
  • payAmount: Will allow you to define straight monetary amount.


Earnings

Element NameTypeDescription
checkComponentIdstringThe unique identifier associated for the pay component on this check.
componentIDstringThe unique identifier of the pay component.
namestringThe name given to the pay component
classificationTypestringThe category that this component falls into.
effectOnPaystringThe effect that the pay component will have on the check amount.
payRatenumberThe rate amount that will be applied for this component. Used in conjunction with Hours or Units.
payRateIdnumberThe rate identifier for the worker’s compensation
payHoursnumberThe number of hours that will be applied for this component. Used in conjunction with rate.
payUnitsnumberThe number of units that will be applied for this component. Used in conjunction with rate.
payAmountnumberThe flat amount to be applied for this component. Not used with Rate, Hours, or Units.
organizationobjectThis is used for assigning an organization to an earning. This option is only available when the client has simple labor distribution (SLD) configured for Payroll. If a client has SLD enabled and an organization is not specified the default org for the worker will be applied. You can check with your Payroll Specialist if your company is setup for SLD.
[
        {
        "payPeriodId": "1020026427391732",
        "workerId": "004UWBZQJ7GEB9TVWFR9",
        "checkCorrelationId": "yourID_1",
        "earnings": [
                {"componentId":"1020021373899133", "payHours":"4"},
                {"componentId":"1020021373899133", "payHours":"5", "payRate":"22.50"},
                {"componentId":"1020021373899133", "payHours":"6", "payRateId":"1020026420674940"},
                {"componentId":"1020021373899133", "payUnits":"7"},
                {"componentId":"1020021373899133", "payUnits":"8", "payRate":"7.25"},
                {"componentId":"1020021373899133", "payUnits":"9", "payRateId":"1020026420674942"},
                {"componentId":"1020021373899318", "payAmount":"300.60",
                        "organization": {
                        "organizationId": "1020022951957523"
                    }
                }
                ]
        },
        {
        "payPeriodId": "1020026427391732",
        "workerId": "00Z1IQF9J0MIGR3K3VXO",
        "checkCorrelationId": "yourID_2",
        "earnings": [
                {"componentId":"1020021373899318", "payAmount":"250.00"}
                ]
        }
]

Endpoint: https://api.paychex.com/workers/{workerId}/checks?payperiodid={payPeriodId}

Verbs supported: GET

GET: Get check(s) that are for a specific worker within a pay period that has not been processed.

Request:

Element NameTypeDescription
workerIdstringThe id assigned to the worker that the requested for.
payPeriodIdstringThe id assigned to the pay period that the the check will be within.

Response:

VerbDescription
GETChecks profile.

Endpoint: https://api.paychex.com/workers/{workerId}/checks/{checkID}

Verbs supported: GET & DELETE

GET: Retrieve a specific unprocessed check that a worker has.

DELETE: Remove a specific unprocessed check that a worker has.

Request:

Element NameTypeDescription
workerIdstringThe id assigned to the worker that workers are being requested for.
checkIdstringThe id of a single check that a workers has.

Response:

VerbDescription
GETSingle check profile.
DELETEGETS any existing checks for the worker within the deleted checks pay period.

Response

Profile: Check

The representational state of a check.
Element NameTypeDescription
workerIdstringThe unique identifier associated a worker representation.
paycheckIdstringThe identifier used to identify a pay check.
payPeriodIdstringThe identifier used to identify a pay period.
earningsobjectInformation about the workers earnings.

{
    "content": [
        {
            "workerId": "004UWBZQJ7GEB9TVWFR9",
            "paycheckId": "1020026552555440",
            "payPeriodId": "1020026427391732",
            "earnings": [
                {
                    "componentId": "1020021373899133",
                    "checkComponentId": "1020026552555441",
                    "name": "Hourly",
                    "classificationType": "REGULAR",
                    "effectOnPay": "ADDITION",
                    "payRate": "40.2000",
                    "payHours": "4",
                    "organization": {
                        "organizationId": "1020022951957515",
                        "name": " Branch A - East"
                    }
                },
                {
                    "componentId": "1020021373899133",
                    "checkComponentId": "1020026552555442",
                    "name": "Hourly",
                    "classificationType": "REGULAR",
                    "effectOnPay": "ADDITION",
                    "payRate": "22.50",
                    "payHours": "5",
                    "organization": {
                        "organizationId": "1020022951957515",
                        "name": " Branch A - East"
                    }
                },
                {
                    "componentId": "1020021373899133",
                    "checkComponentId": "1020026552555443",
                    "name": "Hourly",
                    "classificationType": "REGULAR",
                    "effectOnPay": "ADDITION",
                    "payRate": "11.2200",
                    "payHours": "6",
                    "organization": {
                        "organizationId": "1020022951957515",
                        "name": " Branch A - East"
                    }
                },
                {
                    "componentId": "1020021373899133",
                    "checkComponentId": "1020026552555444",
                    "name": "Hourly",
                    "classificationType": "REGULAR",
                    "effectOnPay": "ADDITION",
                    "payRate": "40.2000",
                    "payUnits": "7",
                    "organization": {
                        "organizationId": "1020022951957515",
                        "name": " Branch A - East"
                    }
                },
                {
                    "componentId": "1020021373899133",
                    "checkComponentId": "1020026552555445",
                    "name": "Hourly",
                    "classificationType": "REGULAR",
                    "effectOnPay": "ADDITION",
                    "payRate": "7.25",
                    "payUnits": "8",
                    "organization": {
                        "organizationId": "1020022951957515",
                        "name": " Branch A - East"
                    }
                },
                {
                    "componentId": "1020021373899133",
                    "checkComponentId": "1020026552555446",
                    "name": "Hourly",
                    "classificationType": "REGULAR",
                    "effectOnPay": "ADDITION",
                    "payRate": "18.5200",
                    "payUnits": "9",
                    "organization": {
                        "organizationId": "1020022951957515",
                        "name": " Branch A - East"
                    }
                },
                {
                    "componentId": "1020021373899318",
                    "checkComponentId": "1020026552555447",
                    "name": "Bonus",
                    "classificationType": "SUPPLEMENTAL",
                    "effectOnPay": "ADDITION",
                    "payAmount": "300.60",
                    "organization": {
                        "organizationId": "1020022951957523",
                        "name": " Branch B - West"
                    }
                },
                {
                    "componentId": "1020021373899318",
                    "checkComponentId": "1020026552555448",
                    "name": "Bonus",
                    "classificationType": "SUPPLEMENTAL",
                    "effectOnPay": "ADDITION",
                    "payAmount": "50.00",
                    "organization": {
                        "organizationId": "1020022951957515",
                        "name": " Branch A - East"
                    }
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.paychex.com/workers/004UWBZQJ7GEB9TVWFR9/checks/1020026552555444"
                }
            ]
        },
        {
            "workerId": "00Z1IQF9J0MIGR3K3VXO",
            "paycheckId": "1020026552555461",
            "payPeriodId": "1020026427391732",
            "earnings": [
                {
                    "componentId": "1020021373899318",
                    "checkComponentId": "1020026552555462",
                    "name": "Bonus",
                    "classificationType": "SUPPLEMENTAL",
                    "effectOnPay": "ADDITION",
                    "payAmount": "250.00",
                    "organization": {
                        "organizationId": "1020022951957523",
                        "name": " Branch B - West"
                    }
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.paychex.com/workers/00Z1IQF9J0MIGR3K3VXO/checks/1020026552555462"
                }
            ]
        }
    ]
}