> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Paychex

> How to set up the Paychex connector, plus the actions and events that are available.

![Paychex](https://stackone-logos.com/api/paychex/filled/svg)

Betav2.0.0[See changelog](https://docs.stackone.com/connectors/paychex/changelog.md)

[41 actions](#actions) · [13 events](#events) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/paychex/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Connect to Paychex using OAuth 2.0 client credentials. Register an application in the Paychex Developer Portal and reque...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/paychex/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

41 actions

ActionDescription

Companies`paychex_list_companies`

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

A Company`paychex_get_company`

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

Company Locations`paychex_list_company_locations`

Array of locations set at the company level.

Company Location`paychex_get_company_location`

Information about a single Location.

Company Workers`paychex_list_workers`

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

Worker`paychex_get_worker`

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

In Progress Workers`paychex_create_worker`

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

Worker`paychex_update_worker`

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

Worker`paychex_delete_worker`

Delete in progress Worker

Worker Communications`paychex_list_worker_communications`

Information about "Active" or "In-progress" workers communications.

Worker Communication`paychex_get_worker_communication`

A "Active" or "In-progress" workers single communication item.

Worker Communication`paychex_create_worker_communication`

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

Worker Communication`paychex_update_worker_communication`

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

Worker Communication`paychex_delete_worker_communication`

Remove a communication item from an "Active" or "In-Progress" worker. A communication type of "STREET\_ADDRESS" or "PO\_BO...

Worker Contacts`paychex_list_worker_contacts`

Get all contacts for the specified worker.

Worker Contact`paychex_get_worker_contact`

Get a worker contact by contactId.

Worker Contacts`paychex_create_worker_contact`

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

Worker Contacts`paychex_update_worker_contact`

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

Worker Contact`paychex_delete_worker_contact`

Delete a worker contact by contactId.

Worker Custom Fields`paychex_list_worker_customfields`

Get the worker's customFields

Worker Custom Field`paychex_get_worker_customfield`

Get the worker's customFields by workerCustomFieldId

Worker Custom Field`paychex_create_worker_customfield`

Create CustomField at the worker level

Worker CustomField`paychex_update_worker_customfield`

Update CustomField at the worker level

Worker Custom Field`paychex_delete_worker_customfield`

Delete CustomField at the worker level

Worker Direct Deposits`paychex_list_worker_directdeposits`

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

Worker Direct Deposit`paychex_get_worker_directdeposit`

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

Worker Direct Deposit`paychex_create_worker_directdeposit`

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

Worker Direct Deposit`paychex_update_worker_directdeposit`

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

Worker Direct Deposits`paychex_update_worker_directdeposits`

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

Worker Direct Deposit`paychex_delete_worker_directdeposit`

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

Worker Pay Rates`paychex_list_worker_payrates`

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

Worker Pay Rate`paychex_get_worker_payrate`

A workers single compensation rate.

Worker Pay Rate`paychex_create_worker_payrate`

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

Worker Pay Rate`paychex_update_worker_payrate`

Update a workers specific compensation rate.

Worker Pay Rate`paychex_delete_worker_payrate`

Remove a compensation rate from a worker.

Worker Compensation`paychex_get_worker_compensation`

Information about a workers compensation.

Worker Federal Tax`paychex_get_worker_federaltax`

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

Worker Federal Tax`paychex_create_worker_federaltax`

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

Worker Federal Tax`paychex_update_worker_federaltax`

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

Worker State Tax`paychex_get_worker_statetaxes`

Information about worker's state tax allocation.

Worker State Tax`paychex_update_worker_statetaxes`

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

## Events

Tags

Select all
|
Clear

Alerts

Companies

Pay Periods

Webhooks

Workers

No tags found

13 events

EventDescriptionTags

Worker Employment Changed`paychex_webhook_wrkr_empl`

Emitted when a worker's employment record changes (added, changed, or deleted). Maps to Paychex domain WRKR\_EMPL.

WorkersWebhooks

Worker Tax Changed`paychex_webhook_wrkr_tax`

Emitted when a worker's tax setup changes (federal/state). Maps to Paychex domain WRKR\_TAX.

WorkersWebhooks

Worker Compensation Changed`paychex_webhook_wrkr_cmp`

Emitted when a worker's compensation or pay rate changes. Maps to Paychex domain WRKR\_CMP.

WorkersWebhooks

Worker Assignment Changed`paychex_webhook_wrkr_asgn`

Emitted when a worker's organizational assignment or labor allocation changes. Maps to Paychex domain WRKR\_ASGN.

WorkersWebhooks

Worker Demographics Changed`paychex_webhook_wrkr_dem`

Emitted when a worker's demographic or personal information changes. Maps to Paychex domain WRKR\_DEM.

WorkersWebhooks

Worker Address Changed`paychex_webhook_wrkr_add`

Emitted when a worker's address changes. Maps to Paychex domain WRKR\_ADD.

WorkersWebhooks

Company Demographics Changed`paychex_webhook_clt_dem`

Emitted when company-level demographic information changes. Maps to Paychex domain CLT\_DEM.

CompaniesWebhooks

Company Organization Changed`paychex_webhook_clt_org`

Emitted when a company's organizational structure changes. Maps to Paychex domain CLT\_ORG.

CompaniesWebhooks

Company Payroll Changed`paychex_webhook_clt_pyrn`

Emitted when company payroll configuration changes. Maps to Paychex domain CLT\_PYRN.

CompaniesWebhooks

Company Pay Component Changed`paychex_webhook_clt_pay_comp`

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

CompaniesWebhooks

Client Access Changed`paychex_webhook_clt_access`

Emitted when application client-access grants change. Maps to Paychex domain CLT\_ACCESS.

CompaniesWebhooks

Pay Period Changed`paychex_webhook_pay_period`

Emitted when a pay period is added or changed. Maps to Paychex domain PAY\_PERIOD.

Pay PeriodsWebhooks

Paychex Alert`paychex_webhook_payx_alert`

Emitted when Paychex raises a system alert for the company. Maps to Paychex domain PAYX\_ALERT.

AlertsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.