v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Payrolls

Skip a payroll

Submits a $0 payroll for employees associated with the pay schedule to skip payroll. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, the payroll is transitioned to the processed state.

If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses.

scope: payrolls:run

post/v1/companies/{company_uuid}/payrolls/skip

Path parameters

company_uuidstring required

The UUID of the company

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.

Request body

payroll_type'Regular' | 'Hired employee' | 'Dismissed employee' | 'Transition from old pay schedule' required

Payroll type

start_datestring

Pay period start date

end_datestring

Pay period end date. If left empty, defaults to today's date. Required when skipping a termination payroll (payroll_type = Dismissed employee).

pay_schedule_uuidstring

The UUID of the pay schedule. Required when skipping a termination payroll (payroll_type = Dismissed employee).

employee_uuidsstring[] nullable

An array of employees. This field is only applicable to new hire payroll and termination payroll

Response

Accepted