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 our clients in New Zealand to sync their employee data between Citation HR Software and iPayroll through integration Hub (iHUB). Our integration will sync employee’s personal, employment, payroll, bank, Kiwisaver and tax data from enableHR/HRA to iPayroll.

The below are the pre-requisites to enable integration between both the systems.

  • Setup account in Citation HR Software
  • Setup account in iPayroll
  • Preparation of data
  • Customer have to sign the "Use of enableHR API and Other Integration Services" authorisation form to allow iPayroll to access the unmasked IRD details. Please reach to  api@enablehr.com for further details.

Is it a 2-way integration?

Its a one-way integration that sends data from Citation HR Software to iPayroll. See the notes below for the mapped fields and limitations

Is there a fee to use the integration?

The Citation HR Software 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. 

 

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.  

Our Customer Support Team will then guide you through the steps you need to complete to prepare your account and setup the integration with iPayroll. 

NOTE: Your employee data must be accurate prior to turning on the integration.

Once your integration is set up, your Account Admins can manage the integration by themselves to setup the connection, run/schedule job and to view the details of the data synced from enableHR to iPayroll. 

 

Is there anything this integration cannot 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/HRA, so this information can’t be synced with iPayroll.
  • Exempting Kiwisaver for Casuals can’t be easily identified in enableHR/HRA.
  • Age range for Kiwisaver is not captured in enableHR/HRA, so this information is not synced with iPayroll.

Field Mapping:

* Mandatory fields necessary to create an employee in iPayroll

enableHR/HRA 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/HRA → iPayroll

Male → Male

Female → Female

Non Binary → Intersex/Indeterminate

Not Stated → Not Stated

Pay Schedule* Pay Frequency

enableHR/HRA → 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  
IRD Number* IRD Number  
Tax Code Tax Code

enableHR/HRA → 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/HRA use ‘None’ in iPayroll

Student Loan % Special Student Loan  
KiwiSaver Status KiwiSaver Status

enableHR/HRA → 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  
Opt Out Date Opt Out Date

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

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/HRA.

Mandatory Date on which the KiwiSaver savings suspension will end

Street Address Address Line 1 Personal address from enableHR/HRA 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 our Customer Services Team

Related to