GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference
These docs are for v2024-03-01. Click to read the latest docs for v2026-02-01.

Cancel a payroll

Transitions a processed payroll back to the unprocessed state. A payroll can be canceled if it meets both criteria:

  • processed is true
  • Current time is earlier than 3:30pm PT on the payroll_deadline

scope: payrolls:run

Path Params
string
required

The UUID of the company

string
required

The UUID of the payroll

Headers
string
enum
Defaults to 2024-03-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:
Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json