The Payroll API provides all the capabilities needed to integrate pay data with Paychex Flex. It exposes resources for Pay Components, Pay Periods and Checks. You will be using these end points, in combination with foundational APIs to create your solution. Please refer to the Quick Start guide to get an understanding of the core functionality of the Paychex API.
This will allow solutions to send and work with unprocessed check information as well as retrieve processed check information. The most common unprocessed check use cases are adding hours worked and commission/bonus/tip amounts to checks in Flex payroll entry. While an API solution can be used to send payroll data, the client or Paychex service provider must still review and complete the submission of the payroll for processing. The most common processed check use cases are retrieving calculated check information for all employees paid (or one particular employee) in a particular pay period.
If you are interested in the Payroll API, please contact your Paychex sales rep, service provider, or use the contact us link on this website.
The company pay period calendar enables syncing and ensuring wages are paid on the correct dates. Pay periods are typically used for applying earnings and deductions that a worker accumulated within the pay period range that can be added into one or more checks. The API supports the use of both unprocessed and processed pay periods. An unprocessed pay period allows for creating and retrieving unprocessed checks. A processed pay period allows only for the retrieval of checks.
Note: The API will not allow the use of a pay period which is currently processing. Use of the pay period will be allowed once the processing has completed.
Companies can define the pay components that are applicable to their business and are used in constructing a workers check. The pay components are put into classifications and can have different effects on the outcome of the check. The company can set when these pay components are available by defining start and end dates, these dates come into play when creating a check in conjunction with the pay periods date range. The API will allow you to pull back all of the Pay Components that the company has. When dealing with unprocessed checks (creation and retrieval) the API currently will only allow the Pay Components that are non-deductions on checks. When dealing with processed checks (retrieval only), the API will return all Pay Components on the check (earnings, deductions, and informational pay components which have no effect on pay).
The API will allow you to work with earnings on unprocessed checks. Using the other resources like workers, pay period, and pay components you have the ability to POST, GET, and DELETE earnings for unprocessed checks. When creating checks you have the ability to define for a worker their earnings using the pay components and combination of rate/amounts. When predefined configurations like reoccurring earnings and deductions are set on a worker these will automatically be applied to the check when it is created from the API.
For processed checks (checks in pay periods which have already processed), the API will allow you to GET all pay components (earnings, deductions, and informational) and taxes (employee withholding tax amounts and employer liability amounts) pertaining to the check.