v1
latestOpenAPI 3.1.02026-07-243113441.2 MBCalculate a payroll
Performs calculations for taxes, benefits, and deductions for an unprocessed payroll. The calculated payroll details provide a preview of the actual values that will be used when the payroll is run.
This calculation is asynchronous and a successful request responds with a 202 HTTP status. To view the details of the calculated payroll, use the GET /v1/companies/{company_id}/payrolls/{payroll_id} endpoint with include=taxes,benefits,deductions params.
If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses.
scope: payrolls:run
Path parameters
The UUID of the company
The UUID of the payroll
Headers
Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Response
Accepted