iPayroll integration guide
VerifiedHow 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].
Requirements
Get your iPayroll credentials
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 CentresCustom FieldsEmployees
Connect iPayroll in WEXTL
- Log in to your WEXTL account, add the iPayroll node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your iPayroll account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
iPayroll triggers and actions on WEXTL
The list below is a reference of every iPayroll node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each iPayroll node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch Cost Centres
TriggerPolls for new cost centres and emits each.
| Field | Type |
|---|---|
| ID | number |
| Code | text |
| Description | text |
| Display Value | text |
| Active | boolean |
| Links | array |
| Rel | text |
| Href | url |
Get a Cost Centre
ActionReads a single iPayroll cost centre.
| Field | Type |
|---|---|
Cost Centre IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Code | text |
| Description | text |
| Display Value | text |
| Active | boolean |
| Links | array |
| Rel | text |
| Href | url |
Get a Custom Field
ActionA single employee custom field from one category.
| Field | Type |
|---|---|
Employee IDRequired | choice |
Category IDRequired | number |
Custom Field IDRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Category | number |
| Category Name | text |
| Custom Field ID | number |
| Name | text |
| Date | date |
| Description | text |
| Contact | text |
| Contact Details | text |
| Relationship | text |
| Phone Number | text |
| Address | text |
| Contract Hours | number |
| Period Days | number |
| Contract End | text |
| FTE | number |
| Hay Points | number |
| Hay Profile | number |
| Hays Profile | number |
8other output fields
Get a Superannuation Record
ActionOne superannuation entry held for an employee.
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Amount | number |
| Quantity | number |
| Cost Centre | text |
| Pay Element | text |
| Super Fund Identifier | text |
| Superann Member Number | text |
| Links | array |
| Rel | text |
| Href | url |
Get an Employee
ActionPersonal and pay details for one employee.
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Organisation | number |
| Surname | text |
| First Names | text |
| Preferred Name | text |
| Title | text |
| Phone | text |
| Birth Date | text |
| Start Date | text |
| Finish Date | text |
| Full Time Hours Week | number |
| Gender | text |
| Pay Frequency | text |
| Payment Method | text |
| Bank Account Number | text |
| Tax Number | text |
| Default Cost Centre | text |
| User Defined Group | text |
| Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Suburb | text |
| State | text |
| City | text |
| Post Code | text |
| Country | text |
54other output fields
Get Cost Centres
SearchCost centres with their codes and descriptions.
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Code | text |
| Description | text |
| Display Value | text |
| Active | boolean |
| Links | array |
| Rel | text |
| Href | url |
Get Employee Custom Fields
SearchCustom field values recorded against an employee.
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Category | number |
| Category Name | text |
| Custom Field ID | number |
| Name | text |
| Date | date |
| Description | text |
| Contact | text |
| Contact Details | text |
| Relationship | text |
| Phone Number | text |
| Address | text |
| Contract Hours | number |
| Period Days | number |
| Contract End | text |
| FTE | number |
| Hay Points | number |
| Hay Profile | number |
| Hays Profile | number |
8other output fields
Get Employee Custom Fields By Category
SearchOnly the fields recorded under a chosen category.
| Field | Type |
|---|---|
Employee IDRequired | choice |
Category IDRequired | number |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Category | number |
| Category Name | text |
| Custom Field ID | number |
| Name | text |
| Date | date |
| Description | text |
| Contact | text |
| Contact Details | text |
| Relationship | text |
| Phone Number | text |
| Address | text |
| Contract Hours | number |
| Period Days | number |
| Contract End | text |
| FTE | number |
| Hay Points | number |
| Hay Profile | number |
| Hays Profile | number |
8other output fields
Get Employees
SearchEmployee list of your iPayroll organisation.
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Organisation | number |
| Surname | text |
| First Names | text |
| Preferred Name | text |
| Title | text |
| Phone | text |
| Birth Date | text |
| Start Date | text |
| Finish Date | text |
| Full Time Hours Week | number |
| Gender | text |
| Pay Frequency | text |
| Payment Method | text |
| Bank Account Number | text |
| Tax Number | text |
| Default Cost Centre | text |
| User Defined Group | text |
| Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Suburb | text |
| State | text |
| City | text |
| Post Code | text |
| Country | text |
54other output fields
Get Superannuation Records
SearchSuperannuation entries for a single employee.
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Amount | number |
| Quantity | number |
| Cost Centre | text |
| Pay Element | text |
| Super Fund Identifier | text |
| Superann Member Number | text |
| Links | array |
| Rel | text |
| Href | url |
Search Custom Fields
SearchFinds custom fields by category or field.
| Field | Type |
|---|---|
| Employee ID | choice |
| Category ID | number |
| Category Name | text |
| Custom Field ID | number |
| Custom Field Name | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Category | number |
| Category Name | text |
| Custom Field ID | number |
| Name | text |
| Date | date |
| Description | text |
| Contact | text |
| Contact Details | text |
| Relationship | text |
| Phone Number | text |
| Address | text |
| Contract Hours | number |
| Period Days | number |
| Contract End | text |
| FTE | number |
| Hay Points | number |
| Hay Profile | number |
| Hays Profile | number |
8other output fields
Create a Superannuation Record
ActionCreates superannuation for one employee from a pay element and quantity.
| Field | Type |
|---|---|
Employee IDRequired | choice |
Pay ElementRequired | text |
QuantityRequired | number |
| Amount | number |
| Cost Centre | text |
| Superann Member Number | text |
| Super Fund Identifier | text |
| Field | Type |
|---|---|
| ID | text |
| Amount | number |
| Quantity | number |
| Cost Centre | text |
| Pay Element | text |
| Super Fund Identifier | text |
| Superann Member Number | text |
| Links | array |
| Rel | text |
| Href | url |
Create Cost Centres
ActionCreates cost centres from codes and descriptions.
| Field | Type |
|---|---|
Cost CentresRequired | array |
CodeRequired | text |
DescriptionRequired | text |
| Field | Type |
|---|---|
| ID | number |
| Code | text |
| Description | text |
| Display Value | text |
| Active | boolean |
| Links | array |
| Rel | text |
| Href | url |
Create Employees
ActionAdds employees with their pay, bank and tax details.
| Field | Type |
|---|---|
EmployeesRequired | array |
| Employee ID | text |
SurnameRequired | text |
First NamesRequired | text |
| Preferred Name | text |
| Title | text |
| Phone | text |
| Birth Date | text |
Start DateRequired | text |
| Finish Date | text |
| Field | Type |
|---|---|
| ID | text |
| Organisation | number |
| Surname | text |
| First Names | text |
| Preferred Name | text |
| Title | text |
| Phone | text |
| Birth Date | text |
| Start Date | text |
| Finish Date | text |
| Full Time Hours Week | number |
| Gender | text |
| Pay Frequency | text |
| Payment Method | text |
| Bank Account Number | text |
| Tax Number | text |
| Default Cost Centre | text |
| User Defined Group | text |
| Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Suburb | text |
| State | text |
| City | text |
| Post Code | text |
| Country | text |
54other output fields
Delete a Superannuation Record
ActionRemoves the superannuation of one employee.
| Field | Type |
|---|---|
Employee IDRequired | choice |
Make an API Call
universalFree-form iPayroll REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Update a Superannuation Record
ActionEdits one superannuation record of an employee.
| Field | Type |
|---|---|
Employee IDRequired | choice |
Pay ElementRequired | text |
| Amount | number |
| Cost Centre | text |
| Quantity | number |
| Superann Member Number | text |
| Super Fund Identifier | text |
| Field | Type |
|---|---|
| ID | text |
| Amount | number |
| Quantity | number |
| Cost Centre | text |
| Pay Element | text |
| Super Fund Identifier | text |
| Superann Member Number | text |
| Links | array |
| Rel | text |
| Href | url |
Update an Employee
ActionEdits personal, pay and tax information for one employee.
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Surname | text |
| First Names | text |
| Preferred Name | text |
| Title | text |
| Phone | text |
| Birth Date | text |
| Start Date | text |
| Finish Date | text |
| Full Time Hours Week | number |
| Gender | choice |
| Pay Frequency | choice |
| Payment Method | choice |
| Bank Account Number | text |
| Tax Number | text |
| Default Cost Centre | text |
| User Defined Group | text |
| Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Suburb | text |
| State | choice |
| City | text |
| Post Code | text |
| Country | text |
| Tax Code | choice |
50other input fields
| Field | Type |
|---|---|
| ID | text |
| Organisation | number |
| Surname | text |
| First Names | text |
| Preferred Name | text |
| Title | text |
| Phone | text |
| Birth Date | text |
| Start Date | text |
| Finish Date | text |
| Full Time Hours Week | number |
| Gender | text |
| Pay Frequency | text |
| Payment Method | text |
| Bank Account Number | text |
| Tax Number | text |
| Default Cost Centre | text |
| User Defined Group | text |
| Address | object |
| Address Line 1 | text |
| Address Line 2 | text |
| Suburb | text |
| State | text |
| City | text |
| Post Code | text |
| Country | text |
54other output fields
Templates
Look for iPayroll templates in the WEXTL template library.
Browse templates →Other HR integrations on WEXTL
DailyPay[2]Earned wage access and on-demand pay platform that connects employees to earned wages early.
Cezanne HRCloud HR software for mid-size organisations, with people, absence and performance.
BrightHRHR software for small businesses covering people, absence, and time tracking.
Breezy HRApplicant tracking and recruiting platform for posting jobs, sourcing candidates, and hiring.
CeipalTalent platform for recruiting, submissions, placements, and workforce.
References
- WEXTL® iPayroll Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for iPayroll.
- 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.






























