v2023-04-01

This is the changelog for v2023-04-01, which contains breaking changes.

To learn more about versions in our API, read the Versioning guide.

Improvements to our existing payroll API endpoints.

These changes focus on removing unexpected mutations on the payroll record from existing GET endpoints and improving reliability and performance.

Removed employee_compensations and version from Get all payrolls for a company endpoint.
Introduced a new endpoint used to 'prepare' a payroll for updates and subsequent processing. This endpoint will add/remove eligible employees from the payroll employee_compensations and provide a payroll version for making updates to the payroll record.
Removed eligible_employees from the get pay periods endpoint. The eligible employees for a payroll are determined by the employee_compensations returned from the payrolls prepare endpoint. The end date cannot be more than 3 months in the future.
For the get payrolls endpoint, totals are no longer included by default. For multiple attributes comma separate the values, i.e. ?include=totals,payroll_status_meta. Start and end date range cannot be more than a year. The end date cannot be more than 3 months in the future.
For the get payrolls endpoint, unprocessed payrolls are no longer included by default. To get unprocessed payrolls, include unprocessed in your processing_statuses query parameter.
Changed type of payroll_deadline field from Date to Timestamp to give a more accurate time to run payroll by to pay employees on time. payroll_deadline now returns the original payroll deadline when the payroll is late. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.

Deprecations

Deprecated the Update a payroll [by date]endpoint as a result of launching the Prepare a payroll for update and Update a payroll by ID endpoints.

Miscellaneous changes

Capitalized all off-cycle payroll reasons