Select your platform and then browse by platform category

Who are you and what section are you in?

Bulk-import employees via CSV file

Available for the following plans: Employment Plus, Employment Unlimited
Available for the following HR classic plans: Premium, Platinum
Available for the following user access level: Admin

Updating your employee records individually is a very time-consuming process, which is why a CSV bulk uploading feature is essential.

This article explains how to use the Import Employees feature. This lets you choose from a pre-prepared template or your own CSV file and then bulk upload the data to your Employment Hero platform. It also includes a field mapping product so you can customise the location of specific data fields in your CSV file. Currently, you cannot use the Bulk Import feature to update Account Emails. This is due to the Account Email being used to map the changes in the CSV File to the correlating HR File.

Warning

  • Please save a copy of the exported template from your platform when downloading existing data to edit. This way, in case of a mistake, you can re-upload the file containing the information you had before editing. The platform cannot revert to old data after a CSV upload has been done, so it is important to have a backup of your original existing data.
  • Mandatory fields (marked with an asterisk [*]) cannot be removed or left blank. In all the downloadable spreadsheets, please do not remove or leave blank the following: First name, Last name, Account email, and Location.

  Interactive learning

Click here for an interactive demo

Getting started

Upload a CSV file

Important

Within your CSV file, address details, such as street address and country, will need to be grouped together for a successful import.

Warning

Please do not delete any of the columns in your CSV file. If you delete or remove columns in your CSV file and upload it into the platform, this will result in clearing some of your data on the platform too. This will lead to errors and affect your records and system.

  1. Click the  People menu.
  2. Click the Import Employees submenu.
  3. Choose the template you need:
    • Update Employee Employment Details.
    • Advanced Import Employees (including pay details).
    • Quick Import Employees.
    • Update Employee Custom Fields.
  4. Choose whether to:
    • Include existing user information.
    • Include terminated users.
  5. Click the Download button.
    screenshot of the import employees screen, highlighting the download button
  6. Enter the required details in the template you downloaded.
  7. Save the changes you made to the file.
  8. To upload the edited file, you can choose to do one of the following actions:

    • Click the Upload tile and select the file; or
    • Drag the file to the Upload tile.

    screenshot of the import employees screen, highlighting the upload tile

  9. Click the Yes button.
    screenshot of the import file popup, highlighting the yes button
  10. Map the columns in the CSV file to the correct fields in the HR platform.
     

    Important

    If the Contract Type column is included in the CSV then it must have one of the available options (Permanent or Fixed Term) filled in. It cannot be left blank.

  11. Click the Continue button.
     

    Helpful Hint

    The platform will show a list of any errors that need to be corrected. Otherwise, you will see the Imported Successfully page, where you can see the number of employee records created or updated.

    You can click the Go to Employee Page button to view them.

    screenshot of the import employees page, showing that the import was successful

Helpful Hint

This will trigger email invitations to new employees that you have just imported, inviting them to create their HR/Employment Hero Work account password in Employment Hero Work app, and begin the onboarding process.

FAQs

How do I get the most out of this feature?

We recommend you use the pre-prepared sample CSV templates available. We have listed some tips on how to best use these templates and guarantee a successful upload of your data below:

  • We recommend adding a personal email in the Account Email column. This means that employees will still be able to log in to access their read-only employee information after they leave your organisation. 
  • Do not use a generic email for your employees, for example, info@company.com
  • If you receive any error messages during your upload, the error message always corresponds to the following row. For example, an error in row one means the error is in row two, and so on. 
  • Fields with an asterisk are mandatory fields, and you must complete these fields.
  • Follow all naming conventions referenced in the column headers of your CSV. For example, if an employee is in multiple teams (such as HR, Admin, and Payroll), you must separate those team names with the following symbol: | (in other words, it should look like this: John Smith HR | Admin | Payroll).
  • In the Update Employee Employment Details csv, Start Dates and Job Titles are interdependent. You can not complete one field without the other. 
  • In the Advanced Import Employees (including Pay Details) csv, Salary and Pay Details effective date are interdependent. You can not complete one field without the other. 
  • Downloading the Advanced Import Employees (including Pay Details) csv removes the leading zeroes from sort codes and account numbers. You must reformat these columns by making the column custom and adding six zeros for sort codes and eight zeros for account numbers.

 

