Payroll calculations trigger the calculation of payroll for a specific payroll. This is a long-running operation that returns a batch job for tracking the calculation status.
Calculate Payroll
Triggers calculation for the specified payroll identified by payrollGUID. Applies to all current employments in that payroll.
This endpoint initiates a long-running background job to perform the calculation. The response includes a batch job that can be polled to check the status of the calculation.
Validation:
- The payroll must exist
- There must be no ongoing calculation jobs for this integration
SecuritybearerAuth
Request
Responses
202
Calculation request accepted
default
General Error
post/payroll-calculations/{payrollGuid}/calculate
Request samples
- curl
- C#
- Java
- PHP
Response samples
- 202
- default
application/vnd.api+json
{- "data": {
- "type": "batch-jobs",
- "id": "c9f53621-86c3-4e5a-97f7-56165388cf41",
- "attributes": {
- "status": "queued",
- "lastUpdatedDateTime": "2019-08-24T14:15:22Z",
- "retryAfterSeconds": 0,
- "location": "string"
},
}
}