SimplePay icon

SimplePay

Cloud payroll and leave management for employers and pay runs.

5 triggers24 searches16 actionsPollingAuth: API key

AI-assisted documentation13 min read

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

Open SimplePay on WEXTL →

Before you set up the credential, make sure you have an active SimplePay account and an API access token from your account settings ready.[3]

  • API KeypasswordRequired

    To get your API key, log into your account and go to https://payroll.simplepay.cloud/external_users. In the 'API Users' section, click on the 'Add' button to create a new API user and an associated authorization key.

    [1]
  1. Log in to your WEXTL account, add the SimplePay 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 SimplePay 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 →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch ClientsTrigger
Output fields[3]
FieldType
Clientobject
IDnumber
Nametext
Physical addressobject
Watch EmployeesTrigger
Output fields[3]
FieldType
Employeeobject
IDnumber
Wave IDnumber
First nametext
Last nametext
Birthdatedate
Appointment datedate
Numbertext
Job titletext
Emailemail
Income tax numbertext
Watch Leave DaysTrigger
Output fields[3]
FieldType
IDnumber
Datedate
Hourstext
Leave typetext
Type IDnumber
Watch Pay PointsTrigger
Output fields[3]
FieldType
Pay pointobject
IDnumber
Nametext
Client IDnumber
Physical addressobject
Created atdate
Updated atdate
Watch Payment FrequenciesTrigger
Output fields[3]
FieldType
Waveobject
IDnumber
Frequencytext
First end datetext
Interim first end datetext
Interim day of monthtext
Last day of monthnumber
Custom nametext
Client IDnumber
Length monthsnumber
Length weeksnumber
Calculate Employee DataSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
IDnumber
Employee IDnumber
Payslip IDtext
Inputsobject
No autopay public holidaystext
Fixed amountnumber
Additional paid hourstext
Override calculated ratetext
Calculation IDtext
Account componentsobject
Deletedboolean
Account outputsobject
Client IDnumber
Created atdate
Updated atdate
Calculation def IDtext
Profile IDtext
Skipboolean
Multipliertext
Input formulasobject
Skip ruleboolean
Overridesobject
Outputsobject
System typetext
Calculate PayslipSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
IDnumber
Employee IDnumber
Payslip IDtext
Inputsobject
No autopay public holidaystext
Fixed amountnumber
Additional paid hourstext
Override calculated ratetext
Calculation IDtext
Account componentsobject
Deletedboolean
Account outputsobject
Client IDnumber
Created atdate
Updated atdate
Calculation def IDtext
Profile IDtext
Skipboolean
Multipliertext
Input formulasobject
Skip ruleboolean
Overridesobject
Outputsobject
System typetext
Create a Comparison Leave ReportSearch
Input fields[3]
FieldType
ClientRequired
choice
Start Datedate
End Datedate
Leave Typesarray
Humanizeboolean
Limitnumber
Output fields[3]
FieldType
Employeetext
Leave typetext
Datedate
Accrualtext
Entitlementtext
Takentext
Adjustmenttext
Balancetext
Create a Tracked Balances ReportSearch
Input fields[3]
FieldType
ClientRequired
choice
Datedate
Humanizeboolean
Limitnumber
Output fields[3]
FieldType
Employeetext
Loanstext
Savingstext
Garnisheestext
Create a Transaction History ReportSearch
Input fields[3]
FieldType
ClientRequired
choice
Start Datedate
End Datedate
Account Namesarray
Custom Fieldsarray
Humanizeboolean
Limitnumber
Output fields[3]
FieldType
Employeetext
Datedate
Basic salarytext
Taxtext
Create a Variance ReportSearch
Input fields[3]
FieldType
ClientRequired
choice
Period Offsetnumber
Humanizeboolean
Limitnumber
Output fields[3]
FieldType
Employeetext
Typetext
Transactionobject
Taxable incomenumber
Retirement funding incomenumber
Non retirement funding incomenumber
Uif incomenumber
Sdl incomenumber
Typetext
Cost to company accounttext
Codenumber
Nametext
Formulaobject
Previoustext
Selectedtext
Variancetext
Create an Employment Tax Incentive (ETI) ReportSearch
Input fields[3]
FieldType
ClientRequired
choice
Start Datedate
End Datedate
Humanizeboolean
Limitnumber
Output fields[3]
FieldType
Employeetext
Monthtext
Hourstext
Monthly remunerationtext
Monthly minimum wagetext
Eti calculatedtext
Get a Leave Liabilities ReportSearch
Input fields[3]
FieldType
ClientRequired
choice
Datedate
Humanizeboolean
Limitnumber
Output fields[3]
FieldType
Employeetext
Daystext
Daily ratetext
Liabilitytext
Get a Pay Run's Accounting Journal InfoSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
Posted to accounting systemboolean
Accounting splitsarray
Debitarray
Creditarray
Get a Payslip for an EmployeeAction
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
Payslipobject
Incomearray
Deductionarray
Grand totalarray
Sidelinearray
Leaveobject
Get a Specific CalculationAction
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
IDnumber
Employee IDtext
Payslip IDnumber
Inputsobject
Fixed amountnumber
Calculation IDnumber
Account componentsobject
Deletedboolean
Account outputsobject
Client IDnumber
Created atdate
Updated atdate
Calculation def IDtext
Profile IDtext
Skipboolean
Multipliertext
Input formulasobject
Skip ruletext
Overridesobject
Outputsobject
Short paynumber
Normal paynumber
Sunday paynumber
Normal ratenumber
Short hoursnumber
Sunday ratenumber
Basic salarynumber
Holiday ratenumber
Normal hoursnumber
Overtime paynumber
System typetext
Get a Specific EmployeeAction
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
Employeeobject
First nametext
Last nametext
Birthdatetext
Appointment datetext
Wave IDnumber
Payment methodtext
Physical addressobject
Custom fieldsobject
Get an Async ReportSearch
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
Messagetext
UUIDtext
Get an Employee's Leave BalancesAction
Input fields[3]
FieldType
ClientRequired
choice
DateRequired
text
Output fields[3]
FieldType
5number
6number
7number
Get Available Leave TypesAction
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
5text
6text
7text
8text
Get ClientsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Clientobject
IDnumber
Nametext
Physical addressobject
Get EmployeesSearch
Input fields[3]
FieldType
ClientRequired
choice
Includechoice
Limitnumber
Output fields[3]
FieldType
Employeeobject
IDnumber
Wave IDnumber
First nametext
Last nametext
Birthdatedate
Appointment datedate
Numbertext
Job titletext
Emailemail
Income tax numbertext
Get Latest Leave Balances for an EmployeeSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
Type IDnumber
Balancenumber
Datedate
Get Leave Days for an EmployeeSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
IDnumber
Datedate
Hourstext
Leave typetext
Type IDnumber
Get Pay PointsSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
Pay pointobject
IDnumber
Nametext
Client IDnumber
Physical addressobject
Created atdate
Updated atdate
Get Pay RunsSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
Payment runobject
IDnumber
Wave IDnumber
Period offsetnumber
Period end datetext
Totalnumber
Created atdate
Updated atdate
Specialboolean
Posted to accounting systemboolean
Get Payment FrequenciesSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
Waveobject
IDnumber
Frequencytext
First end datetext
Interim first end datetext
Interim day of monthtext
Last day of monthnumber
Custom nametext
Client IDnumber
Length monthsnumber
Length weeksnumber
Get Payslips for an EmployeeSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
Payslipobject
IDnumber
Datedate
Specialboolean
Finalisedboolean
Dirtyboolean
Nett paynumber
Ss releasedboolean
Payment run IDnumber
Get Payslips in a Pay RunSearch
Input fields[3]
FieldType
ClientRequired
choice
Limitnumber
Output fields[3]
FieldType
Payslipobject
IDnumber
Datedate
Specialboolean
Finalisedboolean
Ss releasedboolean
Payment run IDnumber
Dirtyboolean
Nett paynumber
Dataobject
Create a Leave DayAction
Input fields[3]
FieldType
ClientRequired
choice
DateRequired
date
Hoursnumber
Leave Type IDRequired
text
Output fields[3]
FieldType
Messagetext
IDnumber
Create a Pay FrequencyAction
Input fields[3]
FieldType
ClientRequired
choice
FrequencyRequired
choice
First End DateRequired
date
Last Day of Monthnumber
Interim Day of Monthnumber
Custom Nametext
Output fields[3]
FieldType
Messagetext
IDnumber
Create a Payslip CalculationAction
Input fields[3]
FieldType
ClientRequired
choice
Calculation TypeRequired
text
Calculation DetailsRequired
object
Amountnumber
Operationchoice
Effective Datedate
Output fields[3]
FieldType
Messagetext
IDnumber
Create an EmployeeAction
Input fields[3]
FieldType
ClientRequired
choice
WaveRequired
choice
First NameRequired
text
Last NameRequired
text
BirthdateRequired
date
Appointment DateRequired
date
Identification TypeRequired
choice
ID Numbertext
Other Numbertext
Passport Country Codetext
Payment MethodRequired
choice
Employee Numbertext
Emailemail
Job Titletext
Income Tax Numbertext
Bank Accountobject
Bank IDRequired
text
Account NumberRequired
text
Branch CodeRequired
text
Account Typechoice
Holder Relationshipchoice
Holder Nametext
Physical Addressobject
Unit Numbertext
Complextext
Street Numbertext
Street or Farm Nametext
Suburb or Districttext
City or Towntext
Postal Codetext
Postal Addressobject
Same as Physicalboolean
Line 1text
Line 2text
Line 3text
Postal Codetext
Custom Fieldsobject
Field IDRequired
text
ValueRequired
text
Output fields[3]
FieldType
Messagetext
IDnumber
Numbertext
Create an Employee CalculationAction
Input fields[3]
FieldType
ClientRequired
choice
Calculation TypeRequired
text
Calculation DetailsRequired
object
Amountnumber
Operationchoice
Effective Datedate
Output fields[3]
FieldType
Messagetext
IDnumber
Create Multiple Leave DaysAction
Input fields[3]
FieldType
ClientRequired
choice
Leave DaysRequired
array
Output fields[3]
FieldType
Messagetext
Idsarray
Delete a CalculationAction
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
Messagetext
Delete a Leave DayAction
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
Messagetext
Delete an EmployeeAction
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
Messagetext
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Request a PDF PayslipAction
Input fields[3]
FieldType
ClientRequired
choice
Output fields[3]
FieldType
Datatext
Start an Async ReportAction
Input fields[3]
FieldType
ClientRequired
choice
Start Datedate
End Datedate
Datedate
Humanizeboolean
Output fields[3]
FieldType
Messagetext
UUIDtext
Update a Leave DayAction
Input fields[3]
FieldType
ClientRequired
choice
Datedate
Hoursnumber
Leave Type IDtext
Output fields[3]
FieldType
Messagetext
IDnumber
Update a Specific CalculationAction
Input fields[3]
FieldType
ClientRequired
choice
Calculation DetailsRequired
object
Increase Balancenumber
Output fields[3]
FieldType
Messagetext
IDnumber
Update an EmployeeAction
Input fields[3]
FieldType
ClientRequired
choice
First Nametext
Last Nametext
Birthdatedate
Output fields[3]
FieldType
Messagetext
IDnumber
Numbertext
Update Employees and PayslipsAction
Input fields[3]
FieldType
ClientRequired
choice
EntitiesRequired
array
Output fields[3]
FieldType
IDtext
Payslip IDtext
Successtext
Messagetext

Look for SimplePay templates in the WEXTL template library.

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

Last updated: Jul 24, 2026 18:12