We are excited to announce the release of documentation covering API Versioning. This highly requested guide will provide important context regarding how Paylocity versions our APIs, the lifecycle of our APIs, and what to expect when an API is deprecated.

This content release has also seen the launch of the much anticipated postman workspace/collection for the majority of our APIs.

Guide Content Enhancements

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.
Technology Partner Requirements has been updated to provide more clarity regarding phase 1 expectations.

API Reference Enhancements

API resources rename (summary)

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.

API Basics

API Versioning has been added to provide details on the versioning strategy used by Paylocity and our deprecation process.
Error Code Documentation has been updated to include 409 and 301 error codes that may occur when deprecated APIs are retired.
A Postman workspace/collection has been launched for all our partner and client APIs, with the exception of the weblink API (to be included in a future update). From this space you may fork the workspace to your own private postman workspace or alternatively export the collection for import into your local postman app/other collection reader that supports the exported JSON format.

Pay Entry API

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

Retirement Contributions API has been removed after the EA phase has ended.

Weblink API

Weblink Rate Limit changes announced on May 14th, 2024 have been implemented as of November 4th, 2024. The new rate limit of 25 calls per second is now in effect, increasing the available calls per minute limit to 1,500.
Local Taxes (v1) documentation has been retired to prevent confusion with the newer (v2) endpoints that should be used for any new implementation. The v1 documentation may still be accessed in earlier content versions and will continue to be available upon request to those partners and clients that still need it.