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

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.