Package com.xero.models.payrollau
Class EarningsRate
java.lang.Object
com.xero.models.payrollau.EarningsRate
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccountCode(String accountCode) See AccountsaccrueLeave(Boolean accrueLeave) Indicates that this earnings rate should accrue leave.allowanceCategory(AllowanceCategory allowanceCategory) allowanceCategoryallowanceContributesToAnnualLeaveRate(Boolean allowanceContributesToAnnualLeaveRate) Boolean to determine if the allowance earnings rate contributes towards annual leave rate.allowanceContributesToOvertimeRate(Boolean allowanceContributesToOvertimeRate) Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate.allowanceType(AllowanceType allowanceType) allowanceTypeOptional Amount for FIXEDAMOUNT RateType EarningsRatecurrentRecord(Boolean currentRecord) Is the current recordearningsRateID(UUID earningsRateID) Xero identifierearningsType(EarningsType earningsType) earningsTypeemploymentTerminationPaymentType(EmploymentTerminationPaymentType employmentTerminationPaymentType) employmentTerminationPaymentTypebooleanSee AccountsIndicates that this earnings rate should accrue leave.Get allowanceCategoryBoolean to determine if the allowance earnings rate contributes towards annual leave rate.Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate.Get allowanceTypeOptional Amount for FIXEDAMOUNT RateType EarningsRateIs the current recordXero identifierGet earningsTypeGet employmentTerminationPaymentTypeSee the ATO website for details of which payments are exempt from SGCMost payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholdingBoolean to determine if the earnings rate is reportable or exempt from W1This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.getName()Name of the earnings rate (max length = 100)Default rate per unit (optional).Get rateTypeType of units used to record earnings (max length = 50).Last modified timestamporg.threeten.bp.OffsetDateTimeLast modified timestampinthashCode()isExemptFromSuper(Boolean isExemptFromSuper) See the ATO website for details of which payments are exempt from SGCisExemptFromTax(Boolean isExemptFromTax) Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholdingisReportableAsW1(Boolean isReportableAsW1) Boolean to determine if the earnings rate is reportable or exempt from W1multiplier(Double multiplier) This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.Name of the earnings rate (max length = 100)ratePerUnit(String ratePerUnit) Default rate per unit (optional).rateTypevoidsetAccountCode(String accountCode) See AccountsvoidsetAccrueLeave(Boolean accrueLeave) Indicates that this earnings rate should accrue leave.voidsetAllowanceCategory(AllowanceCategory allowanceCategory) allowanceCategoryvoidsetAllowanceContributesToAnnualLeaveRate(Boolean allowanceContributesToAnnualLeaveRate) Boolean to determine if the allowance earnings rate contributes towards annual leave rate.voidsetAllowanceContributesToOvertimeRate(Boolean allowanceContributesToOvertimeRate) Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate.voidsetAllowanceType(AllowanceType allowanceType) allowanceTypevoidOptional Amount for FIXEDAMOUNT RateType EarningsRatevoidsetCurrentRecord(Boolean currentRecord) Is the current recordvoidsetEarningsRateID(UUID earningsRateID) Xero identifiervoidsetEarningsType(EarningsType earningsType) earningsTypevoidsetEmploymentTerminationPaymentType(EmploymentTerminationPaymentType employmentTerminationPaymentType) employmentTerminationPaymentTypevoidsetIsExemptFromSuper(Boolean isExemptFromSuper) See the ATO website for details of which payments are exempt from SGCvoidsetIsExemptFromTax(Boolean isExemptFromTax) Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholdingvoidsetIsReportableAsW1(Boolean isReportableAsW1) Boolean to determine if the earnings rate is reportable or exempt from W1voidsetMultiplier(Double multiplier) This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.voidName of the earnings rate (max length = 100)voidsetRatePerUnit(String ratePerUnit) Default rate per unit (optional).voidsetRateType(RateType rateType) rateTypevoidsetTypeOfUnits(String typeOfUnits) Type of units used to record earnings (max length = 50).toString()typeOfUnits(String typeOfUnits) Type of units used to record earnings (max length = 50).
-
Constructor Details
-
EarningsRate
public EarningsRate()
-
-
Method Details
-
name
Name of the earnings rate (max length = 100)- Parameters:
name- String- Returns:
- EarningsRate
-
getName
-
setName
Name of the earnings rate (max length = 100)- Parameters:
name- String
-
accountCode
See Accounts- Parameters:
accountCode- String- Returns:
- EarningsRate
-
getAccountCode
-
setAccountCode
-
typeOfUnits
Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT- Parameters:
typeOfUnits- String- Returns:
- EarningsRate
-
getTypeOfUnits
Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT- Returns:
- typeOfUnits
-
setTypeOfUnits
Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT- Parameters:
typeOfUnits- String
-
isExemptFromTax
Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding- Parameters:
isExemptFromTax- Boolean- Returns:
- EarningsRate
-
getIsExemptFromTax
Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding- Returns:
- isExemptFromTax
-
setIsExemptFromTax
Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding- Parameters:
isExemptFromTax- Boolean
-
isExemptFromSuper
See the ATO website for details of which payments are exempt from SGC- Parameters:
isExemptFromSuper- Boolean- Returns:
- EarningsRate
-
getIsExemptFromSuper
See the ATO website for details of which payments are exempt from SGC- Returns:
- isExemptFromSuper
-
setIsExemptFromSuper
See the ATO website for details of which payments are exempt from SGC- Parameters:
isExemptFromSuper- Boolean
-
isReportableAsW1
Boolean to determine if the earnings rate is reportable or exempt from W1- Parameters:
isReportableAsW1- Boolean- Returns:
- EarningsRate
-
getIsReportableAsW1
Boolean to determine if the earnings rate is reportable or exempt from W1- Returns:
- isReportableAsW1
-
setIsReportableAsW1
Boolean to determine if the earnings rate is reportable or exempt from W1- Parameters:
isReportableAsW1- Boolean
-
allowanceContributesToAnnualLeaveRate
public EarningsRate allowanceContributesToAnnualLeaveRate(Boolean allowanceContributesToAnnualLeaveRate) Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT- Parameters:
allowanceContributesToAnnualLeaveRate- Boolean- Returns:
- EarningsRate
-
getAllowanceContributesToAnnualLeaveRate
Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT- Returns:
- allowanceContributesToAnnualLeaveRate
-
setAllowanceContributesToAnnualLeaveRate
Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT- Parameters:
allowanceContributesToAnnualLeaveRate- Boolean
-
allowanceContributesToOvertimeRate
Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT- Parameters:
allowanceContributesToOvertimeRate- Boolean- Returns:
- EarningsRate
-
getAllowanceContributesToOvertimeRate
Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT- Returns:
- allowanceContributesToOvertimeRate
-
setAllowanceContributesToOvertimeRate
Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT- Parameters:
allowanceContributesToOvertimeRate- Boolean
-
earningsType
earningsType- Parameters:
earningsType- EarningsType- Returns:
- EarningsRate
-
getEarningsType
-
setEarningsType
earningsType- Parameters:
earningsType- EarningsType
-
earningsRateID
Xero identifier- Parameters:
earningsRateID- UUID- Returns:
- EarningsRate
-
getEarningsRateID
-
setEarningsRateID
Xero identifier- Parameters:
earningsRateID- UUID
-
rateType
rateType- Parameters:
rateType- RateType- Returns:
- EarningsRate
-
getRateType
-
setRateType
-
ratePerUnit
Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.- Parameters:
ratePerUnit- String- Returns:
- EarningsRate
-
getRatePerUnit
Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.- Returns:
- ratePerUnit
-
setRatePerUnit
Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.- Parameters:
ratePerUnit- String
-
multiplier
This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MULTIPLE- Parameters:
multiplier- Double- Returns:
- EarningsRate
-
getMultiplier
This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MULTIPLE- Returns:
- multiplier
-
setMultiplier
This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MULTIPLE- Parameters:
multiplier- Double
-
accrueLeave
Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE- Parameters:
accrueLeave- Boolean- Returns:
- EarningsRate
-
getAccrueLeave
Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE- Returns:
- accrueLeave
-
setAccrueLeave
Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE- Parameters:
accrueLeave- Boolean
-
amount
Optional Amount for FIXEDAMOUNT RateType EarningsRate- Parameters:
amount- Double- Returns:
- EarningsRate
-
getAmount
-
setAmount
Optional Amount for FIXEDAMOUNT RateType EarningsRate- Parameters:
amount- Double
-
employmentTerminationPaymentType
public EarningsRate employmentTerminationPaymentType(EmploymentTerminationPaymentType employmentTerminationPaymentType) employmentTerminationPaymentType- Parameters:
employmentTerminationPaymentType- EmploymentTerminationPaymentType- Returns:
- EarningsRate
-
getEmploymentTerminationPaymentType
Get employmentTerminationPaymentType- Returns:
- employmentTerminationPaymentType
-
setEmploymentTerminationPaymentType
public void setEmploymentTerminationPaymentType(EmploymentTerminationPaymentType employmentTerminationPaymentType) employmentTerminationPaymentType- Parameters:
employmentTerminationPaymentType- EmploymentTerminationPaymentType
-
getUpdatedDateUTC
-
getUpdatedDateUTCAsDate
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()Last modified timestamp- Returns:
- OffsetDateTime
-
currentRecord
Is the current record- Parameters:
currentRecord- Boolean- Returns:
- EarningsRate
-
getCurrentRecord
-
setCurrentRecord
Is the current record- Parameters:
currentRecord- Boolean
-
allowanceType
allowanceType- Parameters:
allowanceType- AllowanceType- Returns:
- EarningsRate
-
getAllowanceType
-
setAllowanceType
allowanceType- Parameters:
allowanceType- AllowanceType
-
allowanceCategory
allowanceCategory- Parameters:
allowanceCategory- AllowanceCategory- Returns:
- EarningsRate
-
getAllowanceCategory
-
setAllowanceCategory
allowanceCategory- Parameters:
allowanceCategory- AllowanceCategory
-
equals
-
hashCode
-
toString
-