Jump to Content
Guides
Recipes
API Reference
Changelog
v2024-06-24
v2024-07-09
v2024-08-13
v2024-09-10
v2024-10-15
v2024-11-12
v2024-12-10
v2025-01-21
v2025-02-11
v2025-02-20
v2025-03-11
v2025-05-13
v2025-06-10
API Reference
v2024-07-09
Guides
Recipes
API Reference
Changelog
Pay Entry Overview
Search
JUMP TO
API Basics
Authentication
Errors
Filtering
Rate Limits
Webhooks
New Hire Webhooks
Employee Change Webhooks
Termination Webhooks
Payroll Processed Webhooks
Time Off Approval Webhooks
Future Dated Changes
Assessments API
Assessments Overview
Callback
Get callback
get
Add or update callback
put
Delete callback
delete
Order
Update Assessment order
patch
Package
Insert or update Assessment package
put
Delete Assessment package
delete
Insert or update Assessment packages
put
Get Assessment packages
get
Subscription
Update or create a subscription
put
Background Check API
Background Check Overview
Client Onboarding
Upsert onboarding status
post
Add billing codes
post
Delete billing code
delete
Updates billing code status
patch
Subscription
Returns the webhook for the subscription of a new candidate screening order
get
Register the webhook URL for the subscription of new CandidateScreeningOrder
post
Deletes the webhook
delete
Screening Package
Returns screening packages
get
Bulk Upsert
post
Upserts screening package
post
Deletes screening package
delete
Candidate Screening Order
Updates the Screening Order status
patch
Company Level Information API
Company Information
GET a single Company Information
get
Payroll/HR
GET a list of Work Locations by Company ID
get
GET a list of Rate Codes by Company ID
get
GET a list of Cost Centers by Company ID
get
GET a List of Earning Codes by Company ID
get
GET a list of Deduction Codes by Company ID
get
GET Pay Frequency Code by list by Company ID
get
GET a list of Tax Codes by Company ID
get
GET a List of Workers Compensation Codes by Company ID
get
GET a List of Position Codes by Company ID
get
GET a List of Pay Grades by Company ID
get
Job Codes
GET a list of Job Codes by Company ID
get
Create a single Job Code
post
GET a single Job Code
get
Update a single Job Code
put
Delete a single Job Code
delete
Filtering Job Codes
Document Management API
Documents Overview
Documents
Get a list of documents for a company
get
Get a list of documents filtered by employee for a company
get
Retrieve a document download URL
post
Employee Demographic API
Employees
Gets a list of employees by company ID
get
Gets a single employee by company and employee IDs
get
Partner Onboarding API
Client Onboarding
Upsert onboarding status
put
Pay Entry API
Pay Entry
Create New Payroll Batch
post
Pay Setup API
Pay Setup Overview
Deductions
GET Employee Deduction List
get
Create new Recurring Employee Deduction
post
GET Recurring Deduction Detail
get
GET Recurring Deduction Details for a specific past/present/future deduction
get
Update Recurring Deduction Details for a specific past/present/future deduction
put
DELETE Recurring Deduction Code on the Employee Record
delete
Filtering Deductions
Earnings
GET Employee Earnings List
get
Create new Recurring Employee Earning
post
GET Recurring Earning Detail
get
GET Recurring Earning Details for a specific past/present/future earning
get
Update Recurring Earning Details for a specific past/present/future earning
put
DELETE Recurring Earning Code on the Employee Record
delete
Filtering Earnings
Punch detail Api
Punch details
Gets Employee punch details
get
Punch Import API
Punch Import Overview
Punch Import Field Mapping
Punch Import
Post Employee punch data
post
Retirement contributions Api
Retirement contributions
Gets Retirement Contributions
get
WebLink API
Authentication
Rate Limits
Deduction
Add / Update Deduction
post
Delete deduction for deduction code / start date
delete
Get All Deductions
get
Get Deduction for Deduction Code
get
Onboarding
Add Employee to Onboarding
post
Local Tax
Get Local Tax for Tax Code
get
Update Local Tax
put
Delete Local Tax for Tax Code
delete
Get All Local Taxes
get
Add Local Tax
post
Additional Rates
Add/update additional rates
put
Client Credentials
Obtain new client secret.
post
Company Codes
Get All Company Codes
get
Company-Specific Schema
Get Company-Specific Open API Documentation
get
Custom Fields
Get All Custom Fields
get
Direct Deposit
Get All Direct Deposit
get
Earnings
Get All Earnings
get
Add/Update Earning
put
Get Earning by Earning Code and Start Date
get
Delete Earning by Earning Code and Start Date
delete
Get Earnings by Earning Code
get
Emergency Contacts
Add/update emergency contacts
put
Employee Benefit Setup
Add/update employee's benefit setup
put
Employee Staging
Add new employee to Web Link
post
Employee
Get all employees
get
Add new employee
post
Get employee
get
Update employee
patch
Local Taxes
Get all local taxes
get
Add new local tax
post
Get local taxes by tax code
get
Delete local tax by tax code
delete
Non-Primary State Tax
Add/update non-primary state tax
put
Pay Rate Searches
Create an employee pay rates search
post
PayStatements
Get employee pay statement details data for the specified year and check date.
get
Get employee pay statement details data for the specified year.
get
Get employee pay statement summary data for the specified year and check date.
get
Get employee pay statement summary data for the specified year.
get
Primary State Tax
Add/update primary state tax
put
Sensitive Data
Get sensitive data
get
Add/update sensitive data
put
Status Searches
Create an employee statuses search
post
Pay Entry Overview
Copyright © 2025 Paylocity. All Rights Reserved.
Privacy Center
|
Terms and Conditions
|
Accessibility
