The details in this article may be updated as the integration continues to evolve. To receive notifications about any changes or enhancements, click the Follow button at the top left of this article.
When Humanforce Workforce Management (WFM) is integrated with Humanforce Payroll (HFP), key employee and auxiliary data can sync automatically across systems, reduces manual entry, improves accuracy, and supports compliance.
This article provides a detailed reference for all supported fields in the integration, including how they map between WFM and Payroll, the direction of data flow, and any configuration notes to help you verify and maintain your setup.
Use this guide to:
- Understand what data flows between WFM and Payroll
- Confirm which fields are supported and how they map
- Check data ownership and direction for each field
- Identify any fields that must be manually maintained
Using the full Humanforce HCM Suite? If your organisation uses Humanforce HR, WFM, and Payroll, refer to the Humanforce HCM Suite integration overview for the recommended setup and field mapping across the full suite. The suite-level integration includes specific configuration requirements and forward-only data flows to support data consistency across all systems.
Integration flows
The integration between Humanforce WFM and Payroll uses scheduled or on-demand synchronisation to keep data aligned between systems. This section outlines how data is transferred, when syncs occur, and what mechanisms control each flow.
The sync direction and frequency depend on how your integration is configured in Integration Central and whether WFM or Payroll is the source of truth for employee data
WFM → Payroll
Employee, timesheet, and cost-centre data are sent from WFM to Payroll via the Humanforce Payroll API when triggered by any of the following events:
- Employee creation or update: When an employee record is created in WFM or approved through Change Approvals, it’s automatically sent to Payroll (if live updates are enabled).
-
Timesheet export: When authorised timesheets are processed in WFM and exported from the Payroll screen, data is pushed to Payroll via the /api/timesheet endpoint.
- Award interpretation: WFM interprets timesheets before export, converting worked hours and leave into pay elements.
- Cost centre mapping: Cost centre codes are compiled during export based on configured sources (Location, Role, or custom mappings).
Payroll → WFM
When Payroll is the employee data source of truth, updates flow back into WFM through scheduled or manual syncs. The following triggers apply:
- Employee import: Pulls new and updated employees, including terminations, from Payroll into WFM.
- Auxiliary data sync: Imports pay types, pay rates, and public holidays to keep WFM’s award setup aligned.
- Payslip import: Retrieves finalised payslips from Payroll and attaches them to corresponding employee profiles in WFM.
- Leave balance import: Syncs updated leave balances from Payroll after each payrun finalisation.
Icon reference table
| Icon | Meaning |
|---|---|
| 🔄 Alternate mapping available | Additional mapping options are available to support different setups. |
| ⚠️ Critical configuration note | Highlights behaviour or setup steps that may affect data syncing. |
| 🔷 Custom field required | Field must be created as a custom field before it can be mapped. |
| 📝 Default config possible | Default values are used when the source field in HR is empty. Defaults won’t apply if the field fails to map or returns no match. |
| 🔐 Early access | Feature is available for testing but not yet fully released. Opt-in required. |
| 🟡 Hidden field | Not visible in the UI but can be included in syncs via integration. |
| 🔗 Linked to auxiliary data | Value comes from a dropdown list that can sync via auxiliary data. |
| * Mandatory field | This field must have a value for the employee to be complete in the system. |
| ❌ Not integrated | Field is not currently supported for sync between systems. |
| 🚫 Do not map | Mapping this field will override source-of-truth data and will cause sync errors or inconsistencies. |
Auxiliary data
Manually maintain auxiliary data for accuracy
Certain fields must be manually maintained in both Humanforce WFM and Payroll as they do not automatically sync. These include:
- Award profile
- Employment type
- Simplify employment types in WFM to improve reporting and reduce administrative overhead.
Example: Fulltime, FulltimeLL (with Leave Loading), PartTime, PartTimeLL, and CAS (Casual).
- Simplify employment types in WFM to improve reporting and reduce administrative overhead.
- Gender
- Title
- Visa type
Regular updates to these fields help maintain consistency and prevent errors in reporting, compliance, and payroll processing.
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
|
🚫 Do not map Default Location |
🚫 Do not map Levels(1:M)
|
🚫HFP→WFM | Level must be named Location in HF Payroll |
|
🚫 Do not map Default Department |
🚫 Do not map Levels(2:M)
|
🚫HFP→WFM | Level must be named Department in HF Payroll |
|
🚫 Do not map Default Role |
🚫 Do not map Levels(3:M)
|
🚫HFP→WFM | Level must be named Role in HF Payroll |
|
🚫 Do not map Org Structure Mappin |
🚫 Do not map Org Structure LCODE/DCODE/RCODE |
🚫HFP→WFM | Matches based on Code. |
|
Pay Rates
|
Pay Rates
|
HFP→WFM |
Matches based on Name. |
|
Pay Types
|
Pay Elements
|
HFP→WFM |
PayType will be treated as either Units, Factor or default to Multiplier with 0 Matches based on Name. |
|
🚫 Do not map Public Holidays
|
🚫 Do not map Public Holidays
|
🚫HFP→WFM |
PH Type defaults to 🚫 Do not map as;
|
Employee details
Matching and data validation
To ensure accurate synchronisation, employee matching follows this order of priority:
- Payroll Code (WFM) = Employee Number (Payroll)
- If not matched, system checks Date of Birth, First Name, Last Name, and Payroll Company
- If no match is found, WFM creates a new employee record
⚠️ If both systems are active sources of truth, duplicates can occur. Always define a single data master (recommended: WFM) before enabling bi-directional syncs.
Employment
The following tables outline how employment-related fields map between systems, including configuration dependencies.
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
|
Personal Details.Personal. Employee Code* |
Employee.Employment. Employee number* |
HFP→WFM |
Only imports for new employees. Character limit: 50 |
|
Employment.Employment. Payroll Code* |
Employee.Employment. Employee number* |
WFM→HFP HFP→WFM |
Matches based on Payroll Code. Character limit: 100 |
|
Employment.Employment. 🔗Pay Company* |
PayrollName* | WFM→HFP | Uses the Pay Company assigned in the integration task |
|
Employment.Employment. PayPeriod name* |
PayRule* | WFM→HFP | Uses the Pay Period assigned to the Pay Company in the integration task |
|
Employment.Employment. 🔗📝Employment Type* |
Pay.Work Pattern Section. Work Pattern* |
WFM→HFP HFP→WFM |
⚠️Employee Status defaults to manual. If the Employment Type name includes auto, the employee is marked as automatic. |
|
Employment.Employment. Max Roster Hours [RosterMaxHours] |
🚫 Do not map 🔄Pay.Work Pattern Section.Work Pattern. FteHoursPerWeek |
🚫HFP→WFM |
⚠️Effective Date in WFM is set based on the Scope for Roster Hours (Min & Max) configuration. Character limit: 50 Optional to import |
|
Location, Department, Roles.Roles and Profiles. 🔗📝Default Award Profile* |
Employee.Employment. Award Agreement |
WFM→HFP HFP→WFM |
Matches based on Profile Name. |
|
Location, Department, Roles.Roles and Profiles. Default Pay Rate |
Pay.Rate Section. 🔗📝Rate Set |
WFM→HFP HFP→WFM |
⚠️Prioritises Hourly Rate over Rate Set. Rate will not send from WFM to HFP if future dates only. Matches based on Rate Name. Optional to import |
|
Location, Department, Roles.Roles and Profiles. Default Rate Override [DefaultHourlyRate] |
Pay.Rate Section. Hourly Rate/Amount |
WFM→HFP HFP→WFM |
⚠️Rate will not send from WFM to HFP if future dates only. |
|
Location, Department, Roles.Roles and Profiles. Date Effective* [RoleRevisionDateEffective] |
Pay.Rate Section. Rate Set Effective Date |
WFM→HFP HFP→WFM |
dd-mm-yyyy |
|
Employment.Employment. Start Date* |
Employee.Employment. Hired Date / Service Start Date (if Hired Date empty) |
WFM→HFP HFP→WFM |
dd-mm-yyyy |
|
Employment.Employment. Leave Accrual Start |
Employee.Employment. Service Start Date |
WFM→HFP HFP→WFM |
⚠️Sync logic varies based on setup in WFM and presence of Hired/Service/Accrual dates dd-mm-yyyy |
|
Employment.Employment. Termination Date |
Employee.Employment. Termination Date |
WFM→HFP HFP→WFM |
⚠️WFM syncs employees to HFP regardless of their termination status.
dd-mm-yyyy |
| N/A |
Employee.Employment. Termination Reason |
WFM→HFP | Termination Reason sets to Profile terminated in HFP. |
|
Employment.Employment. Include in payroll export* [ExportPays] |
🟡 | WFM→HF | ⚠️Controls sync to payroll system and timesheet export; defaults to True. |
|
Employment.Employment. 🔐Payroll Tax Exempt |
Employee.Employment. Is this employee an Apprentice Exempt from Payroll Tax? |
WFM→HFP 🚫HFP→WFM |
⚠️Sync one way only. Use when WFM is the source of truth for employee data. Import from Payroll is not recommended. |
Location, department, role
Managing LDRs and secondary roles
If an employee works across multiple LDRs, you’ll need to manage these additional structures in WFM.
⚠️ The integration does not support multi-contract setups (where a single employee holds multiple contracted jobs). If this applies to your business, speak to your Humanforce implementation team about alternative solutions.
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
|
Employment.Employment. 🔗📝 Default Location* |
🚫 Do not map 🔄Org/Cost.Org/Cost. Location[Level 1] |
🚫WFM→HFP 🚫HFP→WFM |
Imports matches based on Name. Uploads matches based on Code. |
|
Employment.Employment. 🔗📝 Default Department* |
🚫 Do not map 🔄Org/Cost.Org/Cost. Department [Level 2] |
🚫WFM→HFP 🚫HFP→WFM |
Imports matches based on Name. Uploads matches based on Code. |
|
Employment.Employment. 🔗📝 Default Role* |
🚫 Do not map 🔄Org/Cost.Org/Cost. Role [Level 3] |
🚫WFM→HFP 🚫HFP→WFM |
Imports matches based on Name. Uploads matches based on Code. |
Bank, Tax and Superannuation Information
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
|
Personal Details.Bank Account. Bank [BankName] |
Pay Distribution.Pay Distribution. Branch Name |
WFM→HFP HFP→WFM |
Character limit: 50 Optional to import |
|
Personal Details.Bank Account. BSB [BankBSB] |
Pay Distribution.Pay Distribution. BSB Code* |
WFM→HFP HFP→WFM |
Character limit: 20 Optional to import |
|
Personal Details.Bank Account. Account Name [BankAccountName] |
Pay Distribution.Pay Distribution. Account Name* |
WFM→HFP HFP→WFM |
Character limit: 50 Optional to import |
|
Personal Details.Bank Account. Account No [BankAccountNumber] |
Pay Distribution.Pay Distribution. Account No.* |
WFM→HFP HFP→WFM |
Character limit: 50 Optional to import |
|
Personal Details.Bank Account. Suffix [BankAccountNumberSuffix] |
Pay Distribution.Pay Distribution. Account Suffix.* |
WFM→HFP HFP→WFM |
⚠️Relevant for New Zealand only. Character limit: 50 Optional to import |
|
Employment.Employment. Tax Id |
Tax.Tax. Tax File Number* |
WFM→HFP HFP→WFM |
⚠️Tax ID will not update in HFP when removed from WFM. Character limit: 50 |
Personal Information
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
|
Personal Details.Contact. Mobile |
Personal.Personal. Private Mobile |
WFM→HFP HFP→WFM |
Character limit: 20 |
|
Personal Details.Contact. Phone |
Personal.Personal. Private Phone |
WFM→HFP HFP→WFM |
Character limit: 20 |
|
Personal Details.Contact. Phone 2 [SecondaryPhone] |
Employee.Employment. Work Mobile |
WFM→HFP HFP→WFM |
Character limit: 20 |
|
Personal Details.Contact. |
Personal.Personal. Private email* |
WFM→HFP HFP→WFM |
Character limit: 128 |
|
Personal Details.Contact. Email 2 [SecondaryEmail] |
Employee.Employment. Work email* |
WFM→HFP HFP→WFM |
Character limit: 128 |
|
Personal Details.Personal. First Name* |
Personal.Personal. First name* |
WFM→HFP HFP→WFM |
Character limit: 30 |
|
Personal Details.Personal. 🟡Middle Name |
Personal.Personal. Middle name* |
WFM→HFP | Character limit: 50 |
|
Personal Details.Personal. Last Name* |
Personal.Personal. Last name* |
WFM→HFP HFP→WFM |
Character limit: 30 |
|
Personal Details.Personal. 📝Roster Name* [ShortName] |
Personal.Personal. Preferred name |
WFM→HFP HFP→WFM |
Character limit: 15 |
|
Personal Details.Personal. Birth Date* [DateOfBirth] |
Personal.Personal. Date of birth* |
WFM→HFP HFP→WFM |
dd-mm-yyyy |
|
Personal Details.Personal. Gender* |
Personal.Personal. Gender* |
WFM→HFP HFP→WFM |
⚠️Supported in HFP: Matches based on Name. |
|
Personal Details.Personal. Title |
Personal.Personal. Title |
WFM→HFP HFP→WFM |
⚠️Title in WFM must be configured to match the below values from HFP: Matches based on Name. |
Emergency Contact Information
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
|
Other Info.Emergency Contacts. Name |
Emergency.List of emergency contacts. Contact Name |
WFM→HFP HFP→WFM |
Emergency Contact flag enabled by default on import in WFM. Optional to import |
|
Other Info.Emergency Contacts. Relationship |
Emergency.List of emergency contacts. Relationship |
WFM→HFP HFP→WFM |
Optional to import |
|
Other Info.Emergency Contacts. Phone |
Emergency.List of emergency contacts. Phone |
WFM→HFP HFP→WFM |
Optional to import |
|
Other Info.Emergency Contacts. |
Emergency.List of emergency contacts. |
WFM→HFP HFP→WFM |
Optional to import |
Address
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
|
Personal Details.Address. Country |
Personal.Personal. Country* |
WFM→HFP HFP→WFM |
Character limit: 50 |
|
Personal Details.Address. Post Code |
Personal.Personal. Postcode* |
WFM→HFP HFP→WFM |
Character limit: 10 |
|
Personal Details.Address. State |
Personal.Personal. State / Region* |
WFM→HFP HFP→WFM |
Character limit: 50 |
|
Personal Details.Address. Address 1 |
Personal.Personal. Address Line 1* |
WFM→HFP HFP→WFM |
Character limit: 50 |
|
Personal Details.Address. Address 2 |
Personal.Personal. Address Line 2 |
WFM→HFP HFP→WFM |
Character limit: 50 |
|
Personal Details.Address. Suburb |
Personal.Personal. Suburb / City or Town* |
WFM→HFP HFP→WFM |
Character limit: 50 |
Payroll Export
The Payroll Export defines how timesheet and pay element data from Humanforce WFM maps to fields in Humanforce Payroll through the Timesheet Upload API. Once configured, this ensures award-interpreted timesheet data flows accurately from WFM into Payroll.
For more information on the payroll export see: Upload timesheets from Humanforce WFM to Humanforce Payroll.
Integration method
Data is transferred from WFM to Payroll via the Humanforce Payroll Timesheet Upload API.
Endpoint: /api/timesheet
Method: POST
This API accepts JSON or CSV-formatted payloads containing employee timesheet data, pay elements, and cost centre information.
Supported fields
| Humanforce Payroll field | Important notes |
|---|---|
| Payroll Name* |
Must match a valid Payroll configured in Payroll. Character limit: 50 |
| Employee Number* |
Must match the Employee Number in Payroll (WFM uses Payroll Code). Character limit: 10 |
| Pay Element Description* |
Must match a valid Pay Element in Payroll. Character limit: 50 |
| Hours/Qty |
Required for worked or leave hours. Numeric |
| Date From / Date To |
Mandatory for leave-type pay elements. Date |
| Amount |
Required for variable payments. Numeric |
| Percentage |
Optional; used for super or custom percentage-based elements. Numeric |
| Cost Centre |
Must match a valid cost centre in Payroll if supplied. Character limit: 30 |
| Rate Amount |
Overrides the employee’s standard rate. Cannot be combined with Rate Set. Numeric |
| Rate Set Description |
Overrides the rate by name. Cannot be combined with Rate Amount. Must match a valid Rate Set in Payroll. Character limit: 50 |
| LSL Average Hours Per Week |
Applies to AU/NZ customers. Required for LSL conversions if configured. Numeric |
Cost Centre Mapping
Cost Centre Mapping (CCM) defines how WFM exports worked hours and allowances to the correct cost centres in Humanforce Payroll. You can combine multiple cost centre sources (such as Location, Department, and Role) to build a single cost centre string that Payroll recognises.
Cost centre sources
You can select one or more sources in Integration Central. Each selected field contributes to the final cost centre string.
Available sources include:
- Area ExportCode / Area Name
- Department ExportCode / Department Name
- Event Export Code
- Location ExportCode / Location Name
- Location / Department / Role ExportCode or Name - Combines all three levels into one string.
- Role ExportCode / Role Name
- Custom Cost Centre Mapping - Reserved for custom or advanced configurations.
Tips:
- You can select multiple sources to build a hierarchy (for example: Location / Department / Role).
- The order of sources defines how the cost centre string is created. Drag and drop to change the order.
- You can enter a Default Value for any source to use if no valid value exists.
- If no valid or default value can be found, no cost centre string is generated.
Separators
Separators define how each selected value is joined in the final cost centre string.
Choose the separator that matches your Payroll format:
- Backslash (\)
- Comma (,)
- Dot (.)
- Hyphen (-)
- No space
- Slash (/)
- Space ( )
- Vertical bar (|)
If no separator is selected, Slash (/) is used by default.
Employee Leave Balances
Employee leave balances sync from Humanforce Payroll → WFM after each payroll finalisation.
This ensures employee entitlements remain accurate across both systems and that balances reflect the most current payroll data.
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
| Shift Type Export Code | Leave Type | HFP → WFM | Codes must match exactly for balances to import. Default import type = Balance. |
| Hours | Entitlement | HFP → WFM |
All entitlements are imported as hours regardless of source unit. Weeks/days converted to hours. |
|
Leave. LSL Average Hours Per Week |
HFP → WFM |
Uses Weeks ↔ Hours |
|
|
Leave. NZ Average Days Per Week |
HFP → WFM |
Uses Weeks ↔ Days |
Conversion logic
Australia (Long Service Leave only)
- Applies when the integration country is set to Australia.
- Converts Long Service Leave between weeks and hours.
- Uses the employee’s
LslAverageHoursPerWeekvalue from Payroll for the calculation. - If this value is missing, the conversion is skipped and a warning appears in the integration log.
New Zealand (All leave types)
- Applies when the integration country is set to New Zealand.
- Converts leave balances between weeks and days.
- Uses the employee’s
NzAverageDaysPerWeekvalue from Payroll. - If this value is missing, the conversion is skipped and a warning appears in the integration log.
Configuration dependencies
- The Employee Leave Balances option must be enabled in the Payroll integration task for data to sync.
- The Shift Type Export Code in WFM must align with the Payroll Leave Type description.
- For AU customers, Import Long Service Leave as hours enables conversion from weeks to hours.
- For NZ customers, Convert leave from days to weeks applies during export to Payroll.
- Long Service Leave exports respect the Upload Long Service Leave as weeks setting if enabled.
- Balances are revalidated on each integration run; discrepancies trigger log warnings.
Payslips
Payslip data syncs from Humanforce Payroll → WFM after each payroll finalisation. This allows employees to access their payslips directly in WFM once payroll has been processed and approved.
| Humanforce WFM field | Humanforce Payroll field | Integration direction | Important notes |
|---|---|---|---|
| Payroll Code | Employee Number | HFP → WFM |
Codes must match exactly across systems for payslips to import successfully. Used to request payslips from Payroll. |
| First Name / Last Name | First Name / Last Name | HFP → WFM |
If a payslip already exists for that employee and period, it is skipped to avoid duplication. Matched to verify employee identity. |
| Payroll date / Pay Period | Period Dates | HFP → WFM |
If no date is selected, WFM imports payslips for the previous pay period by default. The field clears automatically after import, preparing the integration for the next period. Determines which pay period’s payslips to import. |
Configuration dependencies
- The Employee Pay Slips option must be enabled in Integration Central for payslips to sync.
- The Payroll Code in WFM must match the Employee Number in Payroll.
- Payslip import occurs only after payroll has been finalised in Payroll.
- The Pay Period Dates between WFM and Payroll must align for import to succeed.
- If the selected date is later than the open pay period in Payroll, that import is skipped (no log entry created).
- Payslips already imported for a specific period are automatically excluded from future runs.
Additional information
-
Related guides
- Learn what the integration does – See the Overview: Humanforce WFM ↔ Payroll integration.
- Set up the integration – See the Setup guide for step-by-step instructions on enabling and configuring the integration.
- Troubleshoot issues – Visit the Known issues guide to review current limitations and workarounds.