v2025-11-15

This is the changelog for v2025-11-15, which contains breaking changes.

To learn more about versions in our API, check out our Versioning and Version upgrade guides.

Endpoint updates

• Deprecated field auto_pilotin favor of auto_payroll in all Payroll and Pay Schedule objects.
  • Affected Payroll endpoints:
    • Create an off-cycle payroll
    • Get all payrolls for a company
    • Get a single payroll
    • Update a payroll by ID
    • Prepare a payroll for update
  • Affected Pay Schedule endpoints:
    • Create a new pay schedule
    • Get the pay schedules for a company
    • Get a pay schedule
    • Update a pay schedule
• Deprecated fields id, effective_from, and effective_to from current_home_address and all_home_addresses. Affected endpoints include:
  • Get employees of a company
  • Get an employee
• 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:
  • Get a single payroll
  • Prepare a payroll for update
  • Update a payroll by ID
• 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:
  • Create a time off policy
  • Update a time off policy
• Fix bug in Sign a contractor document to correctly map exemption_from_FATCA, other, and other_text fields.