Skip to docs navigation

iPayroll integration guide

Verified

How to connect iPayroll to WEXTL and use its 1 trigger and 17 actions in your workflows. About iPayroll: Manage employees, cost centres, superannuation and custom fields in iPayroll, the cloud payroll and HR software.

  • 1 trigger
  • 10 searches
  • 7 actions
  • Polling
  • Auth: OAuth

AI-assisted documentation10 min read

This documentation is compiled from our integration source code, internal specs for iPayroll, its official API documentation and anonymized requests logs we collect from our support team[2].

Open iPayroll on WEXTL →
  • iPayroll
  • WEXTL
  • DailyPay
  • Cezanne HR
  • BrightHR
  • Breezy HR
  • Ceipal
  • Beamery
  • Aladtec
  • Achievers
  • Bullhorn
  • 7Shifts
  • Deel
  • Dayforce
  • Combo HR
  • Darwinbox
  • Breathe HR
  • BrioHR
  • Calamari
  • Charlie HR
  • ClockIt
  • ClickTime
  • Assembled
  • BuddyPunch
  • Base.vn
  • Clockify
  • actiTIME
  • Affinda
  • BambooHR
  • Ashby
  • Connecteam
  • CATS

You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.

  • EnvironmentselectRequired

    Which iPayroll / CloudPayroll environment to connect to.[1]

  • Client IDtextRequired

    The Client ID of your OAuth2 application. Obtain credentials by applying for an iPayroll developer account (Developer Account Application form) and completing the Annual Security Questionnaire. Email api@ipayroll.co.nz or api@cloudpayroll.com.au.[1]

  • Client SecretpasswordRequired

    The Client Secret of your OAuth2 application, issued with the Client ID when iPayroll approves your developer/application account (api@ipayroll.co.nz / api@cloudpayroll.com.au).[1]

Integration requests 3 permissions:

  • Cost Centres
  • Custom Fields
  • Employees
  1. Log in to your WEXTL account, add the iPayroll node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your iPayroll account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Cost Centres

TriggerPolls for new cost centres and emits each.
Output fields[3]
FieldType
IDnumber
Codetext
Descriptiontext
Display Valuetext
Activeboolean
Linksarray
Reltext
Hrefurl

Get a Cost Centre

ActionReads a single iPayroll cost centre.
Input fields[3]
FieldType
Cost Centre IDRequired
choice
Output fields[3]
FieldType
IDnumber
Codetext
Descriptiontext
Display Valuetext
Activeboolean
Linksarray
Reltext
Hrefurl

Get a Custom Field

ActionA single employee custom field from one category.
Input fields[3]
FieldType
Employee IDRequired
choice
Category IDRequired
number
Custom Field IDRequired
number
Output fields[3]
FieldType
IDtext
Categorynumber
Category Nametext
Custom Field IDnumber
Nametext
Datedate
Descriptiontext
Contacttext
Contact Detailstext
Relationshiptext
Phone Numbertext
Emailemail
Addresstext
Contract Hoursnumber
Period Daysnumber
Contract Endtext
FTEnumber
Hay Pointsnumber
Hay Profilenumber
Hays Profilenumber

8other output fields

Get a Superannuation Record

ActionOne superannuation entry held for an employee.
Input fields[3]
FieldType
Employee IDRequired
choice
Output fields[3]
FieldType
IDtext
Amountnumber
Quantitynumber
Cost Centretext
Pay Elementtext
Super Fund Identifiertext
Superann Member Numbertext
Linksarray
Reltext
Hrefurl

Get an Employee

ActionPersonal and pay details for one employee.
Input fields[3]
FieldType
Employee IDRequired
choice
Output fields[3]
FieldType
IDtext
Organisationnumber
Surnametext
First Namestext
Preferred Nametext
Titletext
Emailemail
Phonetext
Birth Datetext
Start Datetext
Finish Datetext
Full Time Hours Weeknumber
Gendertext
Pay Frequencytext
Payment Methodtext
Bank Account Numbertext
Tax Numbertext
Default Cost Centretext
User Defined Grouptext
Addressobject
Address Line 1text
Address Line 2text
Suburbtext
Statetext
Citytext
Post Codetext
Countrytext

54other output fields

Get Cost Centres

SearchCost centres with their codes and descriptions.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDnumber
Codetext
Descriptiontext
Display Valuetext
Activeboolean
Linksarray
Reltext
Hrefurl

Get Employee Custom Fields

SearchCustom field values recorded against an employee.
Input fields[3]
FieldType
Employee IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Categorynumber
Category Nametext
Custom Field IDnumber
Nametext
Datedate
Descriptiontext
Contacttext
Contact Detailstext
Relationshiptext
Phone Numbertext
Emailemail
Addresstext
Contract Hoursnumber
Period Daysnumber
Contract Endtext
FTEnumber
Hay Pointsnumber
Hay Profilenumber
Hays Profilenumber

8other output fields

Get Employee Custom Fields By Category

SearchOnly the fields recorded under a chosen category.
Input fields[3]
FieldType
Employee IDRequired
choice
Category IDRequired
number
Limitnumber
Output fields[3]
FieldType
IDtext
Categorynumber
Category Nametext
Custom Field IDnumber
Nametext
Datedate
Descriptiontext
Contacttext
Contact Detailstext
Relationshiptext
Phone Numbertext
Emailemail
Addresstext
Contract Hoursnumber
Period Daysnumber
Contract Endtext
FTEnumber
Hay Pointsnumber
Hay Profilenumber
Hays Profilenumber

