GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference
These docs are for v2024-04-01. Click to read the latest docs for v2025-11-15.

Prepare a payroll for update

Prepares an unprocessed payroll for update, including: adding or removing eligible employees from the payroll, and updating check_date, payroll_deadline, and payroll_status_meta dates and times.

Use this endpoint before calling PUT /v1/companies/{company_id}/payrolls/{payroll_id}.

Notes

  • Nullifies calculated_at and totals if the payroll was previously calculated
  • Returns the version parameter required for updating the payroll
  • employees:read scope is required to include employee compensations data in the response.
  • Results are paginated, with a maximum page size of 100 employee compensations.

scope: payrolls:write employees:read

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here!