java.lang.Object
- com.xero.models.payrollau.TaxDeclaration

public class TaxDeclaration
extends Object

TaxDeclaration

Constructor Summary

Constructors
Constructor Description

TaxDeclaration()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TaxDeclaration`	`approvedWithholdingVariationPercentage(BigDecimal approvedWithholdingVariationPercentage)`	If the employee has approved withholding variation.
`TaxDeclaration`	`australianResidentForTaxPurposes(Boolean australianResidentForTaxPurposes)`	If the employee is Australian resident for tax purposes.
`TaxDeclaration`	`eligibleToReceiveLeaveLoading(Boolean eligibleToReceiveLeaveLoading)`	If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%).
`TaxDeclaration`	`employeeID(UUID employeeID)`	Address line 1 for employee home address
`TaxDeclaration`	`employmentBasis(EmploymentBasis employmentBasis)`	employmentBasis
`boolean`	`equals(Object o)`
`BigDecimal`	`getApprovedWithholdingVariationPercentage()`	If the employee has approved withholding variation.
`Boolean`	`getAustralianResidentForTaxPurposes()`	If the employee is Australian resident for tax purposes.
`Boolean`	`getEligibleToReceiveLeaveLoading()`	If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%).
`UUID`	`getEmployeeID()`	Address line 1 for employee home address
`EmploymentBasis`	`getEmploymentBasis()`	Get employmentBasis
`Boolean`	`getHasHELPDebt()`	If employee has HECS or HELP debt.
`Boolean`	`getHasSFSSDebt()`	If employee has financial supplement debt.
`Boolean`	`getHasStudentStartupLoan()`	If the employee is eligible for student startup loan rules
`Boolean`	`getHasTradeSupportLoanDebt()`	If employee has trade support loan.
`ResidencyStatus`	`getResidencyStatus()`	Get residencyStatus
`String`	`getTaxFileNumber()`	The tax file number e.g 123123123.
`Boolean`	`getTaxFreeThresholdClaimed()`	If tax free threshold claimed.
`BigDecimal`	`getTaxOffsetEstimatedAmount()`	If has tax offset estimated then the tax offset estimated amount.
`TFNExemptionType`	`getTfNExemptionType()`	Get tfNExemptionType
`String`	`getUpdatedDateUTC()`	Last modified timestamp
`org.threeten.bp.OffsetDateTime`	`getUpdatedDateUTCAsDate()`	Last modified timestamp
`BigDecimal`	`getUpwardVariationTaxWithholdingAmount()`	If the employee has requested that additional tax be withheld each pay run.
`int`	`hashCode()`
`TaxDeclaration`	`hasHELPDebt(Boolean hasHELPDebt)`	If employee has HECS or HELP debt.
`TaxDeclaration`	`hasSFSSDebt(Boolean hasSFSSDebt)`	If employee has financial supplement debt.
`TaxDeclaration`	`hasStudentStartupLoan(Boolean hasStudentStartupLoan)`	If the employee is eligible for student startup loan rules
`TaxDeclaration`	`hasTradeSupportLoanDebt(Boolean hasTradeSupportLoanDebt)`	If employee has trade support loan.
`TaxDeclaration`	`residencyStatus(ResidencyStatus residencyStatus)`	residencyStatus
`void`	`setApprovedWithholdingVariationPercentage(BigDecimal approvedWithholdingVariationPercentage)`	If the employee has approved withholding variation.
`void`	`setAustralianResidentForTaxPurposes(Boolean australianResidentForTaxPurposes)`	If the employee is Australian resident for tax purposes.
`void`	`setEligibleToReceiveLeaveLoading(Boolean eligibleToReceiveLeaveLoading)`	If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%).
`void`	`setEmployeeID(UUID employeeID)`	Address line 1 for employee home address
`void`	`setEmploymentBasis(EmploymentBasis employmentBasis)`	employmentBasis
`void`	`setHasHELPDebt(Boolean hasHELPDebt)`	If employee has HECS or HELP debt.
`void`	`setHasSFSSDebt(Boolean hasSFSSDebt)`	If employee has financial supplement debt.
`void`	`setHasStudentStartupLoan(Boolean hasStudentStartupLoan)`	If the employee is eligible for student startup loan rules
`void`	`setHasTradeSupportLoanDebt(Boolean hasTradeSupportLoanDebt)`	If employee has trade support loan.
`void`	`setResidencyStatus(ResidencyStatus residencyStatus)`	residencyStatus
`void`	`setTaxFileNumber(String taxFileNumber)`	The tax file number e.g 123123123.
`void`	`setTaxFreeThresholdClaimed(Boolean taxFreeThresholdClaimed)`	If tax free threshold claimed.
`void`	`setTaxOffsetEstimatedAmount(BigDecimal taxOffsetEstimatedAmount)`	If has tax offset estimated then the tax offset estimated amount.
`void`	`setTfNExemptionType(TFNExemptionType tfNExemptionType)`	tfNExemptionType
`void`	`setUpwardVariationTaxWithholdingAmount(BigDecimal upwardVariationTaxWithholdingAmount)`	If the employee has requested that additional tax be withheld each pay run.
`TaxDeclaration`	`taxFileNumber(String taxFileNumber)`	The tax file number e.g 123123123.
`TaxDeclaration`	`taxFreeThresholdClaimed(Boolean taxFreeThresholdClaimed)`	If tax free threshold claimed.
`TaxDeclaration`	`taxOffsetEstimatedAmount(BigDecimal taxOffsetEstimatedAmount)`	If has tax offset estimated then the tax offset estimated amount.
`TaxDeclaration`	`tfNExemptionType(TFNExemptionType tfNExemptionType)`	tfNExemptionType
`String`	`toString()`
`TaxDeclaration`	`upwardVariationTaxWithholdingAmount(BigDecimal upwardVariationTaxWithholdingAmount)`	If the employee has requested that additional tax be withheld each pay run.

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

- Constructor Detail
  - TaxDeclaration
```
public TaxDeclaration()
```
- Method Detail
  - employeeID
```
public TaxDeclaration employeeID(UUID employeeID)
```
    Address line 1 for employee home address
    
    Parameters:
    
    employeeID - UUID
    
    Returns:
    
    TaxDeclaration
  - getEmployeeID
```
public UUID getEmployeeID()
```
    Address line 1 for employee home address
    
    Returns:
    
    employeeID
  - setEmployeeID
```
public void setEmployeeID(UUID employeeID)
```
    Address line 1 for employee home address
    
    Parameters:
    
    employeeID - UUID
  - employmentBasis
```
public TaxDeclaration employmentBasis(EmploymentBasis employmentBasis)
```
    employmentBasis
    
    Parameters:
    
    employmentBasis - EmploymentBasis
    
    Returns:
    
    TaxDeclaration
  - getEmploymentBasis
```
public EmploymentBasis getEmploymentBasis()
```
    Get employmentBasis
    
    Returns:
    
    employmentBasis
  - setEmploymentBasis
```
public void setEmploymentBasis(EmploymentBasis employmentBasis)
```
    employmentBasis
    
    Parameters:
    
    employmentBasis - EmploymentBasis
  - tfNExemptionType
```
public TaxDeclaration tfNExemptionType(TFNExemptionType tfNExemptionType)
```
    tfNExemptionType
    
    Parameters:
    
    tfNExemptionType - TFNExemptionType
    
    Returns:
    
    TaxDeclaration
  - getTfNExemptionType
```
public TFNExemptionType getTfNExemptionType()
```
    Get tfNExemptionType
    
    Returns:
    
    tfNExemptionType
  - setTfNExemptionType
```
public void setTfNExemptionType(TFNExemptionType tfNExemptionType)
```
    tfNExemptionType
    
    Parameters:
    
    tfNExemptionType - TFNExemptionType
  - taxFileNumber
```
public TaxDeclaration taxFileNumber(String taxFileNumber)
```
    The tax file number e.g 123123123.
    
    Parameters:
    
    taxFileNumber - String
    
    Returns:
    
    TaxDeclaration
  - getTaxFileNumber
```
public String getTaxFileNumber()
```
    The tax file number e.g 123123123.
    
    Returns:
    
    taxFileNumber
  - setTaxFileNumber
```
public void setTaxFileNumber(String taxFileNumber)
```
    The tax file number e.g 123123123.
    
    Parameters:
    
    taxFileNumber - String
  - australianResidentForTaxPurposes
```
public TaxDeclaration australianResidentForTaxPurposes(Boolean australianResidentForTaxPurposes)
```
    If the employee is Australian resident for tax purposes. e.g true or false
    
    Parameters:
    
    australianResidentForTaxPurposes - Boolean
    
    Returns:
    
    TaxDeclaration
  - getAustralianResidentForTaxPurposes
```
public Boolean getAustralianResidentForTaxPurposes()
```
    If the employee is Australian resident for tax purposes. e.g true or false
    
    Returns:
    
    australianResidentForTaxPurposes
  - setAustralianResidentForTaxPurposes
```
public void setAustralianResidentForTaxPurposes(Boolean australianResidentForTaxPurposes)
```
    If the employee is Australian resident for tax purposes. e.g true or false
    
    Parameters:
    
    australianResidentForTaxPurposes - Boolean
  - residencyStatus
```
public TaxDeclaration residencyStatus(ResidencyStatus residencyStatus)
```
    residencyStatus
    
    Parameters:
    
    residencyStatus - ResidencyStatus
    
    Returns:
    
    TaxDeclaration
  - getResidencyStatus
```
public ResidencyStatus getResidencyStatus()
```
    Get residencyStatus
    
    Returns:
    
    residencyStatus
  - setResidencyStatus
```
public void setResidencyStatus(ResidencyStatus residencyStatus)
```
    residencyStatus
    
    Parameters:
    
    residencyStatus - ResidencyStatus
  - taxFreeThresholdClaimed
```
public TaxDeclaration taxFreeThresholdClaimed(Boolean taxFreeThresholdClaimed)
```
    If tax free threshold claimed. e.g true or false
    
    Parameters:
    
    taxFreeThresholdClaimed - Boolean
    
    Returns:
    
    TaxDeclaration
  - getTaxFreeThresholdClaimed
```
public Boolean getTaxFreeThresholdClaimed()
```
    If tax free threshold claimed. e.g true or false
    
    Returns:
    
    taxFreeThresholdClaimed
  - setTaxFreeThresholdClaimed
```
public void setTaxFreeThresholdClaimed(Boolean taxFreeThresholdClaimed)
```
    If tax free threshold claimed. e.g true or false
    
    Parameters:
    
    taxFreeThresholdClaimed - Boolean
  - taxOffsetEstimatedAmount
```
public TaxDeclaration taxOffsetEstimatedAmount(BigDecimal taxOffsetEstimatedAmount)
```
    If has tax offset estimated then the tax offset estimated amount. e.g 100
    
    Parameters:
    
    taxOffsetEstimatedAmount - BigDecimal
    
    Returns:
    
    TaxDeclaration
  - getTaxOffsetEstimatedAmount
```
public BigDecimal getTaxOffsetEstimatedAmount()
```
    If has tax offset estimated then the tax offset estimated amount. e.g 100
    
    Returns:
    
    taxOffsetEstimatedAmount
  - setTaxOffsetEstimatedAmount
```
public void setTaxOffsetEstimatedAmount(BigDecimal taxOffsetEstimatedAmount)
```
    If has tax offset estimated then the tax offset estimated amount. e.g 100
    
    Parameters:
    
    taxOffsetEstimatedAmount - BigDecimal
  - hasHELPDebt
```
public TaxDeclaration hasHELPDebt(Boolean hasHELPDebt)
```
    If employee has HECS or HELP debt. e.g true or false
    
    Parameters:
    
    hasHELPDebt - Boolean
    
    Returns:
    
    TaxDeclaration
  - getHasHELPDebt
```
public Boolean getHasHELPDebt()
```
    If employee has HECS or HELP debt. e.g true or false
    
    Returns:
    
    hasHELPDebt
  - setHasHELPDebt
```
public void setHasHELPDebt(Boolean hasHELPDebt)
```
    If employee has HECS or HELP debt. e.g true or false
    
    Parameters:
    
    hasHELPDebt - Boolean
  - hasSFSSDebt
```
public TaxDeclaration hasSFSSDebt(Boolean hasSFSSDebt)
```
    If employee has financial supplement debt. e.g true or false
    
    Parameters:
    
    hasSFSSDebt - Boolean
    
    Returns:
    
    TaxDeclaration
  - getHasSFSSDebt
```
public Boolean getHasSFSSDebt()
```
    If employee has financial supplement debt. e.g true or false
    
    Returns:
    
    hasSFSSDebt
  - setHasSFSSDebt
```
public void setHasSFSSDebt(Boolean hasSFSSDebt)
```
    If employee has financial supplement debt. e.g true or false
    
    Parameters:
    
    hasSFSSDebt - Boolean
  - hasTradeSupportLoanDebt
```
public TaxDeclaration hasTradeSupportLoanDebt(Boolean hasTradeSupportLoanDebt)
```
    If employee has trade support loan. e.g true or false
    
    Parameters:
    
    hasTradeSupportLoanDebt - Boolean
    
    Returns:
    
    TaxDeclaration
  - getHasTradeSupportLoanDebt
```
public Boolean getHasTradeSupportLoanDebt()
```
    If employee has trade support loan. e.g true or false
    
    Returns:
    
    hasTradeSupportLoanDebt
  - setHasTradeSupportLoanDebt
```
public void setHasTradeSupportLoanDebt(Boolean hasTradeSupportLoanDebt)
```
    If employee has trade support loan. e.g true or false
    
    Parameters:
    
    hasTradeSupportLoanDebt - Boolean
  - upwardVariationTaxWithholdingAmount
```
public TaxDeclaration upwardVariationTaxWithholdingAmount(BigDecimal upwardVariationTaxWithholdingAmount)
```
    If the employee has requested that additional tax be withheld each pay run. e.g 50
    
    Parameters:
    
    upwardVariationTaxWithholdingAmount - BigDecimal
    
    Returns:
    
    TaxDeclaration
  - getUpwardVariationTaxWithholdingAmount
```
public BigDecimal getUpwardVariationTaxWithholdingAmount()
```
    If the employee has requested that additional tax be withheld each pay run. e.g 50
    
    Returns:
    
    upwardVariationTaxWithholdingAmount
  - setUpwardVariationTaxWithholdingAmount
```
public void setUpwardVariationTaxWithholdingAmount(BigDecimal upwardVariationTaxWithholdingAmount)
```
    If the employee has requested that additional tax be withheld each pay run. e.g 50
    
    Parameters:
    
    upwardVariationTaxWithholdingAmount - BigDecimal
  - eligibleToReceiveLeaveLoading
```
public TaxDeclaration eligibleToReceiveLeaveLoading(Boolean eligibleToReceiveLeaveLoading)
```
    If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false
    
    Parameters:
    
    eligibleToReceiveLeaveLoading - Boolean
    
    Returns:
    
    TaxDeclaration
  - getEligibleToReceiveLeaveLoading
```
public Boolean getEligibleToReceiveLeaveLoading()
```
    If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false
    
    Returns:
    
    eligibleToReceiveLeaveLoading
  - setEligibleToReceiveLeaveLoading
```
public void setEligibleToReceiveLeaveLoading(Boolean eligibleToReceiveLeaveLoading)
```
    If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%). e.g true or false
    
    Parameters:
    
    eligibleToReceiveLeaveLoading - Boolean
  - approvedWithholdingVariationPercentage
```
public TaxDeclaration approvedWithholdingVariationPercentage(BigDecimal approvedWithholdingVariationPercentage)
```
    If the employee has approved withholding variation. e.g (0 - 100)
    
    Parameters:
    
    approvedWithholdingVariationPercentage - BigDecimal
    
    Returns:
    
    TaxDeclaration
  - getApprovedWithholdingVariationPercentage
```
public BigDecimal getApprovedWithholdingVariationPercentage()
```
    If the employee has approved withholding variation. e.g (0 - 100)
    
    Returns:
    
    approvedWithholdingVariationPercentage
  - setApprovedWithholdingVariationPercentage
```
public void setApprovedWithholdingVariationPercentage(BigDecimal approvedWithholdingVariationPercentage)
```
    If the employee has approved withholding variation. e.g (0 - 100)
    
    Parameters:
    
    approvedWithholdingVariationPercentage - BigDecimal
  - hasStudentStartupLoan
```
public TaxDeclaration hasStudentStartupLoan(Boolean hasStudentStartupLoan)
```
    If the employee is eligible for student startup loan rules
    
    Parameters:
    
    hasStudentStartupLoan - Boolean
    
    Returns:
    
    TaxDeclaration
  - getHasStudentStartupLoan
```
public Boolean getHasStudentStartupLoan()
```
    If the employee is eligible for student startup loan rules
    
    Returns:
    
    hasStudentStartupLoan
  - setHasStudentStartupLoan
```
public void setHasStudentStartupLoan(Boolean hasStudentStartupLoan)
```
    If the employee is eligible for student startup loan rules
    
    Parameters:
    
    hasStudentStartupLoan - Boolean
  - getUpdatedDateUTC
```
public String getUpdatedDateUTC()
```
    Last modified timestamp
    
    Returns:
    
    updatedDateUTC
  - getUpdatedDateUTCAsDate
```
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()
```
    Last modified timestamp
    
    Returns:
    
    OffsetDateTime
  - 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 TaxDeclaration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TaxDeclaration

Method Detail

employeeID

getEmployeeID

setEmployeeID

employmentBasis

getEmploymentBasis

setEmploymentBasis

tfNExemptionType

getTfNExemptionType

setTfNExemptionType

taxFileNumber

getTaxFileNumber

setTaxFileNumber

australianResidentForTaxPurposes

getAustralianResidentForTaxPurposes

setAustralianResidentForTaxPurposes

residencyStatus

getResidencyStatus

setResidencyStatus

taxFreeThresholdClaimed

getTaxFreeThresholdClaimed

setTaxFreeThresholdClaimed

taxOffsetEstimatedAmount

getTaxOffsetEstimatedAmount

setTaxOffsetEstimatedAmount

hasHELPDebt

getHasHELPDebt

setHasHELPDebt

hasSFSSDebt

getHasSFSSDebt

setHasSFSSDebt

hasTradeSupportLoanDebt

getHasTradeSupportLoanDebt

setHasTradeSupportLoanDebt

upwardVariationTaxWithholdingAmount

getUpwardVariationTaxWithholdingAmount

setUpwardVariationTaxWithholdingAmount

eligibleToReceiveLeaveLoading

getEligibleToReceiveLeaveLoading

setEligibleToReceiveLeaveLoading

approvedWithholdingVariationPercentage

getApprovedWithholdingVariationPercentage

setApprovedWithholdingVariationPercentage

hasStudentStartupLoan

getHasStudentStartupLoan

setHasStudentStartupLoan

getUpdatedDateUTC

getUpdatedDateUTCAsDate

equals

hashCode

toString