Common Integration Use Cases
Paylocity partners, such as 401k providers, applicant tracking systems, and benefit administrators, are able to use Paylocity APIs to integrate Paylocity data with company systems. The following table provides a quick reference of common use cases for technology partners and what APIs should be used to solve those needs. In addition to the resources for each use case in the table below, review Integration Implementation Best Practices for additional context around the business needs that can be accomplished with Paylocity APIs.
| Integration Type | Use Case | Resource |
|---|---|---|
| 401k Providers | Retrieve employee demographic information in order to maintain a list of employees who are participating in the 401k plan | GET EMPLOYEE DEMOGRAPHICS - Get Employees [Batch] |
| Access employees' processed payroll information in order to know what amounts contributed to the 401k plan | PARTNER OPTION: GET PAY DETAILS - Pay Details Overview CLIENT OPTION: GET PAY STATEMENTS - PayStatements | |
| Access and/or update employees' scheduled payroll deductions so that elected deferrals & benefits will process correctly during payroll processing | Pay Setup Overview Create Employee Deduction Get Employee Deductions [Batch] Update Employee Deduction by resourceId | |
| Receive real time notifications of new hires, terminations, and changes to the clients' employees so that the provider can make necessary system updates | Webhooks Overview | |
| Receive real time notifications of clients processing payroll so that the provider can retrieve the processed payroll information for the company | Payroll Processed Webhooks | |
| Benefit Administration System | The provider wants to be able to retrieve/update clients' employees' scheduled payroll deductions so that elected benefits will correctly process during payroll processing | Pay Setup Overview Create Employee Deduction Get Employee Deductions [Batch] Update Employee Deduction by resourceId |
| Accounting System | Access clients' processed payroll information in order to facilitate financial reports and/or GL journal entries | PARTNER ONLY OPTION: Pay Details Overview CLIENT OPTION: GET PAY STATEMENTS - PayStatements (Summary & Details) |
| Timekeeping System Point of Sale (POS) System | Send clients' time data to Paylocity so that the client can process that company's payroll for employees | PAY ENTRY API - Get New Payroll Batch Status [POST Create New Payroll Batch in HR&PAYROLL] |
| Applicant Tracking System | Send employee applicants from the provider's system to Paylocity's Onboarding application | WEBLINK API ONLY: Onboarding |
| Send employee applicants from the provider's system to Paylocity's HR & Payroll application (either directly inserting records or into a staging environment) | WEBLINK API ONLY: Add new employee Employee Staging | |
| Another Software System used by Paylocity Clients | Retrieve employee demographic information in order to create/update user access and employee information in the system | GET EMPLOYEE DEMOGRAPHICS - Get Employees [Batch] |
| Receive real time notifications of new hires, terminations, and changes to the clients' employees so that the provider can make necessary system updates | Webhooks Overview | |
| Know the system level configurations for each company & Know the allowed values for data elements that will pass via API | COMPANY LEVEL INFORMATION ENDPOINTS: Get Company Information Payroll/HR Cost Centers Job Code API Overview Time and Labor | |
| Retrieve/update Custom Fields for employees in the Paylocity HR & Payroll application | WEBLINK API ONLY: Get All Custom Fields Get employee | |
| Renew NextGEN API credentials without contacting the Web Services support team | Using Developer Portal |