java.lang.Object
- com.xero.models.payrollnz.EmployeeTax

```
public class EmployeeTax
extends Object
```
EmployeeTax

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`EmployeeTax.KiwiSaverContributionsEnum`	Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership

Constructor Summary

Constructors
Constructor Description

EmployeeTax()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`EmployeeTax`	`esctRatePercentage(Double esctRatePercentage)`	Employer superannuation contribution tax rate.
`Double`	`getEsctRatePercentage()`	Employer superannuation contribution tax rate.
`Boolean`	`getHasSpecialStudentLoanRate()`	Does the employee has a special student loan rate?
`Boolean`	`getHasStudentLoanBalance()`	Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR.
`String`	`getIrdNumber()`	The IRD Number.
`Boolean`	`getIsEligibleForKiwiSaver()`	The employee eligibility for KiwiSaver.
`org.threeten.bp.LocalDate`	`getKiwiSaverContributionHolidayEndDate()`	Contribution holiday expiry date or end date.
`EmployeeTax.KiwiSaverContributionsEnum`	`getKiwiSaverContributions()`	Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership
`Double`	`getKiwiSaverEmployeeContributionRatePercentage()`	Employee Contribution percentage.
`Double`	`getKiwiSaverEmployerContributionRatePercentage()`	Employer Contribution percentage.
`Double`	`getKiwiSaverEmployerSalarySacrificeContributionRatePercentage()`	Employer Contribution through Salary Sacrifice percentage.
`org.threeten.bp.LocalDate`	`getKiwiSaverOptOutDate()`	Opt Out Date.
`Double`	`getSpecialStudentLoanRatePercentage()`	The employee student loan rate percentage.
`Double`	`getSpecialTaxRatePercentage()`	Special tax rate percentage.
`org.threeten.bp.LocalDate`	`getStudentLoanAsAt()`	The date of the letter from IR.
`Double`	`getStudentLoanBalance()`	The employee's student loan balance shown on the letter from IR.
`TaxCode`	`getTaxCode()`	Get taxCode
`int`	`hashCode()`
`EmployeeTax`	`hasSpecialStudentLoanRate(Boolean hasSpecialStudentLoanRate)`	Does the employee has a special student loan rate?
`EmployeeTax`	`hasStudentLoanBalance(Boolean hasStudentLoanBalance)`	Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR.
`EmployeeTax`	`irdNumber(String irdNumber)`	The IRD Number.
`EmployeeTax`	`isEligibleForKiwiSaver(Boolean isEligibleForKiwiSaver)`	The employee eligibility for KiwiSaver.
`EmployeeTax`	`kiwiSaverContributionHolidayEndDate(org.threeten.bp.LocalDate kiwiSaverContributionHolidayEndDate)`	Contribution holiday expiry date or end date.
`EmployeeTax`	`kiwiSaverContributions(EmployeeTax.KiwiSaverContributionsEnum kiwiSaverContributions)`	Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership
`EmployeeTax`	`kiwiSaverEmployeeContributionRatePercentage(Double kiwiSaverEmployeeContributionRatePercentage)`	Employee Contribution percentage.
`EmployeeTax`	`kiwiSaverEmployerContributionRatePercentage(Double kiwiSaverEmployerContributionRatePercentage)`	Employer Contribution percentage.
`EmployeeTax`	`kiwiSaverEmployerSalarySacrificeContributionRatePercentage(Double kiwiSaverEmployerSalarySacrificeContributionRatePercentage)`	Employer Contribution through Salary Sacrifice percentage.
`EmployeeTax`	`kiwiSaverOptOutDate(org.threeten.bp.LocalDate kiwiSaverOptOutDate)`	Opt Out Date.
`void`	`setEsctRatePercentage(Double esctRatePercentage)`	Employer superannuation contribution tax rate.
`void`	`setHasSpecialStudentLoanRate(Boolean hasSpecialStudentLoanRate)`	Does the employee has a special student loan rate?
`void`	`setHasStudentLoanBalance(Boolean hasStudentLoanBalance)`	Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR.
`void`	`setIrdNumber(String irdNumber)`	The IRD Number.
`void`	`setIsEligibleForKiwiSaver(Boolean isEligibleForKiwiSaver)`	The employee eligibility for KiwiSaver.
`void`	`setKiwiSaverContributionHolidayEndDate(org.threeten.bp.LocalDate kiwiSaverContributionHolidayEndDate)`	Contribution holiday expiry date or end date.
`void`	`setKiwiSaverContributions(EmployeeTax.KiwiSaverContributionsEnum kiwiSaverContributions)`	Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership
`void`	`setKiwiSaverEmployeeContributionRatePercentage(Double kiwiSaverEmployeeContributionRatePercentage)`	Employee Contribution percentage.
`void`	`setKiwiSaverEmployerContributionRatePercentage(Double kiwiSaverEmployerContributionRatePercentage)`	Employer Contribution percentage.
`void`	`setKiwiSaverEmployerSalarySacrificeContributionRatePercentage(Double kiwiSaverEmployerSalarySacrificeContributionRatePercentage)`	Employer Contribution through Salary Sacrifice percentage.
`void`	`setKiwiSaverOptOutDate(org.threeten.bp.LocalDate kiwiSaverOptOutDate)`	Opt Out Date.
`void`	`setSpecialStudentLoanRatePercentage(Double specialStudentLoanRatePercentage)`	The employee student loan rate percentage.
`void`	`setSpecialTaxRatePercentage(Double specialTaxRatePercentage)`	Special tax rate percentage.
`void`	`setStudentLoanAsAt(org.threeten.bp.LocalDate studentLoanAsAt)`	The date of the letter from IR.
`void`	`setStudentLoanBalance(Double studentLoanBalance)`	The employee's student loan balance shown on the letter from IR.
`void`	`setTaxCode(TaxCode taxCode)`	taxCode
`EmployeeTax`	`specialStudentLoanRatePercentage(Double specialStudentLoanRatePercentage)`	The employee student loan rate percentage.
`EmployeeTax`	`specialTaxRatePercentage(Double specialTaxRatePercentage)`	Special tax rate percentage.
`EmployeeTax`	`studentLoanAsAt(org.threeten.bp.LocalDate studentLoanAsAt)`	The date of the letter from IR.
`EmployeeTax`	`studentLoanBalance(Double studentLoanBalance)`	The employee's student loan balance shown on the letter from IR.
`EmployeeTax`	`taxCode(TaxCode taxCode)`	taxCode
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EmployeeTax
```
public EmployeeTax()
```
- Method Detail
  - irdNumber
