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 guide.

Endpoint Updates

• Deprecated field auto_pilotin favor of auto_payroll affecting Payroll and Pay Schedule objects. Affected endpoints include:
  • Get the pay schedules for a company
  • Get a pay schedule
  • Get all payrolls for a company
  • Get a single payroll
  • Prepare a payroll for update
  • Update a payroll by ID
• Deprecated fields id, effective_from, effective_to from Employee Home Address objects. Affected endpoints include:
  • Get employees of a company
  • Get an employee
  • Get an employee's home addresses
  • Get an employee's home address
• 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.