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.

API Reference Enhancements

• Updated our list of Errors to correctly denote that hitting a rate limit ceiling will result the error 429 - Too Many Requests

API Basics | Webhooks documentation

• Updated Payroll Processed Webhooks content to properly reflect that processid and runid are int and not string data types
• Updated Time Off Approval Webhooks content to properly reflect that isAllDayEvent is a boolean value and that hoursPerDay is a decimal and updated use case and overview sections to enhance clarity for using the webhook
• Minor format and sample value enhancements to all webhook code examples to provide a more realistic sample of the data partners and clients would encounter

Assessments API

• updated multiple response fields to correctly indicate if they are nullable or not

Punch Import Overview | Punch Import API Documentation

• Updated Punch Import Overview and clarified actions that are not supported

Weblink API

• Updated default server URL in each specification to point to sandbox environment instead of production

We are excited to announce the release of Recipes to our documentation platform. Recipes are a step-by-step code implementation examples of an integration use case. The first recipe released is for leveraging our assessments API for building an integration.

Guide Content Enhancements

• A Paylocity key concepts guide and data model overview for company / company sets has been released

API Reference Enhancements

• A Pay Entry Overview page has been added for greater understanding of how to implement the API

Background Check API

• Background Check endpoints added a v2 for PATCH and DELETE Billing codes as well as a GET endpoint for billing codes. The PATCH and DELETE endpoints will be able to handle updates to billing codes that have special characters.
• Background check screening order resources now supports dynamic services! This means that services can be added to orders after they were placed, which will allow statuses to update while adding in any new services to the order and applying the correlated status.
• New background check statuses are available. This will allow users to more easily see the result of the background check without needing to open the report. The UI for this functionality will be released by 9/13/2024.

Assessment API

• Overview sections for the API and each endpoint have been edited to ensure all information is up to date.

We are excited to announce the beta release of our Scheduling API!
With this API you can:

• get detailed shift information to an individual employee
• get a list of employee shift data for a specific company
• get a list of open (unassigned) shifts for a company

Guide Content Enhancements

• We have updated the non-weblink URLs for partners and clients to Authenticate. The old version of the URLs will continue to work, but it is encouraged for integration owners to update their auth methods to these new addresses when possible.

API Reference Enhancements

• The Assessments API specification has been updated to denote when a query parameter is required
• The Employee Demographic specification has been updated to denote when a query parameter is required
• Updated Punch Import Overview and Pay Setup Overview terminology of credentials for better clarity to the reader.

Guide Content Enhancements

• We have updated our requirements for becoming a Technology Partner

API Reference Enhancements

• Removed maintenance mode warnings from three weblink endpoints to reduce user confusion, as those resources are not in maintenance mode.
• Added a Partner Restriction warning to the Assessments Overview page to add clarity to that API being available only to Paylocity Technology Partners
• Updated specification descriptions in the Assessments API endpoints based on user feedback to add clarity on expected responses.

Introducing the Employee Punch Detail API

Now you can access comprehensive punch data for individual employees, streamlining your workforce management and ensuring accurate time tracking like never before.

Guide Content Enhancements

• TLS 1.0 and 1.1 are no longer supported when making API calls.
  Our Authentication and Weblink Authentication documentation has been updated to reflect this change.

API Reference Enhancements

• Error codes and rate limits per minute have been adjusted for the Weblink API rate limits and details updated for Preventing and Handling Rate Limit Threshold Errors to include additional best practices.
• Two new beta Web Link endpoints:
  • Pay Rate Searches
  • Status Searches
• Assessments API: Additional information regarding the business logic of completed statuses and attempt counts has been added in the Order Overview section.

A correction has been made to the v2024-05-14 documentation on Weblink API Authentication to show the correct URL path for the Sandbox and Production authentication servers specific to the Weblink API. We apologize for any inconvenience the incomplete URL paths may have caused.

🚀 Exciting News for Developers! 🎉
Introducing Our New Assessments API!
With this API you can soon easily embed assessments within your Paylocity Recruiting and Skills and Certifications applications! From candidate evaluations to employee assessments, our API covers it all. Get started now!

Guide Content Enhancements

• We've lowered the number of mutual customers required for Technology Partners to advertise in our Integrations Marketplace from three (3) down to one (1). Technology Partners may contact their partnership representative for more information.

API Reference Enhancements

• We are excited to announce the release of our Assessments API assessment providers may more easily build integrations into the Paylocity product suite.
• Error code examples have been adjusted for the Partner Onboarding API Upsert onboarding status endpoint
• The following announcement has been added to Weblink API rate limits:
  Starting Nov 1st 2024, the Weblink API Rate Limits will be changed from a maximum of 720 of calls per minute to a maximum of 25 calls per second. This applies ONLY to call counts made to resources that are part of the Weblink API. This change will increase the calls per minute limit to 1500 while preventing overconsumption of resources.

With this release, we have added documentation on using Webhooks and placed callouts in APIs such as Background Check that has restrictions on their use.

API Reference Enhancements

• Webhooks documentation has been added to better guide our partners and clients on when/why to use webhooks and the steps to getting them configured for an integration
• We've added a new section regarding recommended TLS versions supported in our Authentication documentation
• Clarification has been added regarding our background check APIs access is restricted to Paylocity Technology Partners (requires a technology partnership agreement to use)