Delete a payroll
DELETE {{baseUrl}}/v1/companies/:company_id/payrolls/:payroll_id?async=<boolean>
This endpoint allows you to delete an unprocessed payroll.
By default the payroll and associated data is deleted synchronously. To request an asynchronous delete, use the async=true query parameter. In both cases validation of ability to delete will be performed and an Unprocessable Entity error will be returned if the payroll is not able to be deleted. A successful synchronous delete will return 204/No Content. When a payroll has been enqueued for asynchronous deletion, 202/Accepted will be returned.
scope: payrolls:run
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
async | string | When true, request an asynchronous delete of the payroll. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. |