8other output fields

Get Employees

SearchEmployee list of your iPayroll organisation.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Organisationnumber
Surnametext
First Namestext
Preferred Nametext
Titletext
Emailemail
Phonetext
Birth Datetext
Start Datetext
Finish Datetext
Full Time Hours Weeknumber
Gendertext
Pay Frequencytext
Payment Methodtext
Bank Account Numbertext
Tax Numbertext
Default Cost Centretext
User Defined Grouptext
Addressobject
Address Line 1text
Address Line 2text
Suburbtext
Statetext
Citytext
Post Codetext
Countrytext

54other output fields

Get Superannuation Records

SearchSuperannuation entries for a single employee.
Input fields[3]
FieldType
Employee IDRequired
choice
Limitnumber
Output fields[3]
FieldType
IDtext
Amountnumber
Quantitynumber
Cost Centretext
Pay Elementtext
Super Fund Identifiertext
Superann Member Numbertext
Linksarray
Reltext
Hrefurl

Search Custom Fields

SearchFinds custom fields by category or field.
Input fields[3]
FieldType
Employee IDchoice
Category IDnumber
Category Nametext
Custom Field IDnumber
Custom Field Nametext
Limitnumber
Output fields[3]
FieldType
IDtext
Categorynumber
Category Nametext
Custom Field IDnumber
Nametext
Datedate
Descriptiontext
Contacttext
Contact Detailstext
Relationshiptext
Phone Numbertext
Emailemail
Addresstext
Contract Hoursnumber
Period Daysnumber
Contract Endtext
FTEnumber
Hay Pointsnumber
Hay Profilenumber
Hays Profilenumber

8other output fields

Create a Superannuation Record

ActionCreates superannuation for one employee from a pay element and quantity.
Input fields[3]
FieldType
Employee IDRequired
choice
Pay ElementRequired
text
QuantityRequired
number
Amountnumber
Cost Centretext
Superann Member Numbertext
Super Fund Identifiertext
Output fields[3]
FieldType
IDtext
Amountnumber
Quantitynumber
Cost Centretext
Pay Elementtext
Super Fund Identifiertext
Superann Member Numbertext
Linksarray
Reltext
Hrefurl

Create Cost Centres

ActionCreates cost centres from codes and descriptions.
Input fields[3]
FieldType
Cost CentresRequired
array
CodeRequired
text
DescriptionRequired
text
Output fields[3]
FieldType
IDnumber
Codetext
Descriptiontext
Display Valuetext
Activeboolean
Linksarray
Reltext
Hrefurl

Create Employees

ActionAdds employees with their pay, bank and tax details.
Input fields[3]
FieldType
EmployeesRequired
array
Employee IDtext
SurnameRequired
text
First NamesRequired
text
Preferred Nametext
Titletext
Emailemail
Phonetext
Birth Datetext
Start DateRequired
text
Finish Datetext
Output fields[3]
FieldType
IDtext
Organisationnumber
Surnametext
First Namestext
Preferred Nametext
Titletext
Emailemail
Phonetext
Birth Datetext
Start Datetext
Finish Datetext
Full Time Hours Weeknumber
Gendertext
Pay Frequencytext
Payment Methodtext
Bank Account Numbertext
Tax Numbertext
Default Cost Centretext
User Defined Grouptext
Addressobject
Address Line 1text
Address Line 2text
Suburbtext
Statetext
Citytext
Post Codetext
Countrytext

54other output fields

Delete a Superannuation Record

ActionRemoves the superannuation of one employee.
Input fields[3]
FieldType
Employee IDRequired
choice

Make an API Call

universalFree-form iPayroll REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Update a Superannuation Record

ActionEdits one superannuation record of an employee.
Input fields[3]
FieldType
Employee IDRequired
choice
Pay ElementRequired
text
Amountnumber
Cost Centretext
Quantitynumber
Superann Member Numbertext
Super Fund Identifiertext
Output fields[3]
FieldType
IDtext
Amountnumber
Quantitynumber
Cost Centretext
Pay Elementtext
Super Fund Identifiertext
Superann Member Numbertext
Linksarray
Reltext
Hrefurl

Update an Employee

ActionEdits personal, pay and tax information for one employee.
Input fields[3]
FieldType
Employee IDRequired
choice
Surnametext
First Namestext
Preferred Nametext
Titletext
Emailemail
Phonetext
Birth Datetext
Start Datetext
Finish Datetext
Full Time Hours Weeknumber
Genderchoice
Pay Frequencychoice
Payment Methodchoice
Bank Account Numbertext
Tax Numbertext
Default Cost Centretext
User Defined Grouptext
Addressobject
Address Line 1text
Address Line 2text
Suburbtext
Statechoice
Citytext
Post Codetext
Countrytext
Tax Codechoice

50other input fields

Output fields[3]
FieldType
IDtext
Organisationnumber
Surnametext
First Namestext
Preferred Nametext
Titletext
Emailemail
Phonetext
Birth Datetext
Start Datetext
Finish Datetext
Full Time Hours Weeknumber
Gendertext
Pay Frequencytext
Payment Methodtext
Bank Account Numbertext
Tax Numbertext
Default Cost Centretext
User Defined Grouptext
Addressobject
Address Line 1text
Address Line 2text
Suburbtext
Statetext
Citytext
Post Codetext
Countrytext

54other output fields

Look for iPayroll templates in the WEXTL template library.

Browse templates →
  1. WEXTL® iPayroll Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for iPayroll.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 13, 2026 10:56

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.