Package com.xero.models.payrolluk
Class EarningsRate
java.lang.Object
com.xero.models.payrolluk.EarningsRate
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumIndicates how an employee will be paid when taking this type of earningstatic enumIndicates the type of the earning rate -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncurrentRecord(Boolean currentRecord) Indicates whether an earning type is activeearningsRateID(UUID earningsRateID) Xero unique identifier for an earning rateearningsType(EarningsRate.EarningsTypeEnum earningsType) Indicates how an employee will be paid when taking this type of earningbooleanexpenseAccountID(UUID expenseAccountID) The account that will be used for the earnings ratefixedAmount(Double fixedAmount) Optional Fixed Rate Amount.Indicates whether an earning type is activeXero unique identifier for an earning rateIndicates how an employee will be paid when taking this type of earningThe account that will be used for the earnings rateOptional Fixed Rate Amount.This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.getName()Name of the earning rateDefault rate per unit (optional).Indicates the type of the earning rateThe type of units used to record earningsinthashCode()multipleOfOrdinaryEarningsRate(Double multipleOfOrdinaryEarningsRate) This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.Name of the earning rateratePerUnit(Double ratePerUnit) Default rate per unit (optional).rateType(EarningsRate.RateTypeEnum rateType) Indicates the type of the earning ratevoidsetCurrentRecord(Boolean currentRecord) Indicates whether an earning type is activevoidsetEarningsRateID(UUID earningsRateID) Xero unique identifier for an earning ratevoidsetEarningsType(EarningsRate.EarningsTypeEnum earningsType) Indicates how an employee will be paid when taking this type of earningvoidsetExpenseAccountID(UUID expenseAccountID) The account that will be used for the earnings ratevoidsetFixedAmount(Double fixedAmount) Optional Fixed Rate Amount.voidsetMultipleOfOrdinaryEarningsRate(Double multipleOfOrdinaryEarningsRate) This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.voidName of the earning ratevoidsetRatePerUnit(Double ratePerUnit) Default rate per unit (optional).voidsetRateType(EarningsRate.RateTypeEnum rateType) Indicates the type of the earning ratevoidsetTypeOfUnits(String typeOfUnits) The type of units used to record earningstoString()typeOfUnits(String typeOfUnits) The type of units used to record earnings
-
Constructor Details
-
EarningsRate
public EarningsRate()
-
-
Method Details
-
earningsRateID
Xero unique identifier for an earning rate- Parameters:
earningsRateID- UUID- Returns:
- EarningsRate
-
getEarningsRateID
-
setEarningsRateID
Xero unique identifier for an earning rate- Parameters:
earningsRateID- UUID
-
name
Name of the earning rate- Parameters:
name- String- Returns:
- EarningsRate
-
getName
-
setName
-
earningsType
Indicates how an employee will be paid when taking this type of earning- Parameters:
earningsType- EarningsTypeEnum- Returns:
- EarningsRate
-
getEarningsType
Indicates how an employee will be paid when taking this type of earning- Returns:
- earningsType
-
setEarningsType
Indicates how an employee will be paid when taking this type of earning- Parameters:
earningsType- EarningsTypeEnum
-
rateType
Indicates the type of the earning rate- Parameters:
rateType- RateTypeEnum- Returns:
- EarningsRate
-
getRateType
Indicates the type of the earning rate- Returns:
- rateType
-
setRateType
Indicates the type of the earning rate- Parameters:
rateType- RateTypeEnum
-
typeOfUnits
The type of units used to record earnings- Parameters:
typeOfUnits- String- Returns:
- EarningsRate
-
getTypeOfUnits
-
setTypeOfUnits
The type of units used to record earnings- Parameters:
typeOfUnits- String
-
currentRecord
Indicates whether an earning type is active- Parameters:
currentRecord- Boolean- Returns:
- EarningsRate
-
getCurrentRecord
Indicates whether an earning type is active- Returns:
- currentRecord
-
setCurrentRecord
Indicates whether an earning type is active- Parameters:
currentRecord- Boolean
-
expenseAccountID
The account that will be used for the earnings rate- Parameters:
expenseAccountID- UUID- Returns:
- EarningsRate
-
getExpenseAccountID
The account that will be used for the earnings rate- Returns:
- expenseAccountID
-
setExpenseAccountID
The account that will be used for the earnings rate- Parameters:
expenseAccountID- UUID
-
ratePerUnit
Default rate per unit (optional). Only applicable if RateType is RatePerUnit- Parameters:
ratePerUnit- Double- 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- Double
-
multipleOfOrdinaryEarningsRate
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 MultipleOfOrdinaryEarningsRate- Parameters:
multipleOfOrdinaryEarningsRate- Double- Returns:
- EarningsRate
-
getMultipleOfOrdinaryEarningsRate
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 MultipleOfOrdinaryEarningsRate- Returns:
- multipleOfOrdinaryEarningsRate
-
setMultipleOfOrdinaryEarningsRate
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 MultipleOfOrdinaryEarningsRate- Parameters:
multipleOfOrdinaryEarningsRate- Double
-
fixedAmount
Optional Fixed Rate Amount. Applicable for FixedAmount Rate- Parameters:
fixedAmount- Double- Returns:
- EarningsRate
-
getFixedAmount
Optional Fixed Rate Amount. Applicable for FixedAmount Rate- Returns:
- fixedAmount
-
setFixedAmount
Optional Fixed Rate Amount. Applicable for FixedAmount Rate- Parameters:
fixedAmount- Double
-
equals
-
hashCode
-
toString
-