What's New:

11.30.2022 |COMING SOON!

• Ability to add a 'postal code extension' on an in-progress or active workers address (in the 'communications' array), and have it reflect correctly in Flex people (estimated release 12/8)
   
• Paging will be improved on the, 'GET workers', call.  The response time has been improved by ~80%. This will be most noticeable on larger clients (>500 employees).  (estimated release 12/1)
   
• For 'GET PayPeriods' we have added the ability filter by Date Range and Multi-Statuses (12/1)

08.18.2022 |NEW! For our partners, we now have a new endpoint to link Paychex clients to your production app, so you no longer need to reach out to support to link them! You simply need to enter the Paychex Clients 'company id' ( known as the 'DisplayID'). This is the 8 digit number known to all Paychex clients. Our logic will validate the client is active and exists.  If successful, the response will send back a URL in which you can send to the Paychex client that your working with ​so they can simply click on the link (which will bring them to the area in Flex for them to agree to the legal terms and approve your integration!) its that simple!

As an added, optional feature, if you subscribe to our webhooks, via the 'CLT_ACCESS" domain, you will get a notification on when the client has "Approved" your integration so you know they are fully integrated with your solution!

also as part of this release we made some cosmetic changes to the Flex UI to be more consistent and easier to understand when working with API integrations.

07.11.2022 | COMING SOON! For our partners, we will be providing an endpoint to link Paychex clients to your production app, so you no longer need to reach out to support to link them. You simply need to enter the Paychex Clients 'Company id' ( known as the 'DisplayID'). This is the 8 digit number known to all Paychex clients. Our logic will validate the client is active and exists. If successful, the response will send back a URL in which you can send to the Paychex client that your working with ​so they can simply click on the link (which will bring them to the area in Flex for them to agree to the legal terms and approve your integration!) it's that simple!

As an added, optional feature, if you subscribe to our webhooks, via the 'CLT_ACCES' domain, you will get a notification on when the client has "Approved" your integration so you know they are fully integrated with your solution!

06.16.2022 |NEW! We have added a new VMT profile (application/vnd.paychex.workers.roster) to get a list or 'roster' of just active workers on a company with very minimal data (First name, Last name, Mailing Address, Email Address, employeeid) this is an efficient way to grab a full roster of just the 'active' workers without waiting to pull back an extensive list of workers using our core endpoint!   See GET /companies/{companyId}/workers under the 'Content type' drop down list of profiles you can use with this endpoint.

06.09.2022 |NEW! We have just released a new set of added endpoints to be able to add, update, delete emergency contacts on workers and push them into flex.  This can be done for in progress or active workers! You can add multiple emergency contacts for each employee and select a primary contact. Navigate to our worker resource here!

05.27.2022 | ***ALERT***  From approx. 2 am to 9am EST , we experienced unplanned downtime for our company API's.  We apologize for this inconvenience.

03.04.2022 | COMING SOON ! UI changes in Paychex Flex for where clients accept or create integrations! We will be changing the name of "Connected Applications"  to "Integrated apps" within 'Company Settings'. Also the location will be moved to a section named 'Access' instead of the current section named 'Other'. We expect this change to occur on 3/10/22. Also, coming soon, we will be releasing a new set of endpoints to be able to add, update, delete emergency contacts on workers and push them into flex.  This can be done for in progress or active workers! You can add multiple emergency contacts for each employee and select a primary contact.

11.18.2021 | NEW! A new endpoint 'Worker Statuses' has been added, that allows you to retrieve the full list of worker statuses (past, present, and future) to get a full history on that worker. Located on our 'Worker' resource in the ’API' tab. Also coming soon in the next few weeks, we will be adding the capability to POST, PATCH, GET, DELETE, 'reoccurring earnings' on the existing worker pay component endpoints, whereas current we only allow deduction types.

11.16.2020 | **SUPPORT ALERT** - We have a known issue currently where some consumers may see an API-2 error stating that "Your application is not authorized to access the resource”. If this is happening, you can check the header or your calls, to be sure to change from bearer to Bearer in the value. We have a case sensitive issue with this and are working on a fix.