How do I update employee teams and reporting lines?

We recommend you have your employees data in Employment Hero before you assign their teams and managers. You can then use the Update Employment Details template to assign teams and primary/secondary managers to employees in bulk.

What are the mandatory CSV fields/fields I cannot leave blank?
CSV Column Name. Platform Field Location. Notes.
First name. Personal details.  
Last name. Personal details.  
Account email. Personal details.  
Location. Employment details.  
Primary cost centre. Employment details.  
Additional cost centres. Employment details. Separate additional cost centres with a |.
System access date. Employment details.  
Primary manager email. Employment details.  
Salary Pay details: Salary history.  
Salary option Pay details: Salary history.  
Pay schedule. Pay details: Salary history.  
Pay category. Pay details: Salary history.  
Pay details. Pay details: Salary history.  
Leave allowance template. Pay details: Salary history.  

Troubleshooting

General fix for CSV bulk import errors

If you receive general errors when bulk-updating employees via a CSV file, try splitting them into separate files based on key differences (such as employment type). Then, upload each file separately.

For example, if your CSV includes both hourly and salaried employees and you encounter an error, move the hourly employees into a separate file. Upload the salaried employees first, followed by the hourly employees. This helps prevent formatting issues and ensures a smoother update process.

Fix row-specific errors

Important

If an import error occurs in the platform, it will show which row contains the error. However, note that the platform starts counting from the first employee in your CSV file and ignores the heading row.

For example, if the platform reports an error on row 10, look at row 11 in your Excel file to find and fix the issue.

To resolve import errors, follow the below steps:
 

  1. From the platform, re-download the file that had the import error.
  2. Open the downloaded file and fix the errors. (The errors will appear in red text in the Resolve Errors section and will display the row in which the error needs to be resolved.)
    CSV file import errors
  3. Re-upload the corrected CSV file.
Spot common formatting issues
Additional spaces If a cell contains a space at the beginning or end, it can cause an upload error. To prevent this, check for and remove any extra spaces before uploading your file.
Format errors

When copying from Excel to CSV, the format changes. This also changes the data, most often with numbers that have leading zeros, such as BSBs and phone numbers.

You will need to reformat the column to a custom format that includes the zero.

Adding hyphens TFNs and BSBs are the most common to have added hyphens. There should not be hyphens in these sections.
Data missing from columns linked to other columns

When inputting data into certain columns, you will need to fill out others. Examples are the super columns, banking columns, and tax columns.

If you do not have all the data, it is better to delete all these related columns before upload. You can come back instead when you have the data.

Missing column header Ensure every column has a header and that no data exists in a cell without a corresponding header.
Uploading the advanced spreadsheet when Payroll settings are turned off The platform will not allow this action. You need to delete all columns that have disappeared along with payroll settings, and then upload.
Missing surnames Ensure every employee has a surname. If any surnames are missing, either remove those employees from the file or add the missing surnames.
Blank columns If optional columns (e.g., Cost Centre and Primary & Secondary Managers) have no data, delete them from the CSV to prevent errors. Keep only mandatory fields marked with asterisks.
Missing mandatory fields Ensure all mandatory fields (marked with an asterisk) are filled out before uploading. Missing mandatory fields will cause the upload to fail.
Leading zeros appear in dates If leading zeros appear in dates where they are not allowed, revise the formatting rules and remove them.
General errors persist If general errors persist, try uploading a smaller dataset (e.g., a file with only three employees) to manually pinpoint errors before uploading the full list.

Further information

Field locations that support <<clear>> feature

Personal Details

When using the Personal Details platform field location, you can only use the <<clear>> feature in the following columns:

  • Address_Country.
  • Address_Postcode.
  • Address_State.
  • Address_Suburb.
  • Address_line 2
  • Address_line 1.
  • Date of birth [dd/mm/yyyy].
  • Gender [Female | Male | Non-binary | Prefer not to say].
  • Home phone.
  • Marital status [Single | Married | In a Relationship].
  • Middle name.
  • Preferred name.
  • Nationality.
  • Personal mobile number.
  • Preferred name.
  • Title [Mr | Ms | Mrs | Miss | Dr | Mx].
Employment Details