```
public EmployeeTax irdNumber(String irdNumber)
```
    The IRD Number.
    
    Parameters:
    
    irdNumber - String
    
    Returns:
    
    EmployeeTax
  - getIrdNumber
```
public String getIrdNumber()
```
    The IRD Number.
    
    Returns:
    
    irdNumber
  - setIrdNumber
```
public void setIrdNumber(String irdNumber)
```
    The IRD Number.
    
    Parameters:
    
    irdNumber - String
  - taxCode
```
public EmployeeTax taxCode(TaxCode taxCode)
```
    taxCode
    
    Parameters:
    
    taxCode - TaxCode
    
    Returns:
    
    EmployeeTax
  - getTaxCode
```
public TaxCode getTaxCode()
```
    Get taxCode
    
    Returns:
    
    taxCode
  - setTaxCode
```
public void setTaxCode(TaxCode taxCode)
```
    taxCode
    
    Parameters:
    
    taxCode - TaxCode
  - specialTaxRatePercentage
```
public EmployeeTax specialTaxRatePercentage(Double specialTaxRatePercentage)
```
    Special tax rate percentage.
    
    Parameters:
    
    specialTaxRatePercentage - Double
    
    Returns:
    
    EmployeeTax
  - getSpecialTaxRatePercentage
```
public Double getSpecialTaxRatePercentage()
```
    Special tax rate percentage.
    
    Returns:
    
    specialTaxRatePercentage
  - setSpecialTaxRatePercentage
```
public void setSpecialTaxRatePercentage(Double specialTaxRatePercentage)
```
    Special tax rate percentage.
    
    Parameters:
    
    specialTaxRatePercentage - Double
  - hasSpecialStudentLoanRate
