GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
API Reference
v2023-09-01 is in the deprecation process and all prior versions have been deprecated. Click this banner to review our version upgrade guide.

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

Path Params
string
required

The UUID of the company

Body Params
string
required

Payroll type

string

Pay period start date

string

Pay period end date. If left empty, defaults to today's date.

string

The UUID of the pay schedule

employee_uuids
array of strings

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

employee_uuids
Headers
string
Defaults to 2024-04-01

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

Responses
202

Accepted

404

Not Found

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

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