When using the Employment Details platform field location, you can only use the <<clear>> feature in the following columns:

  • Company email.
  • Company landline.
  • Company mobile.
  • Length of probation.
  • Employee code.
  • Primary cost centre.
  • Primary manager email.
  • Secondary manager's email.
  • Team [separate multiple teams with ' | ' e.g. Accounts | Engineering | Sales].
Emergency Contacts

When using the Emergency Contacts platform field location, can only use the <<clear>> feature in the following columns:

  • EmergencyContact1_Name
  • EmergencyContact1_Relationship
  • EmergencyContact1_Phone (daytime)
  • EmergencyContact1_Phone (after hours)
  • EmergencyContact1_Mobile

CSV fields that need to be updated together

Banking Details

If you need to update the bank account details stored on your HR platform in bulk, you will need to update all the following fields together:

  • BankAccount1_AccountName.
  • BankAccount1_AccountNumber.
  • BankAccount1_AllocatedPercentage (Not applicable for Xero payroll).
  • BankAccount1_FixedAmount (Will always hold the remaining balance. Please enter 'Remaining').

You can only have one of the below columns in a row:

  • BankAccount1_AllocatedPercentage (Not applicable for Xero payroll).
  • BankAccount1_FixedAmount (Will always hold the remaining balance. Please enter 'Remaining').
  • Sync with payroll
Employment history

If you need to update the Employment History details stored on your HR platform in bulk, you will need to update all the following fields together:

  • Employment type (Full-time | Part-time | Casual).
  • Job title.
  • Start date (dd/mm/yyyy).
KiwiSaver

If you need to update the KiwiSaver details stored on Employment Hero in bulk, you will need to update all the following fields together:

  • Is KiwiSaver Enrolment Status [Automatically Enrol/Opt In/Savings Suspension/Opt Out/Not Enrolled/Ineligible]
  • KiwiSaver Ineligibility Reason [Not A Citizen Permanent Resident/Not Normally Living In New Zealand/Under 18 Years Of Age]
  • KiwiSaver Employee Contribution [3, 4, 6, 8, 10%]
  • KiwiSaver Employer Contribution %
  • KiwiSaver Opt Out Date [dd/mm/yyyy]
  • KiwiSaver Savings Suspension From Date [dd/mm/yyyy]
  • KiwiSaver Savings Suspension To Date [dd/mm/yyyy]
Pay details

If you need to update the Pay details stored on Employment Hero in bulk, you will need to update all the following fields together:

  • Salary.
  • Salary option (Annum | Month | Fortnight | Hour | Day).

You will need to enter data into the CSV column 'Pay details - Effective from' if you update any of the of the following columns:

  • Salary.
  • Salary option (Annum | Month | Fortnight | Hour | Day).
  • Override template rate.
  • Pay schedule.
  • Pay category.
  • Leave allowance template.
  • Kiwisaver (%).

Which data fields are in each downloadable CSV file?

Which fields are in the 'Update Employee Employment Details' spreadsheet?
  • Type [Employee | Contractor]
  • First name [*]
  • Last name [*]
  • Account email [*]
  • Employing entity
  • Employee code
  • Location [*]
  • Primary cost centre
  • Additional cost centres [separate additional cost centres with '|']
  • Employment type [Full-time | Part-time | Casual]
  • Job title Group [separate multiple groups with '|']
  • Primary manager email
  • Secondary manager email
  • Start date [dd/mm/yyyy]
  • System access date [dd/mm/yyyy]
  • Termination date [dd/mm/yyyy]
  • Termination type
  • Termination Comment
  • Length of probation
  • Company email
  • Company mobile
  • Company landline
  • Home Country [if Income Type = working_holiday_makers. e.g. GB, IE, FR]
  • Income Type [salary_and_wages | closely_held_payees | working_holiday_makers]
Which fields are in the 'Update Employee Payee Details (Xero, MYOB)' spreadsheet?
  • First name [*]
  • Last name [*]
  • Account email [*]
  • Employing entity
  • Synchronise with payroll
  • Hours/days per week
  • Pay Normal Working Hours By Default [Yes | No]
  • Anniversary date [dd/mm/yyyy]
  • Salary
  • Salary option
  • KiwiSaver [%]
  • Pay schedule
  • Pay category
  • Pay details - Effective from [dd/mm/yyyy]
  • Ordinary work hours
  • Timesheets [Enabled | Disabled | EnabledForExceptions]
  • Location [*]
