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

Update a payroll by ID

This endpoint allows you to update information for one or more employees for a specific unprocessed payroll. You can think of the unprocessed payroll object as a template of fields that you can update. You cannot modify the structure of the payroll object through this endpoint, only values of the fields included in the payroll. If you do not include specific employee compensations or fixed/hourly compensations in your request body, they will not be removed from the payroll.

scope: payrolls:write

Path Params
string
required

The UUID of the company

string
required

The UUID of the payroll

Body Params
employee_compensations
array of objects
required
employee_compensations*
string
enum

The payment schedule tax rate the payroll is based on. Only relevant for off-cycle payrolls.

Allowed:
boolean

Block regular deductions and contributions for this payroll. Only relevant for off-cycle payrolls.

boolean

Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only relevant for off-cycle payrolls.

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