Paylocity Key Concepts
Helping understand relationships of entities in the Paylocity solution to help map data between integration systems
Overview of the Paylocity Data Model
Paylocity is a robust cloud-based payroll and human capital management (HCM) software that streamlines employee data management. The Paylocity Data Model simplifies the process of accessing employee information through its API, making it easier for businesses to retrieve and manage data effectively.
Key Elements: Employee ID and Company ID
In the Paylocity Data Model, each employee is uniquely identified by two elements: their Employee ID and the Company ID. Combining these two elements ensures that each employee can be uniquely identified within the system.
Employee ID:
A unique identifier assigned to each employee within a company. No two employees within the same company share the same Employee ID.
Company ID:
A unique identifier assigned to each company using Paylocity. This ensures that employees from different companies can be differentiated, even if they have the same Employee ID.
Module-specific data
Accessing Employee Information through the Paylocity API
To access specific employee information using the Paylocity API, you need to know the destination Company ID and the Employee ID associated with the employee whose data you want to retrieve. You can easily make an API call to fetch the required employee data with these two identifiers.
Using the GET EMPLOYEE Endpoint
You can use the GET EMPLOYEES endpoint to retrieve a complete list of employees within a company. In this scenario, you only need to know the Company ID, as the API will return a list of all employees associated with that company. You may leverage the INCLUDE and FILTER parameters to limit the data returned.
Glossary test OAuth 2.0
Updated about 1 year ago