Changelog

• Minor updates to spelling and code syntax for multiple steps across all recipes.
• A new guide is available related to Employee Transfers.

• Added guidance to the background check business unit documentation on linking newly created business units to pre-existing screening packages and billing codes.
• A new API for viewing Payroll Statements 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.

• StackOne has been added to the list of 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 has been added to the list of Paylocity Key Concepts. The page explains the concept of employee transfers in Payroll & HR, and how to properly handle them in your integration.

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].

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.

• Common Integration Use Cases updated to reference Using Developer Portal documentation for renewing API credentials.

• Added support for optional business units, a new top-level hierarchy for Background Check 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 documentation. The text is now more concise and clarifies that a maximum payload size of 500 objects is now enforced.

• A breaking change was introduced to the Partner Onboarding API error response to meet API standards.

Clarification added to Punch Details 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.

• A Login button to the developer portal experience for authorized partners and clients can now be found in the upper right page header of this site.

• New filtering options have been enabled for the Get partner assessment orders filters parameter.
• New request and response examples have been added to resources for the Learning Management API and added clarity to some field descriptors based on user feedback.

• Added a key concepts guide on 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. 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 guide and reordered all definitions alphabetically to make them easier to browse.

• Assessments API has a new endpoint 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, allowing Background Check partners to pull multiple orders filtered on a variety of parameters.

Pay Entry API

• Create New Payroll Batch 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.

• Integration Platforms has been updated to reflect the merger between platforms Joynd and The Cloud Connectors to become Tavio.

• Company Level Information has a new endpoint to GET Cost Centers/Labor Levels 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, Add new employee, and Update employee endpoints to include instructions for clients using the Unlimited Custom Fields platform.

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).

• 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.
• 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.

• Background Check overview page has been added to help explain the order process for background check partners.

Updated Postman workspace 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.

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

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