Skip to content

HR Data Definition (Paychex API Integration)

In this step, you will choose the type of report to generate, attributes to process and the polling interval (scheduling processing of report) for your Paychex integration.

You can also apply custom filters on the report data.

Paychex Reports

Figure 1. Paychex reports.

Full Load

A full report for the selected attributes for all employees data will be generated. Report will be generated on the basis of type of polling interval selected.

Paychex Full Load

Figure 2. Paychex full load.

For scheduling report processing, you can refer to Paychex polling.

Initial one-time full sync

To receive an initial pull of the full report as soon as the flow is deployed.

Paychex Initial Pull

Figure 3. Paychex initial pull.

Select employee attributes you want to process

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

Paychex Employee Attributes

Figure 4. Paychex 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

Select the date format of the HR attributes that are of date type. The default date format is YYYY-MM-DD.

Details of Date Format

Figure 5. 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 6. 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 eg. An organization can have multiple offices at different locations (time zones) for which they can select respective time zones according to their locations.

Details of Multiple Time Zone

Figure 7. 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. You can create complex filters using And or Or conditions.

Event Filtering for Paychex Data

Figure 8. Event filtering for Paychex data.