API Reference Enhancements

• A new API endpoint Get New Payroll Batch Status has been added. This endpoint allows API users to retrieve details for a submitted payroll batch, including its current status, creation time, and the unique tracking ID associated with the batch. The updated documentation includes request/response examples, field descriptions, and usage guidance.
• Weblink API resources have updated the taxForm field returned field definitions to include all current, non-custom, values; W2, 1099M, 1099R, 1099NEC, Non-US. Affected APIs include Get employee, Add new employee, Update employee, and Staging - Add new employee
  It is still strongly recommended that all integrations implement a full range of handling test case scenarios prior to launching the integration to Production.
• Updated Partner Onboarding API documentation to specify the required time delay in minutes (rather than seconds) between syncing client information after the 'Approved' status.
• Updated Assessments API order callback example response to display the correct JSON response format.

Guide Content Enhancements

• A new guide has been released offering high-level steps for using Paylocity's Developer Portal experience to manage integrations. Note: The Developer Portal is not yet available for all integration use cases, existing integrations will be notified by Paylocity when their use case is supported and may be migrated to use Developer Portal.

API Reference Enhancements

• Webhooks Overview now includes information on how undelivered webhook notifications are handled
• Minor revisions have been made to LMS API Overview to provide clear instructions on implementation
• All Scheduling API endpoints have exited their beta phase and are now generally available for use

👍

Learning Management API Released

We are excited to announce the release of our new Learning Management API, enabling technology partners to create integrations with Paylocity’s Learning Management System. Partners can now add or update training content, and retrieve employee training assignments and completion status.

For more information check out our LMS API Overview

API Reference Enhancements

• A new API for integrating with Paylocity Learning Management Systems has been released
• Background Check and Assessments client onboarding documentation was updated to include information about company set company IDs in the redirect URL.
• Background Check and Assessments Overview documentation was updated to state that partners need to respond to requests within 5 seconds.
• Background Check PATCH Update Screening Order endpoint was updated to allow for Dynamic Services updates. More information can be found on that endpoint's overview page.
• Updated Postman workspace for integration-building...
  • ...to include newly released APIs
  • Company Level Information and Employee Demographic resources no longer have optional parameter fields enabled by default.
  • environment names updated from "Sandbox" and "Production" to "Paylocity Sandbox" and "Paylocity Production" respectively.

Guide Content Enhancements

• A new guide has been released offering insight into implementing methods to maintain synchronization of records across systems

API Reference Enhancements

• Assessments - Max length for descriptor fields have been increased from 36 to 150 characters
• Background Check - Max length for descriptor fields have been increased from 50 to 150 characters

Guide Content Enhancements

• A new key concepts guide for List & Lookup Values has been added
• A new guide for Using Postman to walk readers through how to fork and configure their Postman Workspace to make API calls. In conjunction with the release this guide, we have updated our Postman Workspace configuration to enable users to leverage the postman vault functionality to securely store their API credentials.

API Reference Enhancements

• Try It button functionality in all specifications has been disabled and instead all testing of APIs should be done via our Postman Workspace
• Punch Detail API Updates
  • A new Punch Details Overview page has been released to guide devs through using our Punch Detail API
  • A new resource has been released to access comprehensive punch data at the company level
  • A new version of Employee Punch Details has been released
    • Note that the v1 Employee punch details resource is now deprecated and partners/clients using that resource should move to the new version
• Partner Onboarding API Updates
  • Updated the available statuses for partners to use: In Progress, Approved, Rejected, Suspended
  • Added an Overview page to explain when those statuses should be used

A correction has been made to the Upsert Onboarding Status onboardingStatus body parameters to show the correct valid options.

We have also added Client Onboarding Overview to provide details regarding the onboardingStatus option definitions

Guide Content Enhancements

• Integration Platforms has added a new partner, Payroll Integrations, to the list.
• A early access version Postman Collection has been added to our Postman Workspace. This new version leverages Postman Vault functionality to secure API credentials. Partners and clients should continue to use the (Latest Version) collection to build and test integrations.

API Reference Enhancements

• Employee Change Webhooks list of triggering fields has been updated to include employee work location fields.
• Assessments specifications have been updated to show the correct max field length for job title in responses.
• Punch Import Overview has been updated to reflect the maximum payload size for the Punch Import API, which has been increased to 9,000 records.
• Background Check Client Onboarding page has been updated to include the definition for the 'Suspended' status.

Guide Content Enhancements

• A new guide explaining Employee Status has been added
• Company & Company Sets guide has been updated with common use cases and test scenarios

API Reference Enhancements

• Added a new section in the assessments overview to explain retry logic for the Assessments API

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.