Payroll

Definitions

enableHR Employee records are enhanced with Payroll related fields.

For Australian accounts:

  • Bank Accounts:
    • Up to 4 bank accounts are supported. The order in which accounts are to be considered (by the payroll system) is mandatory.
    • A Bank Account is made of a BSB and Account number together.
    • Each bank account has a “Dollar amount” that represents the $ figure that the payroll system will use for payment into this bank account. The “Remainder” option is used for “everything left”.
  • Tax:
    • All the essential details needed for the Australian taxation purpose are supported, including Tax File Number, Residency Status, Employment basis, Tax free threshold, HECS and Trade Support Loan.
    • TFN is masked except for the last 3 digits (###-###-123), if un-masked TFN is needed for Payroll integration purposes, please contact Client Success at support@enablehr.com.
  • Superannuation: Supports industry or commercial super funds but does not support Self-Managed Super Funds. Up to 4 Superannuation funds can be maintained for an employee including Fund name, Fund address, Fund ABN and USI.
  • Leave Balances: Leave balances information can be maintained for Australian employees includes Annual, Personal and Long Service leaves.

For New Zealand accounts:

  • Bank Accounts:
    • Up to 4 bank accounts are supported. The order in which accounts are to be considered (by the payroll system) is mandatory
    • 16-digit account number which includes Bank number, Branch Number, Account number and suffixes.
    • Each bank account has a “Dollar amount” that represents the $ figure that the payroll system will use for payment into this bank account. The “Remainder” option is used for “everything left”.
  • Tax: Mandatory tax information including Tax Code, Student loan percentage and IRD number are maintained in enableHR.
  • Kiwisaver: Retirement saving information for New Zealand employees includes Employee & Employer contributions and as well as pre-defined Employer superannuation contribution tax (ESCT) are maintained.
  • Leave Balances: Majorly used leave balances information can be maintained for New Zealand employees includes Annual, Sick, Personal, Long Service, Bereavement and Domestic Violence leaves.

Add / Update / Delete Bank Accounts

Use this action to Add, Update or Delete employee bank details.

The same action is used to add, update and delete Bank Accounts in Australia and New Zealand. The API call knows if the Account is in Australia or New Zealand, so you don’t have to specify it.

enableHR supports up to 4 bank accounts. The order in which accounts are to be considered (by the payroll system) is mandatory.

  1. If the Employee doesn’t have any bank account, the ones passed through the API are added.
  2. If the Employee already has some bank account details, they will be updated with the new ones.
  3. If the API doesn’t send any bank account details, then the existing details for the Employee will be deleted.

Each bank account has a “Dollar amount” that represents the $ figure that the payroll system will use for payment into this bank account. The “Remainder” option is used for “everything left”.

MethodPUT: Maintain Employee Bank Details
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Accepted Parameters
FieldDetailsExample
BSB - Mandatory
Bank State branch of the bank account094301
Account Number - Mandatory
Bank account number of the employee123456789
Account Name - Mandatory
Name of the person for the bank accountLinda Johnson
Dollar amountSpecified amount to be depositedIf Remainder is chosen – Null value (or) the specified amount as per setup.
Statement TextText that appears on bank statementBalance Salary
Remainder - Mandatory
Identifier to decide which bank accounts gets the remaining part of the salary credit.True / False
Account Order - Mandatory
Order of how the bank account setup is to be considered0 (or) 1 (or) 2 (or) 3
Bank Account Number - Mandatory
Bank account number of the employee123456789
Account Name - Mandatory
Name of the person for the bank accountLinda Johnson
Dollar amountSpecified amount to be depositedIf Remainder is chosen – Null value (or) the specified amount as per setup.
Statement TextText that appears on bank statementBalance Salary
Remainder - Mandatory
Identifier to decide which bank accounts gets the remaining part of the salary credit.True / False

Australian Accounts

New Zealand Accounts

Retrieve Bank Accounts

Use this action to retrieve the Bank Account details of an Employee.

enableHR supports up to 4 bank accounts. The order in which accounts are to be considered (by the payroll system) is mandatory.

Each bank account has a “Dollar amount” that represents the $ figure that the payroll system will use for payment into this bank account. The “Remainder” option is used for “everything left”.

MethodGET: Retrieve Bank Details
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Response
FieldDetailsExample
BSBBank State branch of the bank account094301
Account NumberBank account number of the employee123456789
Account NameName of the person for the bank accountLinda Johnson
Dollar amountSpecified amount to be depositedIf Remainder is chosen – Null value (or) the specified amount as per setup.
Statement TextText that appears on bank statementBalance Salary
RemainderIdentifier to decide which bank accounts gets the remaining part of the salary credit.True / False
Account OrderOrder of how the bank account setup is to be considered0 (or) 1 (or) 2 (or) 3
Bank Account NumberBank account number of the employee123456789
Account NameName of the person for the bank accountLinda Johnson
Dollar amountSpecified amount to be depositedIf Remainder is chosen – Null value (or) the specified amount as per setup.
Statement TextText that appears on bank statementBalance Salary
RemainderIdentifier to decide which bank accounts gets the remaining part of the salary credit.True / False
Account OrderOrder of how the bank account setup is to be considered0 (or) 1 (or) 2 (or) 3

Australian Accounts

New Zealand Accounts

Add / Update / Delete Superannuation / Kiwisaver

Use this action to Add, Update or Delete employee Superannuation (Australia) or Kiwisaver (New Zealand) details.

The same action is used to add, update and delete Super Funds in Australia and New Zealand. The API call knows if the Account is in Australia or New Zealand, so you don’t have to specify it.

  1. If the Superannuation / Kiwisaver details are not already present, they will be added
  2. If the Superannuation / Kiwisaver details already exist, they are updated with the new details.
  3. When the details are empty, the input details are removed, Superannuation / Kiwisaver details for the employee will be deleted.

enableHR supports up to 4 super funds in Australia. It supports industry or commercial super funds but does not support Self-Managed Super Funds. Multiple Superannuation records can be maintained for an employee including Fund name, Fund address, Fund ABN and USI.

MethodPUT: Maintain Employee Retirement Saving Details
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Accepted Fields
FieldDetailsExample
Employee number - Mandatory
Unique Member number for the super fund565656
Fund name - Mandatory
Superannuation fund nameSuper fund test
ABN - Mandatory
Valid Australian Business Number of the fund65 714 394 898
Type - Mandatory
The type of Retirement SavingRegulated
Electronic Service AddressAddress of the Super fund44 Jot Street, Brisbane, QLD
Super Fund ID (USI)Unique Superannuation Identifier for the fund345345439
TypeType of Retirement savingAccepted values: REGULATED, SMSF
Status - Mandatory
The Kiwi Saver statusAccepted values - ACTIVE, OPT_OUT,
SAVINGS_SUSPENSION, NOT_A_MEMBER
Employer Contribution PercentageKiwi Super contribution made by the employer4%
Employee Contribution PercentageKiwi Super contribution made by the employee3% (allowed values 3, 4, 6, 8, 10)
ESCTEmployer Contribution tax based on earnings17.5% (allowed values: 10.5, 17.5, 30, 33)
Opt Out DateOpt out Date2022-10-29
Bank Account NumberBank account number when chosen to opt out231235435345
Account holder's NameName of the bank account holder when chosen to opt outSuresh Rana
Suspension End DateSuspension End date2021-12-01
Suspension End dateDate when the Kiwi saver to be suspended2023-09-23

Australian Accounts

New Zealand Accounts

When status is active:

When Status is Opt-out:

When Status is Suspended:

Retrieve Superannuation / Kiwisaver

Use this action to retrieve the details of Superannuation (Australia) or Kiwisaver (New Zealand) of an Employee.

enableHR supports up to 4 super funds in Australia. It supports industry or commercial super funds but does not support Self-Managed Super Funds. Multiple Superannuation records can be maintained for an employee including Fund name, Fund address, Fund ABN and USI.

MethodGET: Retrieve Superannuation / Kiwisaver details
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Response
Field Name on the ScreenDetailsExample
Employee numberUnique Member number for the super fund565656
Fund nameSuperannuation fund nameSuper fund test
ABNValid Australian Business Number of the fund65 714 394 898
Super Fund ID (USI)Unique Superannuation Identifier for the fund345345439
TypeThe type of Retirement SavingRegulated
StatusThe Kiwi Saver statusAccepted values - ACTIVE, OPT_OUT,
SAVINGS_SUSPENSION, NOT_A_MEMBER
Employer Contribution PercentageKiwi Super contribution made by the employer4%
Employee Contribution PercentageKiwi Super contribution made by the employee3% (allowed values 3, 4, 6, 8, 10)
ESCTEmployer Contribution tax based on earnings17.5% (allowed values: 10.5, 17.5, 30, 33)

Australian Accounts

New Zealand Accounts

Add / Update Tax Details

Use this action to Add or Update the Tax details of an Employee.

The same action is used to add or update the Tax details in Australia and New Zealand. The API call knows if the Account is in Australia or New Zealand, so you don’t have to specify it.

If the tax details already exist, it will be updated with the new input details otherwise it will be created.

All the essential details needed for the Australian taxation purpose are supported, including Tax File Number, Residency Status, Employment basis, Tax free threshold, HECS and Trade Support Loan.
TFN is always masked except for the last 3 digits (###-###-123), if un-masked TFN is needed for Payroll integration purposes, please contact Client Success.

In New Zealand, all mandatory tax information including Tax Code, Student loan percentage and IRD number are maintained in enableHR.

MethodPUT: Add/Update Tax Details
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Accepted Fields
FieldDetailsExample
TFN - Mandatory
Tax file number of an employeeValid 9 digits of the TFN as enableHR does validations.
Exempt TypeAny tax exemption based on agePossible values – Unquoted, Pending, Under 18, Pensioner
Employee BasisType of EmploymentPossible values – Full Time, Part Time, Casual, Labor Hire, Super Income stream
Residency StatusResidency for tax purposesPossible values – Australian Resident, Foreign Resident, Working Holiday Maker
Residency StatusResidency for tax purposesPossible values – Australian Resident, Foreign Resident, Working Holiday Maker
Tax Free Threshold ClaimedEmployees option whether to be taxed for every dollar earned or notTrue / False
Trade Support LoanSupport for apprentices to assist with everyday costsTrue / False
Hecs SupportedHigher Education Support from Australian governmentTrue / False
Student startup loanVoluntary loan for eligible students who get youth allowanceTrue / False
Financial Supplement DebtFinancing scheme offered by the Australian government's Social Security officeTrue / False
FinAustralian ResidentAustralian Resident for Tax PurposesTrue / False
Eligible To Receive Leave LoadingAs outlined in your employee's award or workplace agreementTrue / False
Other Tax Offset ClaimedReduces the tax on the taxable income for Low- and Middle-income earnerTrue / False
Upward Variation RequestedEmployees request to increase the PAYG deducted from their pay each week or fortnight to avoid a bill from the ATOTrue / False
Approved Withholding VariationEmployees have necessary approval from ATO for withholding variationTrue / False
Approved Withholding VariationPercentage value for the withholding variation15%
Tax Code - Mandatory
Tax codes help the employer work out how much tax to deductAllowed values as per the IRD Spec: (CAE, M, M_SL, ME, ME_SL, ND, NSW, S, S_SL, SA, SA_SL, SB, SB_SL, SH, SH_SL, ST, ST_SL, STC, WT)
IRD NumberUnique number issued by Inland Revenue to customers8 or 9-digit number
Student LoanPercentage value4%

Australian Accounts

New Zealand Accounts

Retrieve Tax Details

Use this action to Add or Update the Tax details of an Employee.

All the essential details needed for the Australian taxation purpose are supported, including Tax File Number, Residency Status, Employment basis, Tax free threshold, HECS and Trade Support Loan.
TFN is always masked except for the last 3 digits (###-###-123), if un-masked TFN is needed for Payroll integration purposes, please contact Client Success.

In New Zealand, all mandatory tax information including Tax Code, Student loan percentage and IRD number are maintained in enableHR.

MethodGET: Retrieve tax Details of an Employee
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Response
FieldDetailsExample
TFNTax file number of an employeeMasked values except for last 3 digits ######782.
Unmasked TFN can be provided to the payroll providers which needs additional security checks.
Exempt TypeAny tax exemption based on agePossible values – Unquoted, Pending, Under 18, Pensioner
Employee BasisType of EmploymentPossible values – Full Time, Part Time, Casual, Labor Hire, Super Income stream
Residency StatusResidency for tax purposesPossible values – Australian Resident, Foreign Resident, Working Holiday Maker
Tax Free Threshold ClaimedEmployees option whether to be taxed for every dollar earned or notTrue / False
Trade Support LoanSupport for apprentices to assist with everyday costsTrue / False
Hecs SupportedHigher Education Support from Australian governmentTrue / False
Student startup loanVoluntary loan for eligible students who get youth allowanceTrue / False
Financial Supplement DebtFinancing scheme offered by the Australian government's Social Security officeTrue / False
FinAustralian ResidentAustralian Resident for Tax PurposesTrue / False
Eligible To Receive Leave LoadingAs outlined in your employee's award or workplace agreementTrue / False
Other Tax Offset ClaimedReduces the tax on the taxable income for Low- and Middle-income earnerTrue / False
Upward Variation RequestedEmployees request to increase the PAYG deducted from their pay each week or fortnight to avoid a bill from the ATOTrue / False
Approved Withholding VariationEmployees have necessary approval from ATO for withholding variationTrue / False
Approved Withholding Variation PercentagePercentage value for the withholding variation15%
Tax CodeTax codes help the employer work out how much tax to deductAllowed values as per the IRD Spec: (CAE, M, M_SL, ME, ME_SL, ND, NSW, S, S_SL, SA, SA_SL, SB, SB_SL, SH, SH_SL, ST, ST_SL, STC, WT)
IRD NumberUnique number issued by Inland Revenue to customers8 or 9-digit number
Student LoanPercentage value4%

Australian Accounts

New Zealand Accounts

Leave Balances

Although enableHR doesn’t provide Leave Management feature, it stores Leave Balances so that managers and employees can visualise them. In Australia, the following leave types are currently supported:

  • Annual Leave
  • Personal Leave
  • Long Service Leave

In New Zealand, the following leave types are currently supported:

  • Annual Leave
  • Sick Leave
  • Long Service Leave
  • Domestic Violence leave
  • Bereavement leave
  • Parental leave
  • Alternative Holidays

Retrieve Leave Balances

Use this action to retrieve the Leave Balances of an Employee.

In Australia, the following leave types are currently supported: Annual Leave, Personal Leave, Long Service Leave.

In New Zealand, the following leave types are currently supported: Annual Leave, Sick Leave, Long Service Leave, Domestic Violence leave, Bereavement leave, Parental leave, Alternative Holidays.

Units can be in days or hours as maintained by client.

MethodGET: Retrieve Employee Leave balances
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Response
FieldDetailsExample
Annual LeaveAnnual leave units stored in enableHR for the employee480.23
Personal LeavePersonal leave units220.00
Long Service LeaveLong Service leave units13.00
Annual LeaveAnnual leave units stored in enableHR for the employee23.42
Sick LeaveSick leave units12.32
Long Service LeaveLong Service leave units0
Domestic Violence leaveDomestic Violence leave units0
Bereavement leaveBereavement leave units provided to employee16.0
Parental leaveParental leave units provided to employee0
Alternative HolidaysAny alternative leave provided to employee0

Australian Accounts

New Zealand Accounts

Update Leave Balances

Use this action to add or update Leave Balances of an Employee.

The same action is used to add or update the Leave Balances in Australia and New Zealand. The API call knows if the Account is in Australia or New Zealand, so you don’t have to specify it.

In Australia, the following leave types are currently supported: Annual Leave, Personal Leave, Long Service Leave.

In New Zealand, the following leave types are currently supported: Annual Leave, Sick Leave, Long Service Leave, Domestic Violence leave, Bereavement leave, Parental leave, Alternative Holidays.

Units can be in days or hours as maintained by client.

MethodPUT: Maintain Leave Balances
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Accepted Fields
FieldDetailsExample
Annual LeaveAnnual leave units stored in enableHR for the employee480.23
Personal LeavePersonal leave units220.00
Long Service LeaveLong Service leave units13.00
Annual LeaveAnnual leave units stored in enableHR for the employee23.42
Sick LeaveSick leave units12.32
Long Service LeaveLong Service leave units0
Domestic Violence leaveDomestic Violence leave units0
Bereavement leaveBereavement leave units provided to employee16.0
Parental leaveParental leave units provided to employee0
Alternative HolidaysAny alternative leave provided to employee0

Australian Accounts

New Zealand Accounts

© 2021 enableHR · All rights reserved