Package com.xero.models.payrollau
Class TaxDeclaration
java.lang.Object
com.xero.models.payrollau.TaxDeclaration
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value.approvedWithholdingVariationPercentage(BigDecimal approvedWithholdingVariationPercentage) If the employee has approved withholding variation.australianResidentForTaxPurposes(Boolean australianResidentForTaxPurposes) If the employee is Australian resident for tax purposes.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%).employeeID(UUID employeeID) Address line 1 for employee home addressemploymentBasis(EmploymentBasis employmentBasis) employmentBasisbooleangetABN()11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value.If the employee has approved withholding variation.If the employee is Australian resident for tax purposes.If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%).Address line 1 for employee home addressGet employmentBasisIf employee has HECS or HELP debt.If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)If employee has financial supplement debt.If the employee is eligible for student startup loan rulesIf employee has trade support loan.Get residencyStatusGet seniorMaritalStatusThe tax file number e.g 123123123.If tax free threshold claimed.If has tax offset estimated then the tax offset estimated amount.Get taxScaleTypeGet tfNExemptionTypeLast modified timestamporg.threeten.bp.OffsetDateTimeLast modified timestampIf the employee has requested that additional tax be withheld each pay run.Get workConditioninthashCode()hasHELPDebt(Boolean hasHELPDebt) If employee has HECS or HELP debt.hasLoanOrStudentDebt(Boolean hasLoanOrStudentDebt) If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)hasSFSSDebt(Boolean hasSFSSDebt) If employee has financial supplement debt.hasStudentStartupLoan(Boolean hasStudentStartupLoan) If the employee is eligible for student startup loan ruleshasTradeSupportLoanDebt(Boolean hasTradeSupportLoanDebt) If employee has trade support loan.residencyStatus(ResidencyStatus residencyStatus) residencyStatusseniorMaritalStatus(SeniorMaritalStatus seniorMaritalStatus) seniorMaritalStatusvoid11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value.voidsetApprovedWithholdingVariationPercentage(BigDecimal approvedWithholdingVariationPercentage) If the employee has approved withholding variation.voidsetAustralianResidentForTaxPurposes(Boolean australianResidentForTaxPurposes) If the employee is Australian resident for tax purposes.voidsetEligibleToReceiveLeaveLoading(Boolean eligibleToReceiveLeaveLoading) If the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%).voidsetEmployeeID(UUID employeeID) Address line 1 for employee home addressvoidsetEmploymentBasis(EmploymentBasis employmentBasis) employmentBasisvoidsetHasHELPDebt(Boolean hasHELPDebt) If employee has HECS or HELP debt.voidsetHasLoanOrStudentDebt(Boolean hasLoanOrStudentDebt) If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)voidsetHasSFSSDebt(Boolean hasSFSSDebt) If employee has financial supplement debt.voidsetHasStudentStartupLoan(Boolean hasStudentStartupLoan) If the employee is eligible for student startup loan rulesvoidsetHasTradeSupportLoanDebt(Boolean hasTradeSupportLoanDebt) If employee has trade support loan.voidsetResidencyStatus(ResidencyStatus residencyStatus) residencyStatusvoidsetSeniorMaritalStatus(SeniorMaritalStatus seniorMaritalStatus) seniorMaritalStatusvoidsetTaxFileNumber(String taxFileNumber) The tax file number e.g 123123123.voidsetTaxFreeThresholdClaimed(Boolean taxFreeThresholdClaimed) If tax free threshold claimed.voidsetTaxOffsetEstimatedAmount(BigDecimal taxOffsetEstimatedAmount) If has tax offset estimated then the tax offset estimated amount.voidsetTaxScaleType(TaxScaleType taxScaleType) taxScaleTypevoidsetTfNExemptionType(TFNExemptionType tfNExemptionType) tfNExemptionTypevoidsetUpwardVariationTaxWithholdingAmount(BigDecimal upwardVariationTaxWithholdingAmount) If the employee has requested that additional tax be withheld each pay run.voidsetWorkCondition(WorkCondition workCondition) workConditiontaxFileNumber(String taxFileNumber) The tax file number e.g 123123123.taxFreeThresholdClaimed(Boolean taxFreeThresholdClaimed) If tax free threshold claimed.taxOffsetEstimatedAmount(BigDecimal taxOffsetEstimatedAmount) If has tax offset estimated then the tax offset estimated amount.taxScaleType(TaxScaleType taxScaleType) taxScaleTypetfNExemptionType(TFNExemptionType tfNExemptionType) tfNExemptionTypetoString()upwardVariationTaxWithholdingAmount(BigDecimal upwardVariationTaxWithholdingAmount) If the employee has requested that additional tax be withheld each pay run.workCondition(WorkCondition workCondition) workCondition
-
Constructor Details
-
TaxDeclaration
public TaxDeclaration()
-
-
Method Details
-
employeeID
Address line 1 for employee home address- Parameters:
employeeID- UUID- Returns:
- TaxDeclaration
-
getEmployeeID
-
setEmployeeID
Address line 1 for employee home address- Parameters:
employeeID- UUID
-
employmentBasis
employmentBasis- Parameters:
employmentBasis- EmploymentBasis- Returns:
- TaxDeclaration
-
getEmploymentBasis
-
setEmploymentBasis
employmentBasis- Parameters:
employmentBasis- EmploymentBasis
-
tfNExemptionType
tfNExemptionType- Parameters:
tfNExemptionType- TFNExemptionType- Returns:
- TaxDeclaration
-
getTfNExemptionType
-
setTfNExemptionType
tfNExemptionType- Parameters:
tfNExemptionType- TFNExemptionType
-
taxFileNumber
The tax file number e.g 123123123.- Parameters:
taxFileNumber- String- Returns:
- TaxDeclaration
-
getTaxFileNumber
-
setTaxFileNumber
The tax file number e.g 123123123.- Parameters:
taxFileNumber- String
-
ABN
11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE.- Parameters:
ABN- String- Returns:
- TaxDeclaration
-
getABN
11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE.- Returns:
- ABN
-
setABN
11-digit Australian Business Number e.g 21006819692 or an empty string (\"\") to unset a previously set value. Only applicable, and mandatory if income type is NONEMPLOYEE.- Parameters:
ABN- String
-
australianResidentForTaxPurposes
If the employee is Australian resident for tax purposes. e.g true or false- Parameters:
australianResidentForTaxPurposes- Boolean- Returns:
- TaxDeclaration
-
getAustralianResidentForTaxPurposes
If the employee is Australian resident for tax purposes. e.g true or false- Returns:
- australianResidentForTaxPurposes
-
setAustralianResidentForTaxPurposes
If the employee is Australian resident for tax purposes. e.g true or false- Parameters:
australianResidentForTaxPurposes- Boolean
-
residencyStatus
residencyStatus- Parameters:
residencyStatus- ResidencyStatus- Returns:
- TaxDeclaration
-
getResidencyStatus
-
setResidencyStatus
residencyStatus- Parameters:
residencyStatus- ResidencyStatus
-
taxScaleType
taxScaleType- Parameters:
taxScaleType- TaxScaleType- Returns:
- TaxDeclaration
-
getTaxScaleType
-
setTaxScaleType
taxScaleType- Parameters:
taxScaleType- TaxScaleType
-
workCondition
workCondition- Parameters:
workCondition- WorkCondition- Returns:
- TaxDeclaration
-
getWorkCondition
-
setWorkCondition
workCondition- Parameters:
workCondition- WorkCondition
-
seniorMaritalStatus
seniorMaritalStatus- Parameters:
seniorMaritalStatus- SeniorMaritalStatus- Returns:
- TaxDeclaration
-
getSeniorMaritalStatus
Get seniorMaritalStatus- Returns:
- seniorMaritalStatus
-
setSeniorMaritalStatus
seniorMaritalStatus- Parameters:
seniorMaritalStatus- SeniorMaritalStatus
-
taxFreeThresholdClaimed
If tax free threshold claimed. e.g true or false- Parameters:
taxFreeThresholdClaimed- Boolean- Returns:
- TaxDeclaration
-
getTaxFreeThresholdClaimed
If tax free threshold claimed. e.g true or false- Returns:
- taxFreeThresholdClaimed
-
setTaxFreeThresholdClaimed
If tax free threshold claimed. e.g true or false- Parameters:
taxFreeThresholdClaimed- Boolean
-
taxOffsetEstimatedAmount
If has tax offset estimated then the tax offset estimated amount. e.g 100- Parameters:
taxOffsetEstimatedAmount- BigDecimal- Returns:
- TaxDeclaration
-
getTaxOffsetEstimatedAmount
If has tax offset estimated then the tax offset estimated amount. e.g 100- Returns:
- taxOffsetEstimatedAmount
-
setTaxOffsetEstimatedAmount
If has tax offset estimated then the tax offset estimated amount. e.g 100- Parameters:
taxOffsetEstimatedAmount- BigDecimal
-
hasHELPDebt
If employee has HECS or HELP debt. e.g true or false- Parameters:
hasHELPDebt- Boolean- Returns:
- TaxDeclaration
-
getHasHELPDebt
If employee has HECS or HELP debt. e.g true or false- Returns:
- hasHELPDebt
-
setHasHELPDebt
If employee has HECS or HELP debt. e.g true or false- Parameters:
hasHELPDebt- Boolean
-
hasSFSSDebt
If employee has financial supplement debt. e.g true or false- Parameters:
hasSFSSDebt- Boolean- Returns:
- TaxDeclaration
-
getHasSFSSDebt
If employee has financial supplement debt. e.g true or false- Returns:
- hasSFSSDebt
-
setHasSFSSDebt
If employee has financial supplement debt. e.g true or false- Parameters:
hasSFSSDebt- Boolean
-
hasTradeSupportLoanDebt
If employee has trade support loan. e.g true or false- Parameters:
hasTradeSupportLoanDebt- Boolean- Returns:
- TaxDeclaration
-
getHasTradeSupportLoanDebt
If employee has trade support loan. e.g true or false- Returns:
- hasTradeSupportLoanDebt
-
setHasTradeSupportLoanDebt
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
If the employee has requested that additional tax be withheld each pay run. e.g 50- Returns:
- upwardVariationTaxWithholdingAmount
-
setUpwardVariationTaxWithholdingAmount
If the employee has requested that additional tax be withheld each pay run. e.g 50- Parameters:
upwardVariationTaxWithholdingAmount- BigDecimal
-
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
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
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
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
If the employee is eligible for student startup loan rules- Parameters:
hasStudentStartupLoan- Boolean- Returns:
- TaxDeclaration
-
getHasStudentStartupLoan
If the employee is eligible for student startup loan rules- Returns:
- hasStudentStartupLoan
-
setHasStudentStartupLoan
If the employee is eligible for student startup loan rules- Parameters:
hasStudentStartupLoan- Boolean
-
hasLoanOrStudentDebt
If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)- Parameters:
hasLoanOrStudentDebt- Boolean- Returns:
- TaxDeclaration
-
getHasLoanOrStudentDebt
If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)- Returns:
- hasLoanOrStudentDebt
-
setHasLoanOrStudentDebt
If the employee has any of the following loans or debts: Higher Education Loan Program (HELP/HECS), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL), or Trade Support Loan (TSL)- Parameters:
hasLoanOrStudentDebt- Boolean
-
getUpdatedDateUTC
-
getUpdatedDateUTCAsDate
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()Last modified timestamp- Returns:
- OffsetDateTime
-
equals
-
hashCode
-
toString
-