API versioning documentation released
Documentation covering API Versioning has been released. This guide provides important context regarding how Paylocity versions APIs, the lifecycle of APIs, and what to expect when an API is deprecated.
This content release has also seen the launch of the Postman workspace/collection for the majority of APIs.
Guide content enhancements
- Technology Partner Requirements has been updated to provide more clarity regarding phase 1 expectations.
- An Integration Platforms guide has been added to offer recommendations to partners and clients regarding 3rd-party integration orchestration tools that have passed a Paylocity partner certification assessment.
API reference enhancements
- API resource names in this documentation site have been updated to be more succinct for ease of navigation. No URLs or scopes have been changed.
- A Postman workspace/collection has been launched for all partner and client APIs, with the exception of the Weblink API (to be included in a future update).
- Error Code Documentation has been updated to include 409 and 301 error codes that may occur when deprecated APIs are retired.
- API Versioning has been added to provide details on the versioning strategy used by Paylocity and the deprecation process.
- The Pay Entry API has released a new version of the Create New Payroll Batch endpoint and the old version has been set to a deprecated status.
- Retirement Contributions API has been removed after the EA phase has ended.
- Local Taxes (v1) documentation has been retired to prevent confusion with the newer (v2) endpoints.
- Weblink Rate Limit changes have been implemented. The new rate limit of 25 calls per second is now in effect, increasing the available calls per minute limit to 1,500.