> This page is for Talent.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://paylocity-develop.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://paylocity-develop.ferndocs.com/_mcp/server.

# Changelog

## March 10, 2026

> **New Recipes Released**
>
> A [new recipe for managing employee deductions](https://developer.paylocity.com/integrations/recipes) has been released to provide a step-by-step code implementation example using the [Pay Setup API](https://developer.paylocity.com/integrations/reference/pay-setup-overview).
>
> A [new recipe for viewing employee pay statements](https://developer.paylocity.com/integrations/recipes/working-with-pay-statement-endpoints) has been released to provide step-by-step code implementation examples using the [Pay Details API](https://developer.paylocity.com/integrations/reference/pay-detail-api-overview).

> **Released - Pay Details API**
>
> A new API for viewing [Payroll Statements](https://developer.paylocity.com/integrations/reference/get_apihub_payrollhistory_v1_companies_companyid_employees_employeeid_paystatements_paystatementid) has been released! This API enables downstream partner systems to fetch historical payroll information supporting use cases such as financial reporting and auditing integrations.

## Guide content enhancements

* Minor updates to spelling and code syntax for multiple steps across all recipes.
* A new guide is available related to [Employee Transfers](https://developer.paylocity.com/integrations/docs/employee-transfers).

## API reference enhancements

* Added guidance to the [background check business unit documentation](https://developer.paylocity.com/integrations/reference/business-unit) on linking newly created business units to pre-existing screening packages and billing codes.
* A new API for viewing [Payroll Statements](https://developer.paylocity.com/integrations/reference/get_apihub_payrollhistory_v1_companies_companyid_employees_employeeid_paystatements_paystatementid) has been released (see above announcement).
* The Punch Detail API has had several revisions to endpoint summary and field definitions to improve clarity for discovery and implementation phases. No impact to endpoint functionality.
* The Scheduling API has had several revisions to endpoint summary and field definitions to improve clarity for discovery and implementation phases. No impact to endpoint functionality.

## February 17, 2026

## Guide content enhancements

* [StackOne](https://www.stackone.com/demo) has been added to the list of [Integration Platforms](https://developer.paylocity.com/integrations/docs/integration-platforms). They enable you to connect with Paylocity (and hundreds of other platforms) for rich, real-time, bi-directional AI agentic integrations.
* [Employee Transfers](https://developer.paylocity.com/integrations/docs/employee-transfers) has been added to the list of [Paylocity Key Concepts](https://developer.paylocity.com/integrations/docs/paylocity-key-concepts). The page explains the concept of employee transfers in Payroll & HR, and how to properly handle them in your integration.

## API reference enhancements

LMS API has had several documentation improvements for clarity and consistency. These changes have no impact to their URI or functionality. This is strictly a documentation update.

* Renamed get endpoint to [Create Training Content \[Single\]](https://developer.paylocity.com/integrations/reference/post_apihub-learningmanagementsystem-v1-companies-companyid-content).

Punch Details API has had several documentation improvements for clarity and consistency. These changes have no impact to their URI or functionality. This is strictly a documentation update.

* [Punch Import Overview](https://developer.paylocity.com/integrations/reference/punch-import-overview) documentation has been updated for improved clarity based on user feedback.

Scheduling API has had several documentation improvements for clarity and consistency. These changes have no impact to their URI or functionality. This is strictly a documentation update.

* Endpoints have been renamed to align with the standard naming schema.
* Corrected formatting issues with body parameter definitions.

## January 13, 2026

## Guide content enhancements

* [Common Integration Use Cases](https://developer.paylocity.com/integrations/docs/common-use-cases-partners) updated to reference [Using Developer Portal](https://developer.paylocity.com/integrations/docs/using-developer-portal) documentation for renewing API credentials.

## API reference enhancements

* Added support for optional [business units](https://developer.paylocity.com/integrations/reference/business-unit), a new top-level hierarchy for [Background Check](https://developer.paylocity.com/integrations/reference/background-check-overview) configuration that can be associated with billing codes and/or packages. When associations exist, selecting a business unit filters the available billing codes and packages during ordering.
* Updated [Punch Import API](https://developer.paylocity.com/integrations/reference/punch-import-overview) documentation. The text is now more concise and clarifies that a maximum payload size of 500 objects is now enforced.

## December 16, 2025

## API reference enhancements

* A breaking change was introduced to the [Partner Onboarding API](https://developer.paylocity.com/integrations/reference/partner-onboarding) error response to meet API standards.

Clarification added to [Punch Details Overview](https://developer.paylocity.com/integrations/reference/punch-detail-overview):

* Improved instructions for paging through results.
* Added notes to clarify that no time zone information should be included in relative datetime input parameters.
* Added more details to Step 3: Generate the Company Punch Detail Data section per user feedback.
* Punch Detail endpoints have an updated field definition regarding the earnings field; representing gross estimated earnings.

Two new endpoints have been released for supporting Punch Detail operations:

* [Get Punch Detail Data](https://developer.paylocity.com/integrations/reference/get_apihub_time_v2_companies_companyid_punchdetails_resourceid)
* [Get Punch Detail Operation](https://developer.paylocity.com/integrations/reference/get_apihub_time_v2_companies_companyid_punchdetailoperations_operationid)

## December 9, 2025

## Guide content enhancements

* A Login button to the [developer portal experience](https://developer.paylocity.com/integrations/docs/using-developer-portal) for authorized partners and clients can now be found in the upper right page header of this site.

## API reference enhancements

* New filtering options have been enabled for the [Get partner assessment orders](https://developer.paylocity.com/integrations/reference/get_apihub-performancemanagement-v1-companies-b6001-partner-assessmentorders) filters parameter.
* New request and response examples have been added to resources for the [Learning Management API](https://developer.paylocity.com/integrations/reference/lms-api-overview) and added clarity to some field descriptors based on user feedback.

## November 11, 2025

> **New guides for pay setup and punch imports released**
>
> We're excited to announce the release of two new guides designed to smooth your journey to launching your Time & Labor or Payroll integrations:
>
> **[Punch Data Import Guide](https://developer.paylocity.com/integrations/docs/punch-data-imports)**
> *Learn how to import and manage punch/time clock data to support your integration workflows.*
>
> **[Pay Setup Concepts Guide](https://developer.paylocity.com/integrations/docs/pay-setup-deductions-earnings)**
> *Gain a clearer understanding of key Pay Setup concepts, including deductions and earnings, to ensure accurate and efficient payroll configurations. It also provides integrators with important test case scenarios.*

## Guide content enhancements

* Added a key concepts guide on [Pay Setup - Deductions & Earnings](https://developer.paylocity.com/integrations/docs/pay-setup-deductions-earnings). Use this guide to gain a clearer understanding of pay setup concepts and the test scenarios that need to be completed before launching your integration.
* Added a guide on [Importing punch data into Paylocity](https://developer.paylocity.com/integrations/docs/punch-data-imports). Learn how to import and support your Time and Labor integrations, including important concepts/test scenarios that should be considered before launching your integration.
* Added Check Types to the [List & Lookup Values](https://developer.paylocity.com/integrations/docs/list-lookup-values) guide and reordered all definitions alphabetically to make them easier to browse.

## API reference enhancements

* Assessments API has [a new endpoint](https://developer.paylocity.com/integrations/reference/get_apihub-performancemanagement-v1-companies-b6001-partner-assessmentorders) to retrieve all assessment orders for companies actively onboarded to their integration. Results can be filtered by company ID, order ID, candidate ID, or creation date.
* Background Check API has a new endpoint to [Get Screening Orders for Partner](https://developer.paylocity.com/integrations/reference/get_compliance-v1-companies-b6001-partner-backgroundcheckorders), allowing Background Check partners to pull multiple orders filtered on a variety of parameters.

## October 14, 2025

## Hotfix - API reference

**Pay Entry API**

* [Create New Payroll Batch](https://developer.paylocity.com/integrations/reference/payentryv2_postpayentryimport) now correctly shows the body parameter `checkType`. *Check Type is a grouping of pre-defined behaviors for payroll processing including overrides for Tax Frequency, State Income Tax Withholding (SITW), Federal Income Tax Withholding (FITW), blocking direct deposits, deduction multipliers, and include/exclude system blocks for accruals occurring from time off policies.*

**Background Check API**

* Specification was updated to show only currently generally available resources for partners. The previous changelog announcement for v2025-10-14 has been updated to remove resources that are still only in early access.

## October 7, 2025

## Guide content enhancements

* [Integration Platforms](https://developer.paylocity.com/integrations/docs/integration-platforms) has been updated to reflect [the merger between platforms Joynd and The Cloud Connectors](https://www.tavio.io/joynd-and-the-cloud-connectors-announce-merger-combining-two-hr-tech-industry-leaders-into-integration-powerhouse) to become [Tavio](https://www.tavio.io/).

## API reference enhancements

* Company Level Information has a new endpoint to [GET Cost Centers/Labor Levels](https://developer.paylocity.com/integrations/reference/get_apihub_time_v1_companies_companyid_costcenters) which will retrieve a list of cost centers from the Paylocity Time and Labor system. This data is critical for budget tracking, expense allocation, and operational efficiency integrations.
* Updated required fields to show as required for Punch Detail API endpoints.
* Updated response documentation on **Weblink API** [Get All Custom Fields](https://developer.paylocity.com/integrations/reference/get-all-custom-fields-by-category), [Add new employee](https://developer.paylocity.com/integrations/reference/add-employee), and [Update employee](https://developer.paylocity.com/integrations/reference/update-employee) endpoints to include instructions for clients using the Unlimited Custom Fields platform.

## September 9, 2025

## API reference enhancements

**Background Checks API**

* Recruiter email now only includes work email; returns *null* if none exists.
* Partner error messages now display in the client UI for easier troubleshooting.
* Order payload expanded to include cost centers, job title and/or position info.
* Deprecated v1 endpoints (Delete & Patch) for Background Check client onboarding have been retired (removed).

**Assessments API**

* Recruiter email now only includes work email; returns *null* if none exists.
* Job status updates now sent to createJob callback URL if registered.
* Test score field is now optional.

## August 12, 2025

## API reference enhancements

* A new API endpoint [Get New Payroll Batch Status](https://developer.paylocity.com/integrations/reference/payentryv2_getpayentryimport) 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](https://developer.paylocity.com/integrations/reference/get-employee), [Add new employee](https://developer.paylocity.com/integrations/reference/addemployee), [Update employee](https://developer.paylocity.com/integrations/reference/updateemployee), and [Staging - Add new employee](https://developer.paylocity.com/integrations/reference/add-new-employee-to-web-link).
* 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.

## July 15, 2025

## Learning Management API released

> **Learning Management API Released**
>
> The new [Learning Management API](https://developer.paylocity.com/integrations/reference/lms-api-overview) enables 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 the [LMS API Overview](https://developer.paylocity.com/integrations/reference/lms-api-overview).

## API reference enhancements

* Background Check [overview](https://developer.paylocity.com/integrations/reference/candidate-screening-order) page has been added to help explain the order process for background check partners.

Updated [Postman workspace for integration-building](https://www.postman.com/paylocity/paylocity-apis-for-integration-building):

* Environment names updated from "Sandbox" and "Production" to "Paylocity Sandbox" and "Paylocity Production" respectively.
* Company Level Information and Employee Demographic resources no longer have optional parameter fields enabled by default.
* Updated to include newly released APIs.

## June 10, 2025

## Guide content enhancements

* A new guide has been released offering insight into implementing methods to maintain [synchronization of records across systems](https://developer.paylocity.com/integrations/docs/synchronization-webhooks).

## API reference enhancements

* [Background Check](https://developer.paylocity.com/integrations/reference/background-check-overview) - Max length for descriptor fields have been increased from 50 to 150 characters.
* [Assessments](https://developer.paylocity.com/integrations/reference/assessments-overview) - Max length for descriptor fields have been increased from 36 to 150 characters.

## March 11, 2025

## Guide content enhancements

* A new guide for [Using Postman](https://developer.paylocity.com/integrations/docs/postman) to walk readers through how to fork and configure their [Postman Workspace](https://www.postman.com/paylocity/paylocity-apis-for-integration-building/overview) to make API calls. In conjunction with this guide, the [Postman Workspace](https://www.postman.com/paylocity/paylocity-apis-for-integration-building/overview) configuration has been updated to enable users to leverage the Postman Vault functionality to securely store their API credentials.
* A new key concepts guide for [List & Lookup Values](https://developer.paylocity.com/integrations/docs/list-lookup-values) has been added.

## API reference enhancements

**Punch Detail API Updates**

A new version of [Employee Punch Details](https://developer.paylocity.com/integrations/reference/employee-punch-details) has been released, providing [comprehensive punch data at the company level](https://developer.paylocity.com/integrations/reference/post_apihub_time_v2_companies_companyid_punchdetails). See the [Punch Details Overview](https://developer.paylocity.com/integrations/reference/punch-detail-overview) for more information.

* Note that the [v1 Employee punch details](https://developer.paylocity.com/integrations/reference/get_apihub_time_v1_companies_companyid_employees_employeeid_punchdetails) resource is now [deprecated](https://developer.paylocity.com/integrations/reference/versioning) and partners/clients using that resource should move to the new version.

**Partner Onboarding API Updates**

* Added an [Overview page](https://developer.paylocity.com/integrations/reference/partner-onboarding) to explain when those statuses should be used.
* Updated the available statuses for partners to use: In Progress, Approved, Rejected, Suspended.

## February 11, 2025

## Bug fix

A correction has been made to the [Upsert Onboarding Status](https://developer.paylocity.com/integrations/reference/put_apihub-security-v1-companies-b6001-companyonboardingstatuses) `onboardingStatus` body parameters to show the correct valid options.

[Client Onboarding Overview](https://developer.paylocity.com/integrations/reference/partner-onboarding) has also been added to provide details regarding the `onboardingStatus` option definitions.

## January 21, 2025

## Guide content enhancements

* [Integration Platforms](https://developer.paylocity.com/integrations/docs/integration-platforms) has added a new partner, [Payroll Integrations](https://www.payrollintegrations.com/), to the list.
* An early access version Postman Collection has been added to the [Postman Workspace](https://www.postman.com/paylocity/paylocity-apis-for-integration-building). 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.

## December 10, 2024

## API reference enhancements

* [Employee Change Webhooks](https://developer.paylocity.com/integrations/reference/employee-change-webhooks) list of triggering fields has been updated to include employee work location fields.
* [Assessments specifications](https://developer.paylocity.com/integrations/reference/assessments-overview) have been updated to show the correct max field length for job title in responses.
* [Punch Import Overview](https://developer.paylocity.com/integrations/reference/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](https://developer.paylocity.com/integrations/reference/client-onboarding) page has been updated to include the definition for the "Suspended" status.

## November 12, 2024

## Guide content enhancements

* A new guide explaining [Employee Status](https://developer.paylocity.com/integrations/docs/employee-status) has been added.
* [Company & Company Sets](https://developer.paylocity.com/integrations/docs/company-and-company-sets) guide has been updated with common use cases and test scenarios.

## API reference enhancements

* Added a new section in the [assessments overview](https://developer.paylocity.com/integrations/reference/assessments-overview) to explain retry logic for the Assessments API.

## October 15, 2024

## API versioning documentation released

Documentation covering [API Versioning](https://developer.paylocity.com/integrations/reference/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](https://www.postman.com/paylocity/paylocity-apis-for-integration-building/collection/nnum8gd/paylocity-apis-latest-version) for the majority of APIs.

## Guide content enhancements

* [Technology Partner Requirements](https://developer.paylocity.com/integrations/docs/partnership-requirements) has been updated to provide more clarity regarding phase 1 expectations.
* An [Integration Platforms](https://developer.paylocity.com/integrations/docs/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](https://www.postman.com/paylocity/paylocity-apis-for-integration-building/collection/nnum8gd/paylocity-apis-latest-version) 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](https://developer.paylocity.com/integrations/reference/errors) has been updated to include 409 and 301 error codes that may occur when deprecated APIs are retired.
* [API Versioning](https://developer.paylocity.com/integrations/reference/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](https://developer.paylocity.com/integrations/reference/payentryv2_getpayentryimport-1) endpoint and the [old version has been set to a deprecated status](https://developer.paylocity.com/integrations/reference/payentryv2_getpayentryimport).
* 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](https://developer.paylocity.com/integrations/reference/rate-limits-weblink) 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.

## September 10, 2024

## API reference enhancements

* Updated list of [Errors](https://developer.paylocity.com/integrations/reference/errors) to correctly denote that hitting a rate limit ceiling will result in the error 429 - Too Many Requests.

### Webhooks documentation

* Updated [Payroll Processed Webhooks](https://developer.paylocity.com/integrations/reference/payroll-processed-webhooks) content to properly reflect that `processid` and `runid` are int and not string data types.
* Updated [Time Off Approval Webhooks](https://developer.paylocity.com/integrations/reference/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.
* Updated [Punch Import Overview](https://developer.paylocity.com/integrations/reference/punch-import-overview) with minor formatting and sample value enhancements.

## August 13, 2024

## Recipes released

Recipes are now available on the documentation platform. Recipes are step-by-step code implementation examples of an integration use case. The [first recipe released](https://developer.paylocity.com/integrations/recipes) is for leveraging the Assessments API for building an integration.

## Guide content enhancements

* A [Paylocity key concepts](https://developer.paylocity.com/integrations/docs/paylocity-data-model) guide and [data model overview](https://developer.paylocity.com/integrations/docs/company-and-company-sets) for company/company sets has been released.

## API reference enhancements

* A [Pay Entry Overview](https://developer.paylocity.com/integrations/reference/pay-entry-overview) page has been added for greater understanding of how to implement the API.

**Background Check API**

* New background check statuses are available. This allows users to more easily see the result of the background check without needing to open the report.
* [Background check screening order resources](https://developer.paylocity.com/integrations/reference/patch_compliance-v1-companies-companyid-backgroundcheck-candidatescreeningorders-status) now support dynamic services. Services can be added to orders after they were placed, which allows statuses to update while adding in any new services to the order and applying the correlated status.
* Background Check endpoints added a v2 for PATCH and DELETE Billing codes as well as a GET endpoint for billing codes.

**Assessment API**

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

_Showing the 20 most recent of 29 entries. Append `/llms.txt` to the changelog URL for the complete index._