Who is WageEasy?
WageEasy is a comprehensive payroll and human resources management software solution offered by The Access Group. It is designed to streamline payroll processes, manage employee records, and ensure compliance with local regulations. WageEasy is particularly popular in Australia, providing features like employee data management, payroll processing, and compliance reporting. For more detailed information, please visit ⭧The Access Group's WageEasy page.
What this article covers
This article outlines the functions and options available through API-based integration between Humanforce Workforce Management (WFM) and WageEasy Payroll in Humanforce Cloud. It is crucial to set up the integrations correctly to prevent data issues. If you require assistance or are unsure about setting up the integration, please reach out for help before starting to avoid additional fees for support packages.
What does the integration do?
The integration between Humanforce WFM and WageEasy Payroll facilitates the transfer of crucial employee data, ensuring accuracy and efficiency in workforce management.
Here's what the integration accomplishes:
-
Employee Personal Details:
- WageEasy → Humanforce WFM: Newly created employees and updates made to the employee's details are sent to WFM in a bulk sync that can be scheduled or manually run through Integration Central.
-
Employee Leave Balances:
- WageEasy → Humanforce WFM: After payroll finalisation, leave balances are updated in WageEasy and can be synced to WFM. Note, in WFM, all leave is displayed in hours.
Prerequisites
Before proceeding with the integration, ensure that the following prerequisites are met:
- Humanforce Cloud Customer: Access to this integration is exclusive to Humanforce Cloud customers.
- API Credentials: Obtain API credentials from WageEasy with comprehensive permissions to facilitate data exchange between the platforms.
- Source of Truth: WageEasy serves as the primary repository for employee data.
- Data Preparation: Ensure that employee records and related data are accurate and up-to-date in both systems.
Integration Setup
Detailed step-by-step setup instructions for the WageEasy integration can be found in this article ⭧Set up WageEasy integration.
API Documentation
WageEasy uses basic authentication with an API key for secure communication. Ensure that your application supports SSL and CORS to securely connect to the WageEasy API.
For detailed API documentation and additional configuration options, please refer to the ⭧WageEasy API documentation and ⭧Humanforce REST API Overview.
Integration Workflow
Follow these steps to set up the integration between Humanforce WFM and WageEasy Payroll:
-
Prepare Your Data:
- In WFM: Create Access Level, Clock-in Setting, Qualification Types, Visa Types, Employment Type, Location, Department, Role, Award Profiles, and Area (if required).
- In Both Systems: Create Public Holidays, Pay Rates, Pay Types, and Leave Types. Create and match Gender, Employment Type, Title, and Pay Company.
-
Set Up Integration:
- Obtain API credentials for WageEasy.
- Set up the integration in WFM > Integration Central. ⭧Learn how in this article.
- Test the connection and resolve any errors.
-
Configure Mapping:
- Employee Import
- Enable employee details sync for accurate data transfer. Supported mapping ⭳below.
- Enable leave balance sync and complete mapping.
- Optionally, schedule automatic data synchronisation.
- Employee Import
-
Review and Troubleshoot:
- Monitor the import log and address any errors for a successful data transfer.
Supported Data Mapping
This integration facilitates data transfer between Humanforce WFM (WFM) and WageEasy in three main categories:
- Employee Details: This includes employee information such as personal details, and employment details, which can be transferred from WageEasy into Humanforce WFM every time the integration central task runs in WFM.
- Employee Leave Balances: Employee leave balances are checked and pulled every time the WageEasy integration central task runs in WFM.
Employee Details
Field Name - WFM | Field Name - WageEasy | Field Details |
Employee Code |
|
“Identifier” is prefix for EmployeeCode on creation |
Payroll Code |
employeeno |
Optional. Lookup should be based on the employeecode in HF and the lookup is not restricted to the current paycompany |
Pay Company |
|
Per Authentication Pay company mapping |
Title |
Title |
name match |
Last Name | LastName | Employee's family name. |
First Name | FirstName | Employee's given name. |
Date of Birth | Birthday | Format: yyyy-mm-dd. |
Gender | Gender |
name match M: Male, F: Female, I: Intersex, Other: default. |
Job Title | JobTitle | Employee's job title. |
Employment Type | EmploymentCategory |
name match FullTime, PartTime, Casual. |
Start Date | EmploymentDate | The date when the employee started. |
Termination Date | TerminateDate | Date when the employee was terminated, if applicable. |
DefaultEmail | Employee's primary email address. | |
Email 2 |
DefaultEmailUsedForPayslips |
|
Phone | Telephone1 | Primary phone number. |
Phone 2 | Telephone2 | Secondary phone number, if available. |
Primary Address
|
|
Employee's residential address. |
Postal Address
|
|
Employee's mailing address, if different. |
Roster Name | KnownAs |
Optional. Nickname or preferred name used within the company. |
Bank Details
|
|
Optional. Where default is true. Employee's bank name. |
New Employee Defaults
The following fields allow once-off values to be selected for newly created employees.
Field Name - WFM tab.section. field name [api name] |
Field Details |
Personal Details.Personal.
|
|
Employment.Employment.
|
Summary Entity Model |
Employment.Employment.
|
|
Location, Department, Roles.Roles and Profiles.
|
Summary Entity Model |
* Mandatory field
Employee Leave Balances
Field Name - WFM / WageEasy | Field Details |
PayrollCode
|
Based on PayrollCode import setting. |
Shift Type Code
|
Shift Type code used for mapping |
LeaveBalance |