Skip to content

HR Data Definition (Paylocity API Integration)

Here, you need to select employee attributes that you want to be processed for the employee along with the polling interval for Paylocity API Integration. You can also apply custom filters on the report data.

Full Extract

If you have selected Full Extract then a full report for all the selected attributes from the employee attributes will be generated. This report will be generated on the basis of type of polling interval selected.

Paylocity API Full Extract

Figure 1. Paylocity API full extract.

Initial one-time full load

You can select the Initial one-time full load checkbox if you want to receive an initial pull of the full report as soon as the flow is deployed.

Paylocity API One-time Initial load

Figure 2. Paylocity API initial one-time load.

Select employee attributes you want to process

You can select the employee attributes defined in the Paylocity API that you want to be processed by Hire2Retire. Hire2Retire pre-selects important attributes. Pre-selected attributes can be removed by you if you don't want them included in the report.

Paylocity API Employee Attributes

Figure 3. Paylocity API employee attributes.

And, if you have enabled 'Future Hire, Rehire and Termination' on Application page then following fields will appear such as (Date Format and Time Zone).

Select Date Format

For Paylocity, the date format supported in Hire2Retire is DD-MM-YYYY or YYYY-MM-DD. You need to select this format to proceed with Future Hire and Termination.

Details of Date Format

Figure 4. Details of Date Format

Select Time Zone

Choose the time zone in which you want to process the scheduled hire, rehire and termination events.

Single time zone

All the scheduled hire, rehire and termination events will be executed in a selected time zone. The default time zone is America/New York.

Details of Single Time Zone

Figure 5. Details of single time zone

Multiple time zone

Here, scheduled hire, rehire and termination records will be executed in the time zone based on the condition defined by HR data. For instance, if your organization has offices in various locations, each one will be able to choose its time zone based on its specific location.

Details of Multiple Time Zone

Figure 6. Details of multiple time zone

Apply Selection Criteria

Hire2Retire enables you to process specific events and filter out the rest by defining filter criteria. On clicking the Apply Filter button, you will be able to set up conditions using employee attributes. Only employees whose attributes match the conditions will be processed from Paylocity to AD. You can create complex filters using And or Or conditions.

Event Filtering for Paylocity API Data

Figure 7. Event filtering for Paylocity API data for Future Hire, Rehire and Termination.