GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Prepare a payroll for update

put
https://api.gusto-demo.com/v1/companies//payrolls//prepare

This endpoint will build the payroll and get it ready for making updates. This includes adding/removing eligible employees from the Payroll and updating the check_date, payroll_deadline, and payroll_status_meta dates & times. Results are paginated, with a maximum page size of 100 employee_compensations.

Notes:

  • Will null out calculated_at & totals if a payroll has already been calculated.
  • Will return the version param used for updating the payroll

scope: payrolls:write

Path Params
string
required

The UUID of the company

string
required

The UUID of the payroll

Query Params
integer

The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.

integer

Number of objects per page. For majority of endpoints will default to 25

string
enum

Sort employee compensations by name

Allowed:
Body Params
employee_uuids
array of strings | null

An array of employee UUIDs. If passed, only those employees payroll items will be prepared.

employee_uuids
Headers
string
enum
Defaults to 2026-02-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

Updated 3 days ago

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

Updated 3 days ago