Paychex

Array of companies that your application has been granted with some level of access. Your Application (API Key) can be g…

Information about a single company that your application has access to.

Array of locations set at the company level.

Information about a single Location.

Lists workers (employees and contractors) for a company your application has been granted access to.

Information about a unique worker (employee and contractor) that your application has been granted access to. Currently…

Add one or more workers to a specific company that your application has access to. Workers will be added with an IN_PROG…

Update a unique worker (employee and contractor) that your application has been granted access to modify.

Delete in progress Worker

Information about “Active” or “In-progress” workers communications.

A “Active” or “In-progress” workers single communication item.

Add a single communication to the “Active” or “In-progress” worker.

Update a “Active” or “In-progress” workers specific communication item.

Remove a communication item from an “Active” or “In-Progress” worker. A communication type of “STREET_ADDRESS” or “PO_BO…

Get all contacts for the specified worker.

Get a worker contact by contactId.

Add one or more contacts to a worker. A contact may represent a person or entity (organization) but not both. A contact…

Update a worker contact. A contact may represent a person or entity (organization) but not both. A contact must have at…

Delete a worker contact by contactId.

Get the worker’s customFields

Get the worker’s customFields by workerCustomFieldId

Create CustomField at the worker level

Update CustomField at the worker level

Delete CustomField at the worker level

Array of direct deposits for an “Active” or “In-Progress” worker.

Single direct deposit for an “Active” or “In-Progress” worker.

Add a direct deposit to an “Active” or “In-Progress” worker.

Update a single direct deposit for an “Active” or “In-Progress” worker. “In-Progress” workers cannot be PATCHED using Co…

Update multiple direct deposits for an “Active” or “In-Progress” worker at a time. “In-Progress” workers cannot be PATCH…

Remove a single direct deposit for an “Active” or “In-Progress” worker.

Information about a workers compensation rates. A worker can have up to 25 different rates.It’s not required for a worke…

A workers single compensation rate.

Add a single compensation rate to the “Active” or “In-progress” worker.

Update a workers specific compensation rate.

Remove a compensation rate from a worker.

Information about a workers compensation.

Federal tax setup for an “Active” or “In-progress” worker.

WARNING: This endpoint will be deprecated on 1/30/2026. Until this date, POST federal tax will behave both as a POST and…

Update the federal tax setup for an “Active” or “In-progress” worker. The patching will allow you to change the combinat…

Information about worker’s state tax allocation.

<h3>Add and Replace existing state tax data for a given worker</h3>

Emitted when a worker’s employment record changes (added, changed, or deleted). Maps to Paychex domain WRKR_EMPL.

Emitted when a worker’s tax setup changes (federal/state). Maps to Paychex domain WRKR_TAX.

Emitted when a worker’s compensation or pay rate changes. Maps to Paychex domain WRKR_CMP.

Emitted when a worker’s organizational assignment or labor allocation changes. Maps to Paychex domain WRKR_ASGN.

Emitted when a worker’s demographic or personal information changes. Maps to Paychex domain WRKR_DEM.

Emitted when a worker’s address changes. Maps to Paychex domain WRKR_ADD.

Emitted when company-level demographic information changes. Maps to Paychex domain CLT_DEM.

Emitted when a company’s organizational structure changes. Maps to Paychex domain CLT_ORG.

Emitted when company payroll configuration changes. Maps to Paychex domain CLT_PYRN.

Emitted when a company-level pay component (earning/deduction) definition changes. Maps to Paychex domain CLT_PAY_COMP.

Emitted when application client-access grants change. Maps to Paychex domain CLT_ACCESS.

Emitted when a pay period is added or changed. Maps to Paychex domain PAY_PERIOD.

Emitted when Paychex raises a system alert for the company. Maps to Paychex domain PAYX_ALERT.