Historic payroll
1. Sync employee data
Sync Employees data following Onboard use case workflow. Make sure your user has access to the Employments model, as this holds information related to historical pay.
2. Pull employee and employment data
In your backend, pull the GET /Employees Object, as well as the related Employments Object.
To access a given Employee’s current and historical employments, use the employments array on Employees.
3. Access historic payroll information
Access historic payroll information from the Employments object:
- Use the
effective_datefield to see past pay periods, and filter by time. - Use the
pay_ratefield to access the pay for a given Employment.
Please note: When there is a change in pay or title, third-party platforms that track historical data will create new Employment objects, while platforms that don’t track historical data will update existing records.
4. Surface information to users
Generate UI, functionality, or workflow that surfaces this information, or an analysis of this information, based on your app’s functionality.