Which fields are in the 'Update User Pay Details (Employment Hero Payroll, KeyPay, Quickbooks Online)' spreadsheet?
  • First name [*]
  • Last name [*]
  • Account email [*]
  • Employing entity
  • Synchronise with payroll [Yes | No]
  • Hours/days per week
  • Pay Normal Working Hours By Default [Yes | No]
  • Industrial instrument
  • Classification
  • Pay rate template
  • Anniversary date [dd/mm/yyyy]
  • Currency
  • Salary
  • Salary option [Annum | Month | Fortnight | Hour]
  • Override template rate [Yes | No]
  • KiwiSaver [%]
  • Pay schedule
  • Pay category
  • Pay details - Effective from [dd/mm/yyyy]
  • Leave allowance template
  • Ordinary work hours
  • Timesheets [Enabled | Disabled | EnabledForExceptions]
  • Location [*]
  • Home Country [if Income Type = working_holiday_makers. e.g. GB, IE, FR]
  • Income Type [salary_and_wages | closely_held_payees | working_holiday_makers]
Which fields are in the 'Advanced Import Employees (including pay details)' spreadsheet?
  • Type [Employee | Contractor]
  • Title [Mr | Ms | Mrs | Miss | Dr | Mx]
  • First name [*]
  • Last name [*]
  • Middle name
  • Preferred name
  • Gender [Female | Male | Non-binary | Prefer not to say]
  • Employee address line 1
  • Employee address line 2
  • Employee address suburb
  • Employee address postcode
  • Employee address state
  • Employee address country
  • Trading name
  • Nationality
  • Date of birth [dd/mm/yyyy]
  • ABN
  • Marital status [Single | Married | In a Relationship | Prefer not to say]
  • Account email [*]
  • Employing entity
  • Personal mobile number
  • Home phone
  • Employee code
  • Location [*]
  • Primary cost centre
  • Additional cost centres [separate additional cost centres with '|']
  • Employment type [Full-time | Part-time | Casual]
  • Job title
  • Actual weekly hours/days
  • Pay Normal Working Hours By Default [Yes | No]
  • Group [separate multiple groups with '|']
  • Industrial instrument
  • Classification
  • Pay rate template
  • Anniversary date [dd/mm/yyyy]
  • Currency
  • Salary
  • Salary option [Annum | Month | Fortnight | Hour]
  • Override template rate [Yes | No]
  • KiwiSaver [%]
  • Pay schedule
  • Pay category
  • Pay details - Effective from [dd/mm/yyyy]
  • Leave allowance template
  • Ordinary work hours
  • Timesheets [Enabled | Disabled | EnabledForExceptions]
  • Primary manager email
  • Secondary manager email
  • Start date [dd/mm/yyyy]
  • System access date [dd/mm/yyyy]
  • Termination date [dd/mm/yyyy]
  • Termination type
  • Termination Comment
  • Length of probation
  • Company email
  • Company mobile
  • Company landline
  • Bank Account 1 Statement Text
  • Bank Account 1 Account Name
  • Bank Account 1 Account BSB
  • Bank Account 1 Account Number
  • Bank Account 1 Allocated Percentage
  • Bank Account 1 Fixed Amount
  • Bank Account 2 Statement Text
  • Bank Account 2 Account Name
  • Bank Account 2 Account BSB
  • Bank Account 2 Account Number
  • Bank Account 2 Allocated Percentage
  • Bank Account 2 Fixed Amount
  • Bank Account 3 Statement Text
  • Bank Account 3 Account Name
  • Bank Account 3 Account BSB
  • Bank Account 3 Account Number
  • Bank Account 3 Allocated Percentage
  • Bank Account 3 Fixed Amount
  • Super Choice [Regulated | SMSF | Company nominated]
  • Super Fund Name
  • Super Fund ABN
  • SPIN/USI
  • ESA
  • Super Member Number
  • Super Account Name
  • SMSF Account Name
  • SMSF BSB
  • SMSF Account Number
  • Emergency Contact 1 Name
  • Emergency Contact 1 Relationship
  • Emergency Contact 1 Phone (daytime)
  • Emergency Contact 1 Phone (after hours)
  • Emergency Contact 1 Mobile
  • Emergency Contact 1 Contact Type
  • Tax File number
  • Tax Resident [Yes | No | WHM]
  • Tax Free Threshold [Yes | No]
  • Tax Help Debt [Yes | No]
  • Tax Financial Supplement Debt [Yes | No]
  • Home Country [if Income Type = working_holiday_makers. e.g. GB, IE, FR]
  • Income Type [salary_and_wages | closely_held_payees | working_holiday_makers]
  • Synchronise with payroll [Yes | No]
  • Passport Expiry Date
  • Work Pass Type [Visitor Pass | Professional Visitor Pass | Employment Pass | Student Pass | Residence Pass | Long Term Social Visit Pass | Others]
