Xero Payroll (New Zealand) Endpoint: EmployeesTaxDetails
Jump to navigation
Jump to search
Overview
The Xero EmployeesTaxDetails endpoint provides the tax detail information for employees.
Fields
The following fields are available for the EmployeesTaxDetails endpoint.
- employeeID
- A guid field that provides the id of the linked employee.
- irdNumber
- A text field that provides the IRD number of the employee.
- taxCode
- A text field that provides the payroll tax code assigned to the employee.
- esctRatePercentage
- A decimal field that provides the employer superannuation contribution tax rate.
- isEligibleForKiwiSaver
- A true/false field that indicates if the employee is eligible for KiwiSaver.
- kiwiSaverContributions
- A text field that indicates how contributions apply to KiwiSaver.
- Possible values are:
- MakeContributions
- OptOut
- OnAContributionsHoliday
- OnASavingsSuspension
- NotCurrentlyAKiwiSaverMember
- kiwiSaverStatus
- A text field that indicates the status of the KiwiSaver account.
- Possible values are:
- ActiveKiwiSaverMember: Active KiwiSaver member
- AutomaticallyEnrolledIntoKiwiSaver: Automatically enrolled into KiwiSaver
- EmployedForLessThan28Days: Employed for less than 28 days
- NotRequiredToBeAutomaticallyEnrolled: Not required to be automatically enrolled
- OptedIntoKiwiSaver: Opted into KiwiSaver
- NotEligibleForKiwiSaver: Not eligible for KiwiSaver
- kiwiSaverOptOutDate
- A date field that indicates when the employee opted out.
- Only applicable if kiwiSaverContributions is set to OptOut.
- kiwiSaverContributionHolidayEndDate
- A date field that indicates when the employee went on a KiwiSaver contribution holiday.
- Only applicable if kiwiSaverContributions is set to OnAContributionsHoliday.
- kiwiSaverEmployeeContributionRatePercentage
- A decimal field that provides the employee contribution to KiwiSaver.
- kiwiSaverEmployerContributionRatePercentage
- A decimal field that provides the employer contribution to KiwiSaver.
- kiwiSaverEmployerSalarySacrificeContributionRatePercentage
- A decimal field that provides the employer contribution through salary sacrifice.
- hasStudentLoanBalance
- A true/false field that indicates if the employee has a remaining student loan balance.
- studentLoanBalance
- A decimal field that provides the employee student loan balance.
- studentLoanAsAt
- A date field that provides the date representing the student loan balance.
- hasSpecialStudentLoanRate
- A true/false field that indicates if the employee has a special student loan rate.
- specialStudentLoanRatePercentage
- A decimal field that provides the employee student loan rate.
- specialTaxRatePercentage
- A decimal field that provides the employee special tax rate.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints