The Employment Hero and CareVision integration streamlines payroll processing by automatically transferring employee data, such as timesheets and pay details between systems. Information syncs from CareVision to Employment Hero for employee records. This reduces manual operations, minimizes errors, and ensures payroll information remains accurate.
This document describes the process to set up, synchronize, and manage staff and payroll data between Employment Hero and CareVision.
Keywords: employment hero integration, link employment hero to carevision, employment hero payroll, payroll processing guide, employment hero setup, staff pay details employment hero, generate payroll carevision
Before integrating Employment Hero with CareVision, ensure the following requirements are met:
1. Log in to Employment Hero Portal
Request access credentials from the Employment Hero support team.
Log in to the Employment Hero portal using your credentials as business administrator.
Enable two-factor authentication (2FA) on the Employment Hero login page.
2. Log in to CareVision Portal
Request access credentials from the CareVision support team.
Log in to the CareVision portal using your credentials.
Open the CareVision Parameter Store.
The system administrator should set up the following Employment Hero organization data:
Sample Setup
In CareVision, go to Settings in the left navigation menu.
Click General Config.
Under Organisation Details, find the ABN/ACN field and enter the ABN registered in Employment Hero.
In Employment Hero, go to the left navigation menu and click Business.
Click Payroll Settings.
Under Business Details, check the ABN field and ensure it matches the ABN entered in CareVision.
Configure the careorganizations_jobclassifications.job_classification field as described in the Data Mapping Between CareVision - Employment Hero table.
This can currently only be done via API requests. No UI available yet. Your implementation consultants can assist you with this.
Ensure that job classifications in CareVision align with Employment Agreements in Employment Hero.
Relevant columns in CareVision are populated with the following:
Column | Description |
id | Value |
careorganization_id | Client's Organisation ID, which can be found in the URL of their web portal. |
job classification | The job classification assigned to the staff member, as found in the Staff Profile under Staff Pay Details > Pay Details > Job Classification. |
rate_set | The set of pay rates applicable to the staff member or job classification. |
pay_rule | The rule or policy that determines how pay is calculated for the staff member. |
friendly_name | A user-friendly name. |
description | A brief explanation or summary of the record. |
available_for_new_staff | Indicates whether this record is available for assignment to new staff members. |
payroll_sleepover_description_prefix | The prefix used in payroll descriptions for sleepover shifts. |
created_at | The date when the record was created. |
createdby_user_id | The unique ID of the user who created the record. |
modified_at | The date and time when the record was last modified. |
modifiedby_user_id | The unique ID of the user who last modified the record. |
deleted_at | The date and time when the record was deleted. |
deletedby_user_id | The unique ID of the user who deleted the record. |
Check Employment Agreements in Employment Hero:
In Employment Hero, go to the left navigation menu and select the Business section.
Click Payroll Settings.
Scroll down to Employment Agreements.
Verify that the Employment Agreements section aligns with Job classifications in CareVision.
Configure the cost_centresfield as described in the Data Mapping Between CareVision - Employment Hero table.
Go to Settings in the left navigation menu in CareVision.
Click Cost Centres.
Update or create new cost centres to ensure their names exactly match the location names in Employment Hero. Any cost centre assigned to staff must use the exact text as it appears in Employment Hero.
In Employment Hero, go to the left navigation menu and click the Business section.
Click Payroll Settings.
Click Locations.
Review the Locations in Employment Hero, which are used for costing, payroll tax reporting, and public holiday settings.
Ensure all cost centre names in CareVision match the corresponding location names in Employment Hero.
a. Configure Leave Types
Go to Settings in CareVision and select Leave Types.
In Employment Hero, go to Work Types and find the External ID.
Enter the External ID from Employment Hero into the Allowance Code field in CareVision.
b. Set Up Kilometer Reference Code
In CareVision, go to General Config and navigate to the Organisation Reference Codes section.
In Employment Hero, locate the External ID.
Enter the External ID from Employment Hero into Ref 23 in CareVision.
The KM Billing Category setup in CareVision can be configured at both the organisation level and the billing category level.
Organisation-Level Setup: The configuration applies across the entire organisation.
Billing Category-Level Setup: If you need a specific billing category to have a different rate paid to staff, you can configure it at the billing category level for that exception.
The billing category-level setting takes precedence. If no billing category-level setting is found, the organisation-level setting will be used.
c. Assign Sleepover
In CareVision, go to General Config and navigate to the Organisation Reference Codes section.
In Employment Hero, locate the External ID associated with the sleepover work type.
Copy the External ID from Employment Hero and enter it into Ref 15 in CareVision.
The Sleepover External ID in CareVision can be configured at both the organisation level and the billing category level.
Organisation Level: The External ID entered in Ref 15 applies to all billing categories across the organisation. If Employment Hero uses the same External ID for both sleepover and travel, enter this shared External ID into Ref 15 in CareVision. ensuring it applies to both categories as needed.
Billing Category Level: If a specific billing category requires a different External ID, you can enter a separate configuration at this level. The billing category-level setting takes precedence. If no billing category-level setting is found, the organisation-level setting will be used.
d. Standard Work Type ID
Enter the appropriate value in Ref 24 for standard time-based output based on your organisation. This assigns a work type ID to standard time-based billing categories, as reflected in the Work Type External ID column in Employment Hero.
e. Define Breaks
In specific cases, breaks need to be recorded and identified using a specific code. CareVision ensures these codes are included when when sending timesheets to Employment Hero, ensuring paid breaks are processed correctly.
Obtain the External ID for each type of Standby Break from Employment Hero Payroll. Categorize these breaks as needed (afternoon, lunch, etc.).
In CareVision, click Schedules from the left menu bar.
Click Teams.
Set filters as needed.
Click Apply.
The list of staff will appear on the left side. Select the relevant staff member from the staff list on the left side of the screen.
Click the plus (+) icon next to the staff member’s name.
Choose Create Scheduled Break to add a break for this staff member only.
Alternatively, select Create Scheduled Break Template to create a reusable template for multiple staff.
The Create Scheduled Break window is displayed. Complete all required fields.
In the Break Code field, enter the corresponding External ID (obtained from Employment Hero Payroll) for each break.
Once all required fields are completed, click Save.
There is no organizational-level setup for paid breaks in CareVision. You must follow the steps above for each staff member or use templates as needed.
CareVision automatically computes and streamlines break payments when timesheets are sent to Employment Hero. The correct rate is applied based on the Break Code.
To ensure seamless payroll processing between CareVision and Employment Hero, establish the integration between the two systems.
In the left navigation menu, click Settings.
Click Integrations.
Find Employment Hero and click Link My Account.
Log into Employment Hero when prompted to complete the integration.
A success message will confirm your account is linked.
After integration, the system automatically syncs all staff records, ensuring that staff profile details and pay information in CareVision are accurately reflected in Employment Hero. We recommend that you check the sync data before and after the integration to ensure that all information has been accurately transferred.
How It Works When Your Account Is Already Set Up on Employment Hero
If your account is already set up on EH and you enable this integration, the following scenarios will occur:
The integration will automatically check for existing Employment Hero payroll IDs.
If a payroll ID matches an existing record in EH, the integration will update that record rather than create a new one.
If a payroll ID does not exist, a new record will be created in EH.
1. Complete the Detailed Profile Section
1. In the left menu bar, click People.
Click Teams.
Select the staff member whose profile you want to update.
4. Click the Detailed Profile section.
Make sure that all required information is completed for each staff profile. Some of the most important fields include:
Employee Number (from TechOne)
Employment Start Date
Payroll Employee ID
6. Ensure the Do not send to CareVision Payroll checkbox is unticked.
2. Complete the Staff Pay Details Section
For detailed instructions, see the Staff Pay Details documentation.
3. Complete the Work Availability Section
This section records each staff member’s work schedule and planned leave. The information entered here syncs with Employment Hero, ensuring payroll calculations accurately reflect both scheduled work hours and approved leave.
a. Create Work Schedule
In the staff profile, click the Work Availability section.
Click +Create Work Schedule
Enter a descriptive name for the schedule in the Schedule Name field.
In the Schedule Type dropdown field, select either Ordinary Work Schedule or Contract Hours.
Ordinary Work Schedule is used to create the staff member’s regular work schedule.
Contract Hours is used to create a schedule based on the staff member’s contracted hours. This schedule can be used to track and compare the staff member’s contracted hours against the actual hours they have worked.
In the Schedule Start Date (inclusive) field, select the first day the schedule begins using the calendar.
In the Schedule End Date (exclusive) field, we recommend leaving it blank so that availability remains open-ended.
For each day, enter the staff member’s Start Time.
For each day, enter the staff member’s End Time.
Enter the Break Start Time (unpaid).
Enter the Break Duration (in minutes).
When finished, you can set other days individually or use the Copy to All option to apply the same schedule to every day. Using Copy to All is recommended for consistency across the week. However, you can still untick specific days or adjust the times for particular days if needed.
Click Save to manage and record the staff member's availability.
The work schedules you’ve created will appear under the Hours of Work Availability section.
b. Create Leave Schedule
A leave schedule records periods when a staff member is unavailable for work. Scheduling or admin teams can submit leave requests on behalf of staff, who will be notified. Leave requests can be added directly from the staff profile.
In the staff profile, click the Work Availability section.
Click +Create Leave Schedule.
The Create Leave Schedule form will appear. Complete all required fields with accurate information.
Click Save to record the leave schedule.
The newly created leave schedule will appear under the Leave Schedule section with details, including its status. If the leave requires approval, the status will show as Requested. If the leave type is auto-approved, the status will show as Approved.
Schedule Shifts for Each Staff Member. Ensure bookings or shifts are scheduled for each staff member during the pay period.
Reviewing and approving bookings before export is important for payroll accuracy. The Service Review board allows you to verify each booking’s details and resolve any issues before exporting to payroll. Approving only accurate bookings helps prevent errors and ensures staff are paid correctly.
On the left menu bar, click Actions.
Select Service Review.
In the upper right, set the From date to the start of your pay period.
Set the To date to the end of your pay period.
Click the Refresh button to load the bookings.
The Service Review board will display all bookings for the period you select.
Review the booking outputs that may impact payroll.
The Service Review Board in CareVision provides a view of payroll columns for each staff member. Before approval, check the following pay columns:
Column | Definition |
Time | Pay Time represents the specific time period or time entries for which the staff member is being paid. This is commonly based on either the rostered (scheduled) time or the actual check-in/check-out times if there was a deviation and it was approved. The system defaults to paying scheduled time to avoid minor discrepancies, but this can be overridden if justified and approved. |
Travel With Client (TWC) | This column tracks the kilometers or travel units associated with transporting or accompanying a client during appointments. If a staff member logs travel with a client, this is recorded here and contributes to their pay. It’s important to check that any travel with a client is accurately logged and matches the staff member’s claims and the appointment details. |
Call Out Fee (COF) | COF refers to the call out fee, which is an additional payment for travel between appointments or for attending a client outside of regular scheduling. This field captures the calculated kilometres or fees for travel between appointments, excluding the first appointment of the day (as travel to the first appointment is not paid). Ensure that the call out fee is correctly calculated and applied according to the staff member’s bookings and travel records. |
Duration | This column reflects the total hours a staff member has worked for a particular shift or booking. By default, CareVision pays based on the scheduled time unless there’s a manual adjustment (such as when a staff member stayed longer with client approval, the duration can be modified to reflect actual check-in/check-out times). It is important to verify that the Pay Duration aligns with the actual time worked and any approved changes. |
Time | Pay Time represents the specific time period or time entries for which the staff member is being paid. This is commonly based on either the rostered (scheduled) time or the actual check-in/check-out times if there was a deviation and it was approved. The system defaults to paying scheduled time to avoid minor discrepancies, but this can be overridden if justified and approved. |
If any data is missing, the Service Review Board will flag it before export.
Bookings with issues are indicated by booking IDs highlighted in red. For each highlighted booking ID, click the downward arrow to expand and view the alert details.
Review and resolve booking issues.
After you have verified that a booking is correct, you can approve it. Under the Actions column, click the checkbox to approve a booking.
A prompt will appear asking you to confirm whether you want to approve the booking. Click Approve to proceed.
Once you are confident that all information is accurate and complete, you can proceed with generating payroll.
In the left menu, click Settings.
2. Select Payroll.
Set the Structure field to KeyPay/Employment Hero.
4. Set the Branch field to the relevant branch.
5. Set the Staff payroll name field to the appropriate payroll name(s).
6. Set the Payroll Name field to the appropriate payroll name(s).
7. Set the Timezone field to the appropriate Australia timezone.
8. Set the From (Inclusive) date field to the start of the payroll period.
9. Set the To (Exclusive) date field to the end of the payroll period.
Turn on the Limit To Approved Items Only toggle if you want to limit your export to include only the approved items in the service review.
(Optional) Turn on the toggle Override Adjustment Period to allow additional days after your export period for capturing any late changes. This ensures that all updates up to the selected adjustment to date are automatically included, helping to keep your reports accurate and complete. When you turn on this toggle, specify the Adjustment From (Inclusive) and Adjustment To (Exclusive) fields.
For example, if your standard export period is June 1, 2025 to June 29, 2025, but approvals and adjustments are finalized on July 1, 2025, you should set:
Adjustment From (Inclusive): June 29, 2025
Adjustment To (Exclusive): July 2, 2025
This ensures that any changes made from June 29 up to, but not including, July 2 are captured in your export, keeping your June 2025 reports accurate and complete.
12. Click Generate Payroll to compile payroll data.
13. Download and extract the ZIP file containing Mileage and Timesheet files.
14. Review both files to ensure all payroll information is accurate.
After you review the files and confirm all details are correct, you can enable the Send to KeyPay toggle.
Then, click Generate Payroll to proceed with submitting the payroll to KeyPay/Employment Hero.
Once timesheets has been submitted from CareVision, complete the following steps in KeyPay/Employment Hero:
Review the imported timesheets to confirm all data from CareVision has synced correctly.
Check for any missing, duplicated, or incorrect timesheet entries and resolve any issues as needed.
When all timesheets are accurate, continue with your usual pay run process in KeyPay/Employment Hero.
For more information about Employment Hero and CareVision integration, contact the CareVision support team.