```
public EmployeeTax hasSpecialStudentLoanRate(Boolean hasSpecialStudentLoanRate)
```
    Does the employee has a special student loan rate?
    
    Parameters:
    
    hasSpecialStudentLoanRate - Boolean
    
    Returns:
    
    EmployeeTax
  - getHasSpecialStudentLoanRate
```
public Boolean getHasSpecialStudentLoanRate()
```
    Does the employee has a special student loan rate?
    
    Returns:
    
    hasSpecialStudentLoanRate
  - setHasSpecialStudentLoanRate
```
public void setHasSpecialStudentLoanRate(Boolean hasSpecialStudentLoanRate)
```
    Does the employee has a special student loan rate?
    
    Parameters:
    
    hasSpecialStudentLoanRate - Boolean
  - specialStudentLoanRatePercentage
```
public EmployeeTax specialStudentLoanRatePercentage(Double specialStudentLoanRatePercentage)
```
    The employee student loan rate percentage.
    
    Parameters:
    
    specialStudentLoanRatePercentage - Double
    
    Returns:
    
    EmployeeTax
  - getSpecialStudentLoanRatePercentage
```
public Double getSpecialStudentLoanRatePercentage()
```
    The employee student loan rate percentage.
    
    Returns:
    
    specialStudentLoanRatePercentage
  - setSpecialStudentLoanRatePercentage
```
public void setSpecialStudentLoanRatePercentage(Double specialStudentLoanRatePercentage)
```
    The employee student loan rate percentage.
    
    Parameters:
    
    specialStudentLoanRatePercentage - Double
  - isEligibleForKiwiSaver
```
public EmployeeTax isEligibleForKiwiSaver(Boolean isEligibleForKiwiSaver)
```
    The employee eligibility for KiwiSaver.
    
    Parameters:
    
    isEligibleForKiwiSaver - Boolean
    
    Returns:
    
    EmployeeTax
  - getIsEligibleForKiwiSaver
```
public Boolean getIsEligibleForKiwiSaver()
```
    The employee eligibility for KiwiSaver.
    
    Returns:
    
    isEligibleForKiwiSaver
  - setIsEligibleForKiwiSaver
```
public void setIsEligibleForKiwiSaver(Boolean isEligibleForKiwiSaver)
```
    The employee eligibility for KiwiSaver.
    
    Parameters:
    
    isEligibleForKiwiSaver - Boolean
  - esctRatePercentage
```
public EmployeeTax esctRatePercentage(Double esctRatePercentage)
```
    Employer superannuation contribution tax rate.
    
    Parameters:
    
    esctRatePercentage - Double
    
    Returns:
    
    EmployeeTax
  - getEsctRatePercentage
```
public Double getEsctRatePercentage()
```
    Employer superannuation contribution tax rate.
    
    Returns:
    
    esctRatePercentage
  - setEsctRatePercentage
```
public void setEsctRatePercentage(Double esctRatePercentage)
```
    Employer superannuation contribution tax rate.
    
    Parameters:
    
    esctRatePercentage - Double
  - kiwiSaverContributions
```
public EmployeeTax kiwiSaverContributions(EmployeeTax.KiwiSaverContributionsEnum kiwiSaverContributions)
```
    Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership
    
    Parameters:
    
    kiwiSaverContributions - KiwiSaverContributionsEnum
    
    Returns:
    
    EmployeeTax
  - getKiwiSaverContributions
```
public EmployeeTax.KiwiSaverContributionsEnum getKiwiSaverContributions()
```
    Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership
    
    Returns:
    
    kiwiSaverContributions
  - setKiwiSaverContributions
```
public void setKiwiSaverContributions(EmployeeTax.KiwiSaverContributionsEnum kiwiSaverContributions)
```
    Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership
    
    Parameters:
    
    kiwiSaverContributions - KiwiSaverContributionsEnum
  - kiwiSaverEmployeeContributionRatePercentage
```
public EmployeeTax kiwiSaverEmployeeContributionRatePercentage(Double kiwiSaverEmployeeContributionRatePercentage)
```
    Employee Contribution percentage.
    
    Parameters:
    
    kiwiSaverEmployeeContributionRatePercentage - Double
    
    Returns:
    
    EmployeeTax
  - getKiwiSaverEmployeeContributionRatePercentage