11.12.2020 | Launch of new Paychex API Developer Center - Welcome to the new Paychex API Developer Center! Please take time to check out the new site with advanced features and Open API documentation. Information on our sandbox, please note! If you are a new consumer and have not yet created an app with us, then the sandbox functionally will be temporarily unavailable to you, as we are working to improve it as part of the new dev portal experience! If you have an immediate need to test your integration or have any questions on this, please contact support . If you are an existing consumer, using a legacy apps built before 11/12/2020, you can continue to use the sandbox as you do today, as long as your authenticating with https://sandbox.api.paychex.com.

11.12.2020 | Updated Bearer Token size - Starting on this date, our API's will be getting a security boost, which will result in a change in the length of the returned bearer token from an authentication call. To keep things running smoothly with your app make sure your solution can accommodate a much larger bearer token! Depending on what your access settings are for your app, the size of the token can now be up to 4.65KB or 4650 characters, but typically around 2KB or 2000 characters.

Latest Releases:

08.18.2022 |Partner Endpoint and UI changes! For our partners, we now have a new endpoint to link Paychex clients to your production app, so you no longer need to reach out to support to link them! You simply need to enter the Paychex Clients 'company id' ( known as the 'DisplayID'). This is the 8 digit number known to all Paychex clients. Our logic will validate the client is active and exists.  If successful, the response will send back a URL in which you can send to the Paychex client that your working with ​so they can simply click on the link (which will bring them to the area in Flex for them to agree to the legal terms and approve your integration!) its that simple!

As an added, optional feature, if you subscribe to our webhooks, via the 'CLT_ACCESS" domain, you will get a notification on when the client has "Approved" your integration so you know they are fully integrated with your solution!

also as part of this release we made some cosmetic changes to the Flex UI to be more consistent and easier to understand when working with API integrations.

03.10.2022 | Company Settings in Flex UI - UI changes in Paychex Flex for where clients accept or create integrations! New name of "Connected Applications"  to "Integrated apps" within 'Company Settings'. Also the location was moved to a section named 'Access' instead of the current section named 'Other'.

10.09.2020 | Delete Checks in Bulk - For companies with a large amount of workers, we have added the ability to delete unprocessed checks in bulk, should you need to delete they due to failed payrun! More information can be found within the API References.

08.13.2020 | Custom Fields - We now support custom fields! Create a custom field on a client and add that field value to a worker! More information can be found within the API References. 

7.10.2020 | Effective Date on Payrates - Added effectivity on payrates. Endpoint: url/workers/{workerId}/compensation/payrates

You can now POST an effectiveDate on a payrate! Request body will have effectiveDate data element. Response body will also have effectiveDate data element. More information can be found within the API References. 

5.01.2020 | Effectivity on PayComponents - We now have effectivity on the workers payComponents(recurring deductions). You can pull the list and single based on a date and also add/update for a specific date in the body of the request. Basically, we allow you to pull the list and single based on a date and also add/update for a specific date in the body of the request like this:

GET >>> {{url}}/workers/{{workerID}}/paycomponents?asof=2020-01-04T00:00:00Z 
GET >>> {url}}/workers/{{workerID}}/paycomponents/{pcid}?asof=2019-01-18T00:00:00Z

01.16.2020 | In-Progress Worker Federal Tax- Federal tax object updated to align with the new 2020 IRS W-4 form. **This is a breaking change**.

01.16.2020 | Pay Component enhancements - Company and Workers Pay Components have multiple filter options. Company Pay Component has a new code element. Un-Processed checks can have its Pay Components Added, Deleted, and Updated.

07.18.2019 | Worker Time off Balances - Get a workers time off balances.

07.12.2019 | Job Management - Ability to POST and PATCH companies jobs. A GET is available to get details on segmentation company settings.

05.03.2019 | Processed Payroll - Ability to GET processed payroll check details. You will need to have the payroll API product to use this functionality.

03.14.2019 | Payroll: Job Costing and Labor Distribution - Get Company setup for Locations and Labor setups. Get Workers home location, job, and Labor Assignments. Checks to allow block auto distribution, job overrides, labor assignment overrides. More information can be found within the API References.

01.17.2019 | PayPeriod - Get a single pay period. More information can be found within the API References.

12.05.2018 | Payroll (Checks) - New single check endpoint, allowing memoing on a POST, and line dating an earning. More information can be found within the API References.

10.29.2018 | Worker Add - Ability to add (POST) a new worker. More information can be found within the Worker API Reference.

03.29.2018 | Worker Pay Components - The worker pay components will allow you to manage a workers recurring deductions. We have also included some new company level resources that will be needed to manage the workers pay components. More information can be found within the API References.