Overview
The Sync Employment Hero Future Leaves feature enables automatic synchronisation of future leave requests from Employment Hero (KeyPay) to Simpro. Please note that the Employment Hero (EH) API allows the integration to retrieve/sync future leave for a maximum period of 30 days in advance. Therefore, the integration can only check and sync future leave requests within the next 30 days.
This feature is currently available for:
-
Australian (AU) customers
-
New Zealand (NZ) customers
How It Works
-
A new toggle is available in Settings.
-
The feature is disabled by default.
Once enabled:
-
Only future leave requests created in Employment Hero will sync to Simpro.
- The integration automatically checks for new and updated future leave requests every hour.
- During each sync cycle, the system processes up to 6 leave records.
- If there are more than 6 leave records waiting to be synced, the remaining records will be processed automatically in subsequent hourly sync cycles until all records have been synced
We are continually improving the integration to increase the number of leave records that can be processed in each sync cycle.
Cancellation Handling
If a leave request is cancelled in Employment Hero, it will be automatically removed from Simpro.
Prerequisites
Before using this feature, ensure the following:
-
Leave types are correctly paired in the SyncEzy integration pairing
-
Employees are paired in SyncEzy before applying leave
Failure to meet these requirements may result in synchronisation issues.
Supported Leave Types
The following leave types are supported:
-
Hour-based leaves
-
Day-based leaves
-
Week-based leaves
Synchronisation Behavior
Hour-Based Leave
Examples
Please note: In hourly type leave if a single leave request includes multiple days, the total leave hours will be divided equally across the requested days. However, the allocated leave hours for any day will not exceed the employee’s maximum working hours for that day.
Example: If an employee submits one leave request for 3 days with a total of 24 leave hours, the hours will be split equally at 8 hours per day. If the employee’s maximum working hours are 7 hours per day, the leave hours allocated to each day will be limited to 7 hours per day. Therefore, if you intend to apply for different leave hours on different days, it is advisable to submit a separate leave request for each day. This will ensure that the intended leave hours are correctly applied to each individual day.
If an employee works 40 hours per week and 8 hours per day, then:
Day-Based Leave (Based on employee's working hours)
1-Day leave applied for a day
-
Synced as 8 hours
-
Time: 7:00 AM – 3:00 PM
0.5-Day leave applied for a day
-
Synced as 4 hours
-
Time: 7:00 AM – 11:00 AM
Week-Based Leave
1-Week leave applied for 5 days
-
Synced as 5 separate 8-hour schedules
Each day:
0.5-Week leave applied for 3 days
Key Notes
-
Only future leave entries are considered for syncing
-
Sync runs automatically; no manual trigger is required
-
Accurate pairing of employees and leave types is critical for proper functionality
-
Point-value leave durations from Employment Hero are automatically rounded to the nearest 15-minute increment supported by Simpro before syncing
- Please note that the Employment Hero (EH) API allows the integration to retrieve/sync future leave for a maximum period of 30 days in advance. Therefore, the integration can only check and sync future leave requests within the next 30 days.