Which fields are in the 'Quick Import Employees' spreadsheet?
  • First name [*]
  • Last name [*]
  • Account email [*]
  • Employing entity
  • Location [*]
Which fields are in the 'Update Employee Additional Information' spreadsheet?
  • First name [*]
  • Last name [*]
  • Account email [*]
  • Employing entity
  • Location [*]
Which fields are in the 'Update Employee Custom Work Hours' spreadsheet?
  • First name [*]
  • Last name [*]
  • Account email [*]
  • Employing entity
  • Format [Standard daily | Custom Time | Custom Hours]
  • Custom weeks [1 | 2]
  • Ordinary work day
  • Allowed work sites/positions
  • Sun 1 work site
  • Sun 1 position
  • Sun 1 start time
  • Sun 1 end time
  • Sun 1 break start time
  • Sun 1 break end time
  • Sun 1 hours
  • Mon 1 work site
  • Mon 1 position
  • Mon 1 start time
  • Mon 1 end time
  • Mon 1 break start time
  • Mon 1 break end time
  • Mon 1 hours
  • Tue 1 work site
  • Tue 1 position
  • Tue 1 start time
  • Tue 1 end time
  • Tue 1 break start time
  • Tue 1 break end time
  • Tue 1 hours
  • Wed 1 work site
  • Wed 1 position
  • Wed 1 start time
  • Wed 1 end time
  • Wed 1 break start time
  • Wed 1 break end time
  • Wed 1 hours
  • Thu 1 work site
  • Thu 1 position
  • Thu 1 start time
  • Thu 1 end time
  • Thu 1 break start time
  • Thu 1 break end time
  • Thu 1 hours
  • Fri 1 work site
  • Fri 1 position
  • Fri 1 start time
  • Fri 1 end time
  • Fri 1 break start time
  • Fri 1 break end time
  • Fri 1 hours
  • Sat 1 work site
  • Sat 1 position
  • Sat 1 start time
  • Sat 1 end time
  • Sat 1 break start time
  • Sat 1 break end time
  • Sat 1 hours
  • Sun 2 work site
  • Sun 2 position
  • Sun 2 start time
  • Sun 2 end time
  • Sun 2 break start time
  • Sun 2 break end time
  • Sun 2 hours
  • Mon 2 work site
  • Mon 2 position
  • Mon 2 start time
  • Mon 2 end time
  • Mon 2 break start time
  • Mon 2 break end time
  • Mon 2 hours
  • Tue 2 work site
  • Tue 2 position
  • Tue 2 start time
  • Tue 2 end time
  • Tue 2 break start time
  • Tue 2 break end time
  • Tue 2 hours
  • Wed 2 work site
  • Wed 2 position
  • Wed 2 start time
  • Wed 2 end time
  • Wed 2 break start time
  • Wed 2 break end time
  • Wed 2 hours
  • Thu 2 work site
  • Thu 2 position
  • Thu 2 start time
  • Thu 2 end time
  • Thu 2 break start time
  • Thu 2 break end time
  • Thu 2 hours
  • Fri 2 work site
  • Fri 2 position
  • Fri 2 start time
  • Fri 2 end time
  • Fri 2 break start time
  • Fri 2 break end time
  • Fri 2 hours
  • Sat 2 work site
  • Sat 2 position
  • Sat 2 start time
  • Sat 2 end time
  • Sat 2 break start time
  • Sat 2 break end time
  • Sat 2 hours

Explore related content

Was this article helpful?
4 out of 20 found this helpful