Delete a payroll
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
- Base URLhttps://api.gusto-demo.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The UUID of the company
The UUID of the payroll
Query parameters
When true, request an asynchronous delete 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
Changes
No recorded changes to this operation across all 2 revisions of this API.