GuidesAPI ReferenceChangelog

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 NamePartner Field Name from UIDirection of Exchange from Payroll DatabaseRequired for Service?
EMPLOYEEEmployee IDIDPULLYES
First NameF. NamePULLYES
Last NameL. NamePULL
GenderGenderPULL
Employee StatusStatusBI-DIRECTIONALYES
Hire DateHire DateBI-DIRECTIONALYES
Termination DateTermination DateBI-DIRECTIONALYES
Base RateHourly RateBI-DIRECTIONALOPTIONAL
DEDUCTIONEffective DateStart DateBI-DIRECTIONALYES
End DateStop DateBI-DIRECTIONALYES
dCODEDeduction CodeBI-DIRECTIONALYES
calcCodePercent or FlatBI-DIRECTIONALYES
RatePay RatePUSHYES
Loan NumberLoan IDPUSHOPTIONAL
Paid Towards GoalGoal AmountPULL

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.

Copyright © 2023 Paylocity. All Rights Reserved. Privacy Center | Terms and Conditions | Accessibility