With this release, we have added documentation on using Webhooks and placed callouts in APIs such as Background Check that has restrictions on their use.

API Reference Enhancements

• Webhooks documentation has been added to better guide our partners and clients on when/why to use webhooks and the steps to getting them configured for an integration
• We've added a new section regarding recommended TLS versions supported in our Authentication documentation
• Clarification has been added regarding our background check APIs access is restricted to Paylocity Technology Partners (requires a technology partnership agreement to use)

With this release, we have updated our Authentication documentation, enhanced our Background Check API , and added new object entities to results returned from the Employee Demographic API endpoints

Guide Content Enhancements

• Added callouts to our documentation on Authentication to direct Weblink API consumers to the correct information.

API Reference Enhancements

• Background Check API has added the ability for partners to send customer billing codes on the company ID level and on the package level to ensure a better invoicing experience for mutual clients. Partners can explore these exciting changes in the Client Onboarding and Screening Package endpoints!
• Employee Demographic API resources now return information about employee future pay rates and career level

With this release, we are excited to announce the launch of the Partner Onboarding API, a significant step in streamlining Paylocity's integration capabilities. This new API empowers our approved partners, facilitating seamless mutual integrations with Paylocity for our valued clients.

Guide Content Enhancements

• We have made edits to the Punch Import API Overview to provide more clarity on the API and when it should be used

API Reference Enhancements

• We have corrected the sandbox URL path for our Weblink API resources

New Partner Onboarding API released

• The new Partner Onboarding API is designed to enable our partners to onboard customers through our Paylocity Marketplace-initiated workflow. Approved partners will utilize the API to toggle when an integration can begin calling client data after the client admin has authorized access via the Paylocity Marketplace workflow. The first endpoint of this API provides allows partners to upsert the integration status. Contact the marketplace team to explore early adopter opportunities at [email protected]

We are excited to announce the release of our Pay Setup API, designed to facilitate managing customer's recurring deduction and earning codes on the employee level. Users can obtain detailed information about deductions and earnings on an employee's record through various endpoints. The API further empowers users to insert and update recurring deductions and earnings directly on an employee's record.

Guide Content Enhancements

• A quick-reference guide on what APIs to use for common integration use cases has been released
• A guide on best practices for implementing specific types of integrations has been released
• We've moved informational documentation about authentication, errors, and rate limits into an API Basics group in the API Reference section for developer use as an instructional reference when exploring our APIs

API Reference Enhancements

• An API Basics group containing instructional references about authentication, errors, filtering, and rate limits has been added.
• The "Company Codes API" has been renamed to "Company Level Information API." This section's APIs interact with company-level data like employer information and field lists within the Payroll/HR module.
• New resources have been added to the Company Level Information section for obtaining details about Position Codes, Compensation Codes, Pay grades, Earning Codes, Deduction codes, Pay Frequency, Tax Codes, and Work Locations APIs.
• Document Management API information has been migrated to our new documentation platform.
• Weblink API information has been migrated to our new documentation platform
  New APIs.

Lastly,

🎉Happy New Year!🎉

Descriptions for Background Check and Job Codes APIs have been updated for improved clarity. Click the release date link to see full details.

API Enhancements

• Background Check API - descriptions have been updated for the request/response properties for additional clarity and new section with content called 'Callback' has been added in the 'Register the webhook URL...' endpoint to provide callback details for screening orders.

Documentation Corrections

• Corrected a description mix-up in the GET and POST resources of Job Codes in the Company Codes API

We are excited to announce the release of our Company Codes API, which enables partners and clients to integrate their external Enterprise Resource Planning (ERP) / Accounting Software with Paylocity's Time and Labor solution! Through this API, an integration will be able to add or modify Job codes in the Paylocity application suite as well as get essential data required for job details.

Documentation Enhancements

• Improved Background Check API parameter definitions, object definitions, and removed unnecessary response example formats (text/plain and text/json)
• Improved Retirement Contributions API parameter and object definitions
• Added clarifications and reduced word counts to the following guides:
  • Getting Started
  • Integration Requirements
  • Technology Partner Requirements