API Reference Enhancements

• 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.
• Two new endpoints have been released for supporting Punch Detail operations
  • Get Punch Detail Data
  • Get Punch Detail Operation

Guide Content Enhancements

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

API Reference Enhancements

• 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 we have added clarity to some field descriptors based on user feedback.

📘

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
Learn how to import and manage punch/time clock data to support your integration workflows.

Pay Setup Concepts Guide
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. 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.

API Reference Enhancements

• Assessments API has a new endpoint to retrieve assessment all 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

Hotfix - API Reference

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.

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.

Guide Content Enhancements

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

API Reference Enhancements

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

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.

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