```
public Double getKiwiSaverEmployeeContributionRatePercentage()
```
    Employee Contribution percentage.
    
    Returns:
    
    kiwiSaverEmployeeContributionRatePercentage
  - setKiwiSaverEmployeeContributionRatePercentage
```
public void setKiwiSaverEmployeeContributionRatePercentage(Double kiwiSaverEmployeeContributionRatePercentage)
```
    Employee Contribution percentage.
    
    Parameters:
    
    kiwiSaverEmployeeContributionRatePercentage - Double
  - kiwiSaverEmployerContributionRatePercentage
```
public EmployeeTax kiwiSaverEmployerContributionRatePercentage(Double kiwiSaverEmployerContributionRatePercentage)
```
    Employer Contribution percentage.
    
    Parameters:
    
    kiwiSaverEmployerContributionRatePercentage - Double
    
    Returns:
    
    EmployeeTax
  - getKiwiSaverEmployerContributionRatePercentage
```
public Double getKiwiSaverEmployerContributionRatePercentage()
```
    Employer Contribution percentage.
    
    Returns:
    
    kiwiSaverEmployerContributionRatePercentage
  - setKiwiSaverEmployerContributionRatePercentage
```
public void setKiwiSaverEmployerContributionRatePercentage(Double kiwiSaverEmployerContributionRatePercentage)
```
    Employer Contribution percentage.
    
    Parameters:
    
    kiwiSaverEmployerContributionRatePercentage - Double
  - kiwiSaverEmployerSalarySacrificeContributionRatePercentage
```
public EmployeeTax kiwiSaverEmployerSalarySacrificeContributionRatePercentage(Double kiwiSaverEmployerSalarySacrificeContributionRatePercentage)
```
    Employer Contribution through Salary Sacrifice percentage.
    
    Parameters:
    
    kiwiSaverEmployerSalarySacrificeContributionRatePercentage - Double
    
    Returns:
    
    EmployeeTax
  - getKiwiSaverEmployerSalarySacrificeContributionRatePercentage
```
public Double getKiwiSaverEmployerSalarySacrificeContributionRatePercentage()
```
    Employer Contribution through Salary Sacrifice percentage.
    
    Returns:
    
    kiwiSaverEmployerSalarySacrificeContributionRatePercentage
  - setKiwiSaverEmployerSalarySacrificeContributionRatePercentage
```
public void setKiwiSaverEmployerSalarySacrificeContributionRatePercentage(Double kiwiSaverEmployerSalarySacrificeContributionRatePercentage)
```
    Employer Contribution through Salary Sacrifice percentage.
    
    Parameters:
    
    kiwiSaverEmployerSalarySacrificeContributionRatePercentage - Double
  - kiwiSaverOptOutDate
```
public EmployeeTax kiwiSaverOptOutDate(org.threeten.bp.LocalDate kiwiSaverOptOutDate)
```
    Opt Out Date.
    
    Parameters:
    
    kiwiSaverOptOutDate - LocalDate
    
    Returns:
    
    EmployeeTax
  - getKiwiSaverOptOutDate
```
public org.threeten.bp.LocalDate getKiwiSaverOptOutDate()
```
    Opt Out Date.
    
    Returns:
    
    kiwiSaverOptOutDate
  - setKiwiSaverOptOutDate
```
public void setKiwiSaverOptOutDate(org.threeten.bp.LocalDate kiwiSaverOptOutDate)
```
    Opt Out Date.
    
    Parameters:
    
    kiwiSaverOptOutDate - LocalDate
  - kiwiSaverContributionHolidayEndDate
```
public EmployeeTax kiwiSaverContributionHolidayEndDate(org.threeten.bp.LocalDate kiwiSaverContributionHolidayEndDate)
```
    Contribution holiday expiry date or end date.
    
    Parameters:
    
    kiwiSaverContributionHolidayEndDate - LocalDate
    
    Returns:
    
    EmployeeTax
  - getKiwiSaverContributionHolidayEndDate
```
public org.threeten.bp.LocalDate getKiwiSaverContributionHolidayEndDate()
```
    Contribution holiday expiry date or end date.
    
    Returns:
    
    kiwiSaverContributionHolidayEndDate
  - setKiwiSaverContributionHolidayEndDate
