Nic at 02:04, 4 July 2025

2025-07-04T02:04:16Z

← Older revision		Revision as of 21:04, 3 July 2025
Line 100:		Line 100:
	== Change Logs ==		== Change Logs ==

	;Applied fix to the [[Xero Payroll (New Zealand) Endpoint: EmployeesTaxDetails\|EmployeesTaxDetails]] to resolve date format issue for '''kiwiSaverOptOutDate''', '''kiwiSaverContributionHolidayEndDate''' and '''studentLoanAsAt'''.		:Applied fix to the [[Xero Payroll (New Zealand) Endpoint: EmployeesTaxDetails\|EmployeesTaxDetails]] to resolve date format issue for '''kiwiSaverOptOutDate''', '''kiwiSaverContributionHolidayEndDate''' and '''studentLoanAsAt'''.

Nic at 02:04, 4 July 2025

2025-07-04T02:04:06Z

← Older revision		Revision as of 21:04, 3 July 2025
Line 97:		Line 97:
	:[[Xero Payroll (New Zealand) Models]]		:[[Xero Payroll (New Zealand) Models]]
	:[[Xero Payroll (New Zealand) Endpoints]]		:[[Xero Payroll (New Zealand) Endpoints]]

			== Change Logs ==

			;Applied fix to the [[Xero Payroll (New Zealand) Endpoint: EmployeesTaxDetails\|EmployeesTaxDetails]] to resolve date format issue for '''kiwiSaverOptOutDate''', '''kiwiSaverContributionHolidayEndDate''' and '''studentLoanAsAt'''.

Nic: Created page with "== Overview == The Xero '''EmployeesTaxDetails''' endpoint provides the tax detail information for Xero Payroll (New Zealand) Endpo..."

2022-01-18T23:18:23Z

Created page with "== Overview == The Xero '''EmployeesTaxDetails''' endpoint provides the tax detail information for Xero Payroll (New Zealand) Endpo..."

New page

== Overview ==

The Xero '''EmployeesTaxDetails''' [[Xero Payroll (New Zealand) Endpoints|endpoint]] provides the tax detail information for [[Xero Payroll (New Zealand) Endpoint: Employees|employees]].

== Fields ==

The following fields are available for the EmployeesTaxDetails endpoint.

;employeeID
:A [[Field Type: GUID|guid field]] that provides the id of the linked [[Xero Payroll (New Zealand) Endpoint: Employees|employee]].

;irdNumber
:A [[Field Type: Text|text field]] that provides the IRD number of the employee.

;taxCode
:A [[Field Type: Text|text field]] that provides the payroll tax code assigned to the employee.

;esctRatePercentage
:A [[Field Type: Decimal|decimal field]] that provides the employer superannuation contribution tax rate.

;isEligibleForKiwiSaver
:A [[Field Type: Boolean|true/false field]] that indicates if the employee is eligible for KiwiSaver.

;kiwiSaverContributions
:A [[Field Type: Text|text field]] that indicates how contributions apply to KiwiSaver.
:Possible values are:
:* '''MakeContributions'''
:* '''OptOut'''
:* '''OnAContributionsHoliday'''
:* '''OnASavingsSuspension'''
:* '''NotCurrentlyAKiwiSaverMember'''

;kiwiSaverStatus
:A [[Field Type: Text|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 [[Field Type: Date|date field]] that indicates when the employee opted out.
:Only applicable if '''kiwiSaverContributions''' is set to '''OptOut'''.

;kiwiSaverContributionHolidayEndDate
:A [[Field Type: Date|date field]] that indicates when the employee went on a KiwiSaver contribution holiday.
:Only applicable if '''kiwiSaverContributions''' is set to '''OnAContributionsHoliday'''.

;kiwiSaverEmployeeContributionRatePercentage
:A [[Field Type: Decimal|decimal field]] that provides the employee contribution to KiwiSaver.

;kiwiSaverEmployerContributionRatePercentage
:A [[Field Type: Decimal|decimal field]] that provides the employer contribution to KiwiSaver.

;kiwiSaverEmployerSalarySacrificeContributionRatePercentage
:A [[Field Type: Decimal|decimal field]] that provides the employer contribution through salary sacrifice.

;hasStudentLoanBalance
:A [[Field Type: Boolean|true/false field]] that indicates if the employee has a remaining student loan balance.

;studentLoanBalance
:A [[Field Type: Decimal|decimal field]] that provides the employee student loan balance.

;studentLoanAsAt
:A [[Field Type: Date|date field]] that provides the date representing the student loan balance.

;hasSpecialStudentLoanRate
:A [[Field Type: Boolean|true/false field]] that indicates if the employee has a special student loan rate.

;specialStudentLoanRatePercentage
:A [[Field Type: Decimal|decimal field]] that provides the employee student loan rate.

;specialTaxRatePercentage
:A [[Field Type: Decimal|decimal field]] that provides the employee special tax rate.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/payrollnz/employeetax Xero API].

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Payroll (New Zealand) Endpoint: Employees|Employees]]

== Related Topics ==

:[[Xero Payroll (New Zealand) Models]]
:[[Xero Payroll (New Zealand) Endpoints]]

Xero Payroll (New Zealand) Endpoint: EmployeesTaxDetails - Revision history

Nic at 02:04, 4 July 2025

Nic at 02:04, 4 July 2025

Nic: Created page with "== Overview == The Xero '''EmployeesTaxDetails''' endpoint provides the tax detail information for Xero Payroll (New Zealand) Endpo..."