This is the changelog for v2024-03-01, which contains breaking changes.

To learn more about versions in our API, check out our Versioning guide.

Endpoint Updates

To improve performance of payroll API endpoints, v2024-03-01 introduces the following changes:

• Prepare a payroll for update endpoint
  • Removed standard unused/$0 fixed_compensations from fixed_compensations array
    • Non-standard fixed_compensations - Owner's Draw, Minimum Wage Adjustment and Severance - will be included, even if unused or $0, when applicable
  • Removed version from top level response
  • Added fixed_compensation_types array
  • Added version to each employee_compensation
• Update a payroll by ID endpoint
  • Removed standard unused/$0 fixed_compensations from fixed_compensations array
    • Non-standard fixed_compensations - Owner's Draw, Minimum Wage Adjustment and Severance - will be included, even if unused or $0, when applicable
  • Removed version from top level response
  • Added fixed_compensation_types array
  • Added version to each employee_compensation

Moving forward, fixed compensation types should be retrieved from the fixed_compensation_types array returned by a request to the Prepare a payroll for update endpoint, then applied via the Update a payroll by ID endpoint by passing the name retrieved from the aforementioned array, a non-$0 amount, and the employee compensation version returned by the prepare request.

Note: Allversions must be valid for a request to be accepted. Requests with one ore more invalid versions will be rejected with 422 Unproccessable Entity error.