When you configure an export, import, or other type of flow step using the prebuilt Paylocity connector, you can select any of the API operations listed below, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Paylocity API documentation. You can also create a composite endpoint for this application in HTTP mode.
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
Additional rates |
Add/update additional rates |
X |
|
|
Assessments API: Callback |
Upsert callback |
X |
|
|
Get callback |
X |
||
|
Delete callback |
X |
||
|
Assessments API: Order |
Update assessment order |
X |
|
|
Get partner assessment orders |
X |
||
|
Assessments API: Package |
Get assessment packages |
X |
|
|
Upsert assessment package |
X |
||
|
Upsert assessment packages (batch) |
X |
||
|
Delete assessment package |
X |
||
|
Assessments API: Subscription |
Upsert subscription |
X |
|
|
Background check API: Business unit |
Add business units |
X |
|
|
Get company business units |
X |
||
|
Get business unit |
X |
||
|
Update business unit |
X |
||
|
Delete business unit |
X |
||
|
Background check API: Candidate screening order |
Update screening order status |
X |
|
|
Get screening orders for partner |
X |
||
|
Background check API: Client onboarding |
Add billing codes |
X |
|
|
Upsert onboarding status |
X |
||
|
Get company billing codes |
X |
||
|
Get client onboardings |
X |
||
|
Update billing code status |
X |
||
|
Delete billing code |
X |
||
|
Background check API: Screening package |
Upsert screening package |
X |
|
|
Upsert screening packages (batch) |
X |
||
|
Get screening packages |
X |
||
|
Delete screening package |
X |
||
|
Background check API: Subscription |
Create webhook for candidate screening order |
X |
|
|
Get webhook for candidate screening order |
X |
||
|
Delete webhook for candidate screening order |
X |
||
|
Company codes |
Get all company codes |
X |
|
|
Company-level information: Company information |
Get company information |
X |
|
|
Company-level information: Cost center |
Get cost center codes |
X |
|
|
Upsert cost center code |
X |
||
|
Company-level information: Job codes |
Create job code |
X |
|
|
Get job code (single) |
X |
||
|
Get job codes (batch) |
X |
||
|
Update job code |
X |
||
|
Delete job code |
X |
||
|
Company-level information: Payroll HR |
Get deduction codes |
X |
|
|
Get earning codes |
X |
||
|
Get pay frequency codes |
X |
||
|
Get pay grades |
X |
||
|
Get position codes |
X |
||
|
Get rate codes |
X |
||
|
Get tax codes |
X |
||
|
Get work locations |
X |
||
|
Get workers compensation codes |
X |
||
|
Company-level information: Time and labour |
Get cost centers/labor levels |
X |
|
|
Company-specific schema |
Get company-specific open API documentation |
X |
|
|
Custom fields |
Get all custom fields |
X |
|
|
Deduction |
Add or update deduction |
X |
|
|
Delete deduction by code and start date |
X |
||
|
Get all deductions |
X |
||
|
Get deduction by code |
X |
||
|
Direct deposit |
Get all direct deposit |
X |
|
|
Document management API: Documents |
Get company documents |
X |
|
|
Get employee documents |
X |
||
|
Create document download URL |
X |
||
|
Earnings |
Get all earnings |
X |
|
|
Get earning by earning code and start date |
X |
||
|
Get earnings by earning code |
X |
||
|
Add/update earnings |
X |
||
|
Delete earning by earning code and start date |
X |
||
|
Emergency contacts |
Add or update emergency contacts |
X |
|
|
Employee |
Get all employees |
X |
|
|
Get employee |
X |
||
|
Add new employee |
X |
||
|
Update employee |
X |
||
|
Employee benefit setup |
Add or update employees benefit setup |
X |
|
|
Employee demographic API: Employees |
Get employees (batch) |
X |
|
|
Get employee (single) |
X |
||
|
Employee staging |
Add new employee to web link |
X |
|
|
Learning management API: Training content |
Create training content |
X |
|
|
Get training content (single) |
X |
||
|
Get training content (batch) |
X |
||
|
Local taxes |
Get all local taxes |
X |
|
|
Update local tax |
X |
||
|
Add new local tax |
X |
||
|
Get local taxes by tax code |
X |
||
|
Delete local tax by tax code |
X |
||
|
Non-primary state tax |
Add/update non-primary state tax |
X |
|
|
Onboarding |
Add employee to onboarding |
X |
|
|
Partner onboarding API: Client onboarding |
Get onboarding status |
X |
|
|
Partner onboarding API: Client onboarding |
Upsert onboarding status |
X |
|
|
Pay entry: Pay entry |
Get payroll batch status |
X |
|
|
Create new payroll batch |
X |
||
|
Pay setup API: Recurring deductions |
Create employee deduction |
X |
|
|
Get employee deductions (batch) |
X |
||
|
Get employee deduction (single) |
X |
||
|
Get employee deduction by resource ID |
X |
||
|
Update employee deduction by resource ID |
X |
||
|
Delete employee deduction by resource ID |
X |
||
|
Pay setup API: Recurring earnings |
Create employee earning |
X |
|
|
Get employee earnings (batch) |
X |
||
|
Get employee earning (single) |
X |
||
|
Get employee earning by resource ID |
X |
||
|
Update employee earning by resource ID |
X |
||
|
Delete employee earning by resource ID |
X |
||
|
Pay statements |
Get employee pay statement details data for the specified year and check date |
X |
|
|
Get employee pay statement details data for the specified year |
X |
||
|
Get employee pay statement summary data for the specified year and check date |
X |
||
|
Get employee pay statement summary data for the specified year |
X |
||
|
Primary state tax |
Add/update primary state tax |
X |
|
|
Punch detail API: Company punch details |
Create operation |
X |
|
|
Get operation status |
X |
||
|
Get punch detail data |
X |
||
|
Get punch details |
X |
||
|
Punch import API: Punch import |
Create employee punch (batch) |
X |
|
|
Scheduling API: Company shifts |
Get shifts |
X |
|
|
Scheduling API: Employee shifts |
Get shifts |
X |
|
|
Scheduling API: Open shifts |
Get open shifts |
X |
|
|
Sensitive data |
Get sensitive data |
X |
|
|
Add/update sensitive data |
X |