Data Element & Directionality Mapping
Explaining the data flow of your integration.
This document provides a framework for integration teams to understand the mapping between Paylocity and a third-party system, including a clear mapping of all field names of data exchanged, data direction (push or pull), and whether the field is required for your solution.
Example Mapping:
Paylocity API Endpoint(s) | Paylocity Field Name | Partner Field Name from UI | Direction of Exchange from Payroll Database | Required for Service? |
---|---|---|---|---|
EMPLOYEE | Employee ID | ID | PULL | YES |
First Name | F. Name | PULL | YES | |
Last Name | L. Name | PULL | ||
Gender | Gender | PULL | ||
Employee Status | Status | BI-DIRECTIONAL | YES | |
Hire Date | Hire Date | BI-DIRECTIONAL | YES | |
Termination Date | Termination Date | BI-DIRECTIONAL | YES | |
Base Rate | Hourly Rate | BI-DIRECTIONAL | OPTIONAL | |
DEDUCTION | Effective Date | Start Date | BI-DIRECTIONAL | YES |
End Date | Stop Date | BI-DIRECTIONAL | YES | |
dCODE | Deduction Code | BI-DIRECTIONAL | YES | |
calcCode | Percent or Flat | BI-DIRECTIONAL | YES | |
Rate | Pay Rate | PUSH | YES | |
Loan Number | Loan ID | PUSH | OPTIONAL | |
Paid Towards Goal | Goal Amount | PULL |
Key
- PULL – Indicates this data is pulled from Paylocity’s Databases.
- PUSH – Indicates this data is pushed from the Partner’s Databases into Paylocity’s Databases.
- BI-DIRECTIONAL – Indicates this data is both PUSHED and PULLED between the databases. The Paylocity Partner is responsible for the Sync and Drift of the data in these scenarios.
Best Practices
- If your system/service also allows customer-specific data mappings, be sure to note that in any documentation provided to Paylocity and customers.
- In addition to providing a table like above, additional consideration should be given for any ‘callouts’ regarding the data-mappings, directionality, and options within internal and customer-facing documentation. It is strongly recommended to provide resource links to support articles that can be used when troubleshooting these topics.
Updated 10 months ago