Package com.xero.models.payrollau

Class EarningsRate

java.lang.Object

com.xero.models.payrollau.EarningsRate

public class EarningsRate
extends Object

EarningsRate

Constructor Summary

Constructors

Constructor	Description
EarningsRate()

Method Summary

Modifier and Type	Method	Description
EarningsRate	accountCode(String accountCode)	See Accounts
EarningsRate	accrueLeave(Boolean accrueLeave)	Indicates that this earnings rate should accrue leave.
EarningsRate	allowanceCategory(AllowanceCategory allowanceCategory)	allowanceCategory
EarningsRate	allowanceContributesToAnnualLeaveRate(Boolean allowanceContributesToAnnualLeaveRate)	Boolean to determine if the allowance earnings rate contributes towards annual leave rate.
EarningsRate	allowanceContributesToOvertimeRate(Boolean allowanceContributesToOvertimeRate)	Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate.
EarningsRate	allowanceType(AllowanceType allowanceType)	allowanceType
EarningsRate	amount(Double amount)	Optional Amount for FIXEDAMOUNT RateType EarningsRate
EarningsRate	currentRecord(Boolean currentRecord)	Is the current record
EarningsRate	earningsRateID(UUID earningsRateID)	Xero identifier
EarningsRate	earningsType(EarningsType earningsType)	earningsType
EarningsRate	employmentTerminationPaymentType(EmploymentTerminationPaymentType employmentTerminationPaymentType)	employmentTerminationPaymentType
boolean	equals(Object o)
String	getAccountCode()	See Accounts
Boolean	getAccrueLeave()	Indicates that this earnings rate should accrue leave.
AllowanceCategory	getAllowanceCategory()	Get allowanceCategory
Boolean	getAllowanceContributesToAnnualLeaveRate()	Boolean to determine if the allowance earnings rate contributes towards annual leave rate.
Boolean	getAllowanceContributesToOvertimeRate()	Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate.
AllowanceType	getAllowanceType()	Get allowanceType
Double	getAmount()	Optional Amount for FIXEDAMOUNT RateType EarningsRate
Boolean	getCurrentRecord()	Is the current record
UUID	getEarningsRateID()	Xero identifier
EarningsType	getEarningsType()	Get earningsType
EmploymentTerminationPaymentType	getEmploymentTerminationPaymentType()	Get employmentTerminationPaymentType
Boolean	getIsExemptFromSuper()	See the ATO website for details of which payments are exempt from SGC
Boolean	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
Boolean	getIsReportableAsW1()	Boolean to determine if the earnings rate is reportable or exempt from W1
Double	getMultiplier()	This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.
String	getName()	Name of the earnings rate (max length = 100)
String	getRatePerUnit()	Default rate per unit (optional).
RateType	getRateType()	Get rateType
String	getTypeOfUnits()	Type of units used to record earnings (max length = 50).
String	getUpdatedDateUTC()	Last modified timestamp
org.threeten.bp.OffsetDateTime	getUpdatedDateUTCAsDate()	Last modified timestamp
int	hashCode()
EarningsRate	isExemptFromSuper(Boolean isExemptFromSuper)	See the ATO website for details of which payments are exempt from SGC
EarningsRate	isExemptFromTax(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 withholding
EarningsRate	isReportableAsW1(Boolean isReportableAsW1)	Boolean to determine if the earnings rate is reportable or exempt from W1
EarningsRate	multiplier(Double multiplier)	This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.
EarningsRate	name(String name)	Name of the earnings rate (max length = 100)
EarningsRate	ratePerUnit(String ratePerUnit)	Default rate per unit (optional).
EarningsRate	rateType(RateType rateType)	rateType
void	setAccountCode(String accountCode)	See Accounts
void	setAccrueLeave(Boolean accrueLeave)	Indicates that this earnings rate should accrue leave.
void	setAllowanceCategory(AllowanceCategory allowanceCategory)	allowanceCategory
void	setAllowanceContributesToAnnualLeaveRate(Boolean allowanceContributesToAnnualLeaveRate)	Boolean to determine if the allowance earnings rate contributes towards annual leave rate.
void	setAllowanceContributesToOvertimeRate(Boolean allowanceContributesToOvertimeRate)	Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate.
void	setAllowanceType(AllowanceType allowanceType)	allowanceType
void	setAmount(Double amount)	Optional Amount for FIXEDAMOUNT RateType EarningsRate
void	setCurrentRecord(Boolean currentRecord)	Is the current record
void	setEarningsRateID(UUID earningsRateID)	Xero identifier
void	setEarningsType(EarningsType earningsType)	earningsType
void	setEmploymentTerminationPaymentType(EmploymentTerminationPaymentType employmentTerminationPaymentType)	employmentTerminationPaymentType
void	setIsExemptFromSuper(Boolean isExemptFromSuper)	See the ATO website for details of which payments are exempt from SGC
void	setIsExemptFromTax(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 withholding
void	setIsReportableAsW1(Boolean isReportableAsW1)	Boolean to determine if the earnings rate is reportable or exempt from W1
void	setMultiplier(Double multiplier)	This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.
void	setName(String name)	Name of the earnings rate (max length = 100)
void	setRatePerUnit(String ratePerUnit)	Default rate per unit (optional).
void	setRateType(RateType rateType)	rateType
void	setTypeOfUnits(String typeOfUnits)	Type of units used to record earnings (max length = 50).
String	toString()
EarningsRate	typeOfUnits(String typeOfUnits)	Type of units used to record earnings (max length = 50).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EarningsRate

public EarningsRate()

Method Details

name

public EarningsRate name(String name)

Name of the earnings rate (max length = 100)

Parameters:

name - String

Returns:

EarningsRate

getName

public String getName()

Name of the earnings rate (max length = 100)

Returns:

name

setName

public void setName(String name)

Name of the earnings rate (max length = 100)

Parameters:

name - String

accountCode

public EarningsRate accountCode(String accountCode)

See Accounts

Parameters:

accountCode - String

Returns:

EarningsRate

getAccountCode

public String getAccountCode()

See Accounts

Returns:

accountCode

setAccountCode

public void setAccountCode(String accountCode)

See Accounts

Parameters:

accountCode - String

typeOfUnits

public EarningsRate typeOfUnits(String typeOfUnits)

Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT

Parameters:

typeOfUnits - String

Returns:

EarningsRate

getTypeOfUnits

public String getTypeOfUnits()

Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT

Returns:

typeOfUnits

setTypeOfUnits

public void setTypeOfUnits(String typeOfUnits)

Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT

Parameters:

typeOfUnits - String

isExemptFromTax

public EarningsRate isExemptFromTax(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 withholding

Parameters:

isExemptFromTax - Boolean

Returns:

EarningsRate

getIsExemptFromTax

public Boolean 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

public void setIsExemptFromTax(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 withholding

Parameters:

isExemptFromTax - Boolean

isExemptFromSuper

public EarningsRate isExemptFromSuper(Boolean isExemptFromSuper)

See the ATO website for details of which payments are exempt from SGC

Parameters:

isExemptFromSuper - Boolean

Returns:

EarningsRate

getIsExemptFromSuper

public Boolean getIsExemptFromSuper()

See the ATO website for details of which payments are exempt from SGC

Returns:

isExemptFromSuper

setIsExemptFromSuper

public void setIsExemptFromSuper(Boolean isExemptFromSuper)

See the ATO website for details of which payments are exempt from SGC

Parameters:

isExemptFromSuper - Boolean

isReportableAsW1

public EarningsRate isReportableAsW1(Boolean isReportableAsW1)

Boolean to determine if the earnings rate is reportable or exempt from W1

Parameters:

isReportableAsW1 - Boolean

Returns:

EarningsRate

getIsReportableAsW1

public Boolean getIsReportableAsW1()

Boolean to determine if the earnings rate is reportable or exempt from W1

Returns:

isReportableAsW1

setIsReportableAsW1

public void setIsReportableAsW1(Boolean isReportableAsW1)

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

public Boolean 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

public void setAllowanceContributesToAnnualLeaveRate(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

allowanceContributesToOvertimeRate

public EarningsRate allowanceContributesToOvertimeRate(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

public Boolean 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

public void setAllowanceContributesToOvertimeRate(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

earningsType

public EarningsRate earningsType(EarningsType earningsType)

earningsType

Parameters:

earningsType - EarningsType

Returns:

EarningsRate

getEarningsType

public EarningsType getEarningsType()

Get earningsType

Returns:

earningsType

setEarningsType

public void setEarningsType(EarningsType earningsType)

earningsType

Parameters:

earningsType - EarningsType

earningsRateID

public EarningsRate earningsRateID(UUID earningsRateID)

Xero identifier

Parameters:

earningsRateID - UUID

Returns:

EarningsRate

getEarningsRateID

public UUID getEarningsRateID()

Xero identifier

Returns:

earningsRateID

setEarningsRateID

public void setEarningsRateID(UUID earningsRateID)

Xero identifier

Parameters:

earningsRateID - UUID

rateType

public EarningsRate rateType(RateType rateType)

rateType

Parameters:

rateType - RateType

Returns:

EarningsRate

getRateType

public RateType getRateType()

Get rateType

Returns:

rateType

setRateType

public void setRateType(RateType rateType)

rateType

Parameters:

rateType - RateType

ratePerUnit

public EarningsRate ratePerUnit(String ratePerUnit)

Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.

Parameters:

ratePerUnit - String

Returns:

EarningsRate

getRatePerUnit

public String getRatePerUnit()

Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.

Returns:

ratePerUnit

setRatePerUnit

public void setRatePerUnit(String ratePerUnit)

Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.

Parameters:

ratePerUnit - String

multiplier

public EarningsRate multiplier(Double 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

public Double 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

public void setMultiplier(Double 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

accrueLeave

public EarningsRate accrueLeave(Boolean accrueLeave)

Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE

Parameters:

accrueLeave - Boolean

Returns:

EarningsRate

getAccrueLeave

public Boolean getAccrueLeave()

Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE

Returns:

accrueLeave

setAccrueLeave

public void setAccrueLeave(Boolean accrueLeave)

Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE

Parameters:

accrueLeave - Boolean

amount

public EarningsRate amount(Double amount)

Optional Amount for FIXEDAMOUNT RateType EarningsRate

Parameters:

amount - Double

Returns:

EarningsRate

getAmount

public Double getAmount()

Optional Amount for FIXEDAMOUNT RateType EarningsRate

Returns:

amount

setAmount

public void setAmount(Double amount)

Optional Amount for FIXEDAMOUNT RateType EarningsRate

Parameters:

amount - Double

employmentTerminationPaymentType

public EarningsRate employmentTerminationPaymentType(EmploymentTerminationPaymentType employmentTerminationPaymentType)

employmentTerminationPaymentType

Parameters:

employmentTerminationPaymentType - EmploymentTerminationPaymentType

Returns:

EarningsRate

getEmploymentTerminationPaymentType

public EmploymentTerminationPaymentType getEmploymentTerminationPaymentType()

Get employmentTerminationPaymentType

Returns:

employmentTerminationPaymentType

setEmploymentTerminationPaymentType

public void setEmploymentTerminationPaymentType(EmploymentTerminationPaymentType employmentTerminationPaymentType)

employmentTerminationPaymentType

Parameters:

employmentTerminationPaymentType - EmploymentTerminationPaymentType

getUpdatedDateUTC

public String getUpdatedDateUTC()

Last modified timestamp

Returns:

updatedDateUTC

getUpdatedDateUTCAsDate

public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

Last modified timestamp

Returns:

OffsetDateTime

currentRecord

public EarningsRate currentRecord(Boolean currentRecord)

Is the current record

Parameters:

currentRecord - Boolean

Returns:

EarningsRate

getCurrentRecord

public Boolean getCurrentRecord()

Is the current record

Returns:

currentRecord

setCurrentRecord

public void setCurrentRecord(Boolean currentRecord)

Is the current record

Parameters:

currentRecord - Boolean

allowanceType

public EarningsRate allowanceType(AllowanceType allowanceType)

allowanceType

Parameters:

allowanceType - AllowanceType

Returns:

EarningsRate

getAllowanceType

public AllowanceType getAllowanceType()

Get allowanceType

Returns:

allowanceType

setAllowanceType

public void setAllowanceType(AllowanceType allowanceType)

allowanceType

Parameters:

allowanceType - AllowanceType

allowanceCategory

public EarningsRate allowanceCategory(AllowanceCategory allowanceCategory)

allowanceCategory

Parameters:

allowanceCategory - AllowanceCategory

Returns:

EarningsRate

getAllowanceCategory

public AllowanceCategory getAllowanceCategory()

Get allowanceCategory

Returns:

allowanceCategory

setAllowanceCategory

public void setAllowanceCategory(AllowanceCategory allowanceCategory)

allowanceCategory

Parameters:

allowanceCategory - AllowanceCategory

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