GUgusto
Payrolls

Cancel a payroll

Changed on

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 4pm PT on the payroll_deadline

scope: payrolls:run

put/v1/companies/{company_id}/payrolls/{payroll_id}/cancel

Request

Path parameters

company_idstring required

The UUID of the company

payroll_idstring required

The UUID of the payroll

Headers

X-Gusto-API-Version'2026-06-15'

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

Response

Successful

payroll_deadlinestring date-time

A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.

check_datestring

The date on which employees will be paid for the payroll.

processedboolean

Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.

processed_datestring nullable

The date at which the payroll was processed. Null if the payroll isn't processed yet.

calculated_atstring date-time nullable

A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.

uuidstring

The UUID of the payroll.

payroll_uuidstring

The UUID of the payroll.

company_uuidstring

The UUID of the company for the payroll.

off_cycleboolean

Indicates whether the payroll is an off-cycle payroll

off_cycle_reason'Adhoc' | 'Benefit reversal' | 'Bonus' | 'Correction' | 'Dismissed employee' | 'Hired employee' | 'Wage correction' | 'Tax reconciliation' | 'Reversal' | 'Disability insurance distribution' | 'Transition from old pay schedule' nullable

The off-cycle reason. Only included for off-cycle payrolls.

auto_payrollboolean

Indicates whether the payroll has automatic payroll enabled

externalboolean

Indicates whether the payroll is an external payroll

created_atstring date-time

Datetime for when the resource was created.

partner_owned_disbursementboolean nullable

Will money movement for the payroll be performed by the partner rather than by Gusto?

Changes

  • f98575fa2a5eRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status