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 Get all employees
	Access employees' processed payroll information in order to know what amounts contributed to the 401k plan	Get employee pay statement details data for the specified year and check date. Get employee pay statement details data for the specified year. Get employee pay statement summary data for the specified year and check date. Get employee pay statement summary data for the specified year.
	Access and/or update employees' scheduled payroll deductions so that elected deferrals will process correctly during payroll processing	Add / Update Deduction Delete deduction for deduction code / start date Get All Deductions Get Deduction for Deduction Code
	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	Add / Update Deduction Delete deduction for deduction code / start date Get All Deductions Get Deduction for Deduction Code
Accounting System	Access clients' processed payroll information in order to facilitate financial reports and/or GL journal entries	Get employee pay statement details data for the specified year and check date. Get employee pay statement details data for the specified year. Get employee pay statement summary data for the specified year and check date. Get employee pay statement summary data for the specified year.
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	Create New Payroll Batch
Applicant Tracking System	Send employee applicants from the provider's system to Paylocity's Onboarding application	Onboarding
	Send employee applicants from the provider's system to Paylocity's HR & Payroll application (either directly inserting records or into a staging environment)	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 Get all employees
	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	Get Company-Specific Open API Documentation Get All Company Codes
	Know the allowed values for data elements that will pass via API	Get Company-Specific Open API Documentation Get All Company Codes
	Retrieve/update Custom Fields for employees in the Paylocity HR & Payroll application	Get All Custom Fields Get employee
	Automatically renew API credentials without contacting the Web Services support team	Renew API Credentials