Search

Integration: iPayroll

Overview

iPayroll is a proven cloud-based payroll solution developed in New Zealand, for New Zealand businesses of all sizes.

The integration allows enableHR clients in New Zealand to sync their employee data between enableHR and iPayroll through integration Hub (iHUB). Our integration will sync employee’s personal, employment, payroll, bank, Kiwisaver and tax data from enableHR to iPayroll.

 

FAQs

Is it a 2-way integration?

Its a one-way integration that sends data from enableHR to iPayroll. See the Field Mapping section below for the mapped fields and limitations

Is there a fee to use the integration?

The enableHR Customer Services Team will advise you on any costs based on your subscription. 

Is it automated?

Once the integration is setup and the connector job is scheduled the integration happens automatically at set intervals. If there is a need to sync the data outside of scheduled run, you can run the integration job manually to immediately sync the data between both the systems. 

What are the pre-requisites for the integration between enableHR and iPayroll?

  • Setup account in enableHR
  • Setup account in iPayroll
  • Preparation of data
  • Acceptance of the "Use of enableHR API and Other Integration Services" authorisation form to allow iPayroll to access the unmasked IRD details from enableHR. Please email api@enablehr.com for further details.

What can't the integration support?

  • Employee’s with only one bank account in enableHR/HRA can be synced with iPayroll

  • Terminations (Finish Date and Termination Reason in iPayroll) are not added/updated through this connector. 

  • Special Earner Levy is not captured in enableHR, so this information can’t be syced with iPayroll.

  • Exempting Kiwisaver for Casuals can’t be easily identified in enableHR.

  • Age range for Kiwisaver is not captured in enableHR , so this information is not synced with iPayroll.

 

Preparing your data for the integration

Note: To import payroll data, you will need the User Access Role 'Payroll Tab'

If you are new to enableHR and you already use iPayroll

  1. Contact either the enableHR Support Team or your Customer Services Consultant to let them know you are preparing for the the iPayroll integration. 
  2. Read this article in full to ensure you know how the integration works, what the limitations are and what data fields are mapped between enableHR and iPayroll.
  3. Contact the iPayroll Helpdesk to request an extract of your employee and payroll data. The iPayroll help desk team will generate a file with the fields needed for our importers and place this in your iPayroll portal under: Reports > Company Documents
  4. Using the data from your iPayroll extract, you need to complete two of our excel templates to import your employee records and payroll data.
    - Complete and upload the Importer: Employee Details first.
    - Complete and upload the Importer: Payroll Details (NZ). (You will need to enter the employee's Internal ID into this importer, you can export this from enableHR using the Record Export CSV report).
  5. In iPayroll, you need to disable modification features in the iPayroll Kiosk, this will ensure that your employees can not update their personal details in iPayroll. Going forward, they will update their personal and banking details in eSS and the data changes will flow through to iPayroll through the integration.
    In iPayroll and go to Setup > Organisation > Click into the defaults tab. On the page, scroll down to the kiosk section and uncheck 'Allow Kiosk Users to update Personal Details’ and save the page.
  6. Contact either the enableHR Support Team or your Customer Services Consultant to let them know you have finished preparing your data and you are ready to initiate the integration with iPayroll.

If you are an existing enableHR and iPayroll customer, setting up the integration for the first time

IMPORTANT: Prior to turning on the integration, you need to ensure your employee and payroll data in enableHR and iPayroll match EXACTLY. When the integration is turned on, enableHR will overwrite any data in iPayroll that is different to the data in enableHR.

  1. Contact either the enableHR Support Team or your Customer Services Consultant to let them know you are preparing for the the iPayroll integration and that you are an existing customer of iPayroll. 
  2. Read this article in full to ensure you know how the integration works, what the limitations are and what data fields are mapped between enableHR and iPayroll.
  3. To assist you with reviewing and comparing your data in enableHR and iPayroll, you can use enableHR's Record CSV Export Report. You can contact the iPayroll Helpdesk to request an extract of your iPayroll data. In case you need to update anything, the iPayroll help desk team will generate a file with the fields needed for our employee importer and place this under the location: Reports > Company Documents on their iPayroll portal.
  4. If you need to enter your payroll data into enableHR, use the data from your iPayroll extract to complete our payroll details importer prior to turning on the integration. You will also need to enter the employee's Internal ID which you can obtain from our Record Export CSV.
  5. In iPayroll, you need to disable modification features in the iPayroll Kiosk, this will ensure that your employees can not update their personal details in iPayroll. Going forward, they will update their personal and banking details in eSS and the data changes will flow through to iPayroll through the integration.
    In iPayroll and go to Setup > Organisation > Click into the defaults tab. On the page, scroll down to the kiosk section and uncheck 'Allow Kiosk Users to update Personal Details’ and save the page.
  6. Contact either the enableHR Support Team or your Customer Services Consultant to let them know you have finished preparing your data and you are ready to initiate the integration with iPayroll.

If you are an existing enableHR customer and a new iPayroll customer

  1. Contact either the enableHR Support Team or your Customer Services Consultant to let them know you are preparing for the the iPayroll integration and that you are an existing customer of iPayroll. 
  2. Read this article in full to ensure you know how the integration works, what the limitations are and what data fields are mapped between enableHR and iPayroll.
  3. If you need to enter your payroll data into enableHR, complete our payroll details importer prior to turning on the integration. You will also need to enter the employee's Internal ID which you can obtain from our Record Export CSV.
  4. In iPayroll, you need to disable modification features in the iPayroll Kiosk, this will ensure that your employees can not update their personal details in iPayroll. Going forward, they will update their personal and banking details in eSS and the data changes will flow through to iPayroll through the integration.
    In iPayroll and go to Setup > Organisation > Click into the defaults tab. On the page, scroll down to the kiosk section and uncheck 'Allow Kiosk Users to update Personal Details’ and save the page.
  5. Contact either the enableHR Support Team or your Customer Services Consultant to let them know you have finished preparing your data and you are ready to initiate the integration with iPayroll.

 

How to setup the integration

The integration is setup through our Integration Hub (iHUB). You will need to contact our Customer Support Team to help get you setup on iHub.

NOTE: Your employee data must be accurate prior to turning on the integration. Ensure that you have completed the relevant steps for your scenario under Preparing your data for the integration.

Once your integration is set up, you can manage the integration yourselves through iHub. 

 

Field Mapping

* Mandatory fields necessary to create an employee in iPayroll

enableHR Field

iPayroll Field

Notes
First Name* First Names (S)  
Last Name* Sur Name  
Preferred Name Preferred Name  
Date of Birth* Date of Birth  
Email Email Address

1st preference Work email address

2nd preference Personal email (when work email doesn’t exist)
Hours Per Week* F.T Hrs/Week  
Gender* Gender

EnableHR → iPayroll

Male → Male

Female → Female

Non Binary → Intersex/Indeterminate

Not Stated → Not Stated
Pay Schedule* Pay Frequency

EnableHR → iPayroll

Weekly → W

Fortnightly → F

Monthly → M

Twice_Monthly → B
Mobile Phone Phone Number  
Commencement Date* Start Date  
Branch* State Employee’s Home Branch’s setup → Contact → State is used 
Position Title Job Title  
Account Number* Bank Account

xx-xxxx-xxxxxxx-xxx

BSB (6 digits)

Account No. (7 digits)

Suffix (3 digits)

dashes should be included
IRD Number* IRD Number  
Tax Code Tax Code

enableHR → iPayroll

CAE → CAE

M → M

M SL → M_SL

ME → ME

ME SL → ME_SL

ND → ND

NSW → NSW

S → S

S SL → S_SL

SA → SA

SA SL → SA_SL

SB → SB

SB SL → SB_SL

SH → SH

SH SL → SH_SL

ST → ST

ST SL → ST_SL

STC → STC

WT → WT

When No tax code details exists in enableHR use ‘None’ in iPayroll
Student Loan % Special Student Loan  
KiwiSaver Status KiwiSaver Status

enableHR → iPayroll

Active → Pre-existing member ( kiwiSaverRate, employerSubsidy, esctRate are Mandatory)

Opt-Out → Opted Out (kiwiSaverOptOutDate, addressLine1, city and postCode are mandatory)

Savings Suspension → Saving Suspension IRD Approved with Employer Contribution (kiwisaverHolidayEndDate and employerSubsidy is mandatory)

Not a Member → Not Eligible (kiwiSaverRate & employerSubsidy must be 0.00)
Employee Contribution % KiwiSaver Employee Rate  
Employer Contribution % Employer Subsidy  
Employer Contribution Tax (ESCT%) ESCT Rate

Valid options:

10.5%

17.5%

30.0%

33.0%
Opt Out Date Opt Out Date

Status = Opt-out and Opt Out Date from enableHR.

Mandatory if kiwiSaverStatus is Opted Out Address Line 1, City and Post Code are mandatory if an Opt Out Date exists
Suspension End Date Suspension End Date

KiwiSaver Status = Savings Suspension and Suspension End date from enableHR.

Mandatory Date on which the KiwiSaver savings suspension will end
Street Address Address Line 1 Personal address from enableHR is first preference, if not exists use the mailing/postal address.
Street Address Address Line 2  
suburb suburb  
State State  
Post Code Post Code  
     

* = Required Fields

 

I have an issue and an employee record is not syncing, who do I contact?

You can view the integration details and any data synchronisation issues under the 'Reports' section in iHUB.

If you are unable to resolve the issue, your first point of contact for assistance is enableHR's Customer Services Team. 

Related to