For AI agents: visit https://docs.gusto.com/embedded-payroll/v2025-11-15/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
These docs are for v2025-11-15. Click to read the latest docs for v2026-06-15.
- Deprecated field
auto_pilotin favor of auto_payroll in all Payroll and Pay Schedule objects.
- Affected
Payroll endpoints:
- Affected
Pay Schedule endpoints:
- Deprecated fields
id, effective_from, and effective_to from current_home_address and all_home_addresses. Affected endpoints include:
- Updated how
reimbursements are reflected in the Payroll objects. Reimbursements are no longer an aggregated fixed_compensation, instead they are now objects within a dedicated reimbursements array. Affected endpoints include:
- Updated error handling for Update a payroll by ID
payroll_items error key has been deprecated in favor of employee_compensations error key.
- The associated error messages have also been updated as a part of this change.
- When setting an employee's
payment_method to Direct Deposit, if the employee does not have a bank account on file the API will return a 422 response.
- Added required fields
pay_schedule_uuid and end_date when skipping a termination payroll with Skip a payroll
- Updated
per_anniversary_year time off policies to support the carryover_limit_hours field. Previously this was an unsupported field and an error was thrown. Affected endpoints include:
- Fix bug in Sign a contractor document to correctly map
exemption_from_FATCA, other, and other_text fields.