```
public void setKiwiSaverContributionHolidayEndDate(org.threeten.bp.LocalDate kiwiSaverContributionHolidayEndDate)
```
    Contribution holiday expiry date or end date.
    
    Parameters:
    
    kiwiSaverContributionHolidayEndDate - LocalDate
  - hasStudentLoanBalance
```
public EmployeeTax hasStudentLoanBalance(Boolean hasStudentLoanBalance)
```
    Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR.
    
    Parameters:
    
    hasStudentLoanBalance - Boolean
    
    Returns:
    
    EmployeeTax
  - getHasStudentLoanBalance
```
public Boolean getHasStudentLoanBalance()
```
    Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR.
    
    Returns:
    
    hasStudentLoanBalance
  - setHasStudentLoanBalance
```
public void setHasStudentLoanBalance(Boolean hasStudentLoanBalance)
```
    Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR.
    
    Parameters:
    
    hasStudentLoanBalance - Boolean
  - studentLoanBalance
```
public EmployeeTax studentLoanBalance(Double studentLoanBalance)
```
    The employee's student loan balance shown on the letter from IR.
    
    Parameters:
    
    studentLoanBalance - Double
    
    Returns:
    
    EmployeeTax
  - getStudentLoanBalance
```
public Double getStudentLoanBalance()
```
    The employee's student loan balance shown on the letter from IR.
    
    Returns:
    
    studentLoanBalance
  - setStudentLoanBalance
```
public void setStudentLoanBalance(Double studentLoanBalance)
```
    The employee's student loan balance shown on the letter from IR.
    
    Parameters:
    
    studentLoanBalance - Double
  - studentLoanAsAt
```
public EmployeeTax studentLoanAsAt(org.threeten.bp.LocalDate studentLoanAsAt)
```
    The date of the letter from IR.
    
    Parameters:
    
    studentLoanAsAt - LocalDate
    
    Returns:
    
    EmployeeTax
  - getStudentLoanAsAt
```
public org.threeten.bp.LocalDate getStudentLoanAsAt()
```
    The date of the letter from IR.
    
    Returns:
    
    studentLoanAsAt
  - setStudentLoanAsAt
```
public void setStudentLoanAsAt(org.threeten.bp.LocalDate studentLoanAsAt)
```
    The date of the letter from IR.
    
    Parameters:
    
    studentLoanAsAt - LocalDate
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class EmployeeTax

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EmployeeTax

Method Detail

irdNumber

getIrdNumber

setIrdNumber

taxCode

getTaxCode

setTaxCode

specialTaxRatePercentage

getSpecialTaxRatePercentage

setSpecialTaxRatePercentage

hasSpecialStudentLoanRate

getHasSpecialStudentLoanRate

setHasSpecialStudentLoanRate

specialStudentLoanRatePercentage

getSpecialStudentLoanRatePercentage

setSpecialStudentLoanRatePercentage

isEligibleForKiwiSaver

getIsEligibleForKiwiSaver

setIsEligibleForKiwiSaver

esctRatePercentage

getEsctRatePercentage

setEsctRatePercentage

kiwiSaverContributions

getKiwiSaverContributions

setKiwiSaverContributions

kiwiSaverEmployeeContributionRatePercentage

getKiwiSaverEmployeeContributionRatePercentage

setKiwiSaverEmployeeContributionRatePercentage

kiwiSaverEmployerContributionRatePercentage

getKiwiSaverEmployerContributionRatePercentage

setKiwiSaverEmployerContributionRatePercentage

kiwiSaverEmployerSalarySacrificeContributionRatePercentage

getKiwiSaverEmployerSalarySacrificeContributionRatePercentage

setKiwiSaverEmployerSalarySacrificeContributionRatePercentage

kiwiSaverOptOutDate

getKiwiSaverOptOutDate

setKiwiSaverOptOutDate

kiwiSaverContributionHolidayEndDate

getKiwiSaverContributionHolidayEndDate

setKiwiSaverContributionHolidayEndDate

hasStudentLoanBalance

getHasStudentLoanBalance

setHasStudentLoanBalance

studentLoanBalance

getStudentLoanBalance

setStudentLoanBalance

studentLoanAsAt

getStudentLoanAsAt

setStudentLoanAsAt

equals

hashCode

toString