java.lang.Object
- com.xero.models.payrollnz.EarningsRate

public class EarningsRate
extends Object

EarningsRate

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`EarningsRate.EarningsTypeEnum`	Indicates how an employee will be paid when taking this type of earning
`static class`	`EarningsRate.RateTypeEnum`	Indicates the type of the earning rate

Constructor Summary

Constructors
Constructor Description

EarningsRate()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`EarningsRate`	`currentRecord(Boolean currentRecord)`	Indicates whether an earning type is active
`EarningsRate`	`earningsRateID(UUID earningsRateID)`	Xero unique identifier for an earning rate
`EarningsRate`	`earningsType(EarningsRate.EarningsTypeEnum earningsType)`	Indicates how an employee will be paid when taking this type of earning
`boolean`	`equals(Object o)`
`EarningsRate`	`expenseAccountID(UUID expenseAccountID)`	The account that will be used for the earnings rate
`EarningsRate`	`fixedAmount(Double fixedAmount)`	Optional Fixed Rate Amount.
`Boolean`	`getCurrentRecord()`	Indicates whether an earning type is active
`UUID`	`getEarningsRateID()`	Xero unique identifier for an earning rate
`EarningsRate.EarningsTypeEnum`	`getEarningsType()`	Indicates how an employee will be paid when taking this type of earning
`UUID`	`getExpenseAccountID()`	The account that will be used for the earnings rate
`Double`	`getFixedAmount()`	Optional Fixed Rate Amount.
`Double`	`getMultipleOfOrdinaryEarningsRate()`	This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate.
`String`	`getName()`	Name of the earning rate
`Double`	`getRatePerUnit()`	Default rate per unit (optional).
`EarningsRate.RateTypeEnum`	`getRateType()`	Indicates the type of the earning rate
`String`	`getTypeOfUnits()`	The type of units used to record earnings
`int`	`hashCode()`
`EarningsRate`	`multipleOfOrdinaryEarningsRate(Double multipleOfOrdinaryEarningsRate)`	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 earning rate
`EarningsRate`	`ratePerUnit(Double ratePerUnit)`	Default rate per unit (optional).
`EarningsRate`	`rateType(EarningsRate.RateTypeEnum rateType)`	Indicates the type of the earning rate
`void`	`setCurrentRecord(Boolean currentRecord)`	Indicates whether an earning type is active
`void`	`setEarningsRateID(UUID earningsRateID)`	Xero unique identifier for an earning rate
`void`	`setEarningsType(EarningsRate.EarningsTypeEnum earningsType)`	Indicates how an employee will be paid when taking this type of earning
`void`	`setExpenseAccountID(UUID expenseAccountID)`	The account that will be used for the earnings rate
`void`	`setFixedAmount(Double fixedAmount)`	Optional Fixed Rate Amount.
`void`	`setMultipleOfOrdinaryEarningsRate(Double multipleOfOrdinaryEarningsRate)`	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 earning rate
`void`	`setRatePerUnit(Double ratePerUnit)`	Default rate per unit (optional).
`void`	`setRateType(EarningsRate.RateTypeEnum rateType)`	Indicates the type of the earning rate
`void`	`setTypeOfUnits(String typeOfUnits)`	The type of units used to record earnings
`String`	`toString()`
`EarningsRate`	`typeOfUnits(String typeOfUnits)`	The type of units used to record earnings

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

- Constructor Detail
  - EarningsRate
```
public EarningsRate()
```
- Method Detail
  - earningsRateID
```
public EarningsRate earningsRateID(UUID earningsRateID)
```
    Xero unique identifier for an earning rate
    
    Parameters:
    
    earningsRateID - UUID
    
    Returns:
    
    EarningsRate
  - getEarningsRateID
```
public UUID getEarningsRateID()
```
    Xero unique identifier for an earning rate
    
    Returns:
    
    earningsRateID
  - setEarningsRateID
```
public void setEarningsRateID(UUID earningsRateID)
```
    Xero unique identifier for an earning rate
    
    Parameters:
    
    earningsRateID - UUID
  - name
```
public EarningsRate name(String name)
```
    Name of the earning rate
    
    Parameters:
    
    name - String
    
    Returns:
    
    EarningsRate
  - getName
```
public String getName()
```
    Name of the earning rate
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    Name of the earning rate
    
    Parameters:
    
    name - String
  - earningsType
```
public EarningsRate earningsType(EarningsRate.EarningsTypeEnum earningsType)
```
    Indicates how an employee will be paid when taking this type of earning
    
    Parameters:
    
    earningsType - EarningsTypeEnum
    
    Returns:
    
    EarningsRate
  - getEarningsType
```
public EarningsRate.EarningsTypeEnum getEarningsType()
```
    Indicates how an employee will be paid when taking this type of earning
    
    Returns:
    
    earningsType
  - setEarningsType
```
public void setEarningsType(EarningsRate.EarningsTypeEnum earningsType)
```
    Indicates how an employee will be paid when taking this type of earning
    
    Parameters:
    
    earningsType - EarningsTypeEnum
  - rateType
```
public EarningsRate rateType(EarningsRate.RateTypeEnum rateType)
```
    Indicates the type of the earning rate
    
    Parameters:
    
    rateType - RateTypeEnum
    
    Returns:
    
    EarningsRate
  - getRateType
```
public EarningsRate.RateTypeEnum getRateType()
```
    Indicates the type of the earning rate
    
    Returns:
    
    rateType
  - setRateType
```
public void setRateType(EarningsRate.RateTypeEnum rateType)
```
    Indicates the type of the earning rate
    
    Parameters:
    
    rateType - RateTypeEnum
  - typeOfUnits
```
public EarningsRate typeOfUnits(String typeOfUnits)
```
    The type of units used to record earnings
    
    Parameters:
    
    typeOfUnits - String
    
    Returns:
    
    EarningsRate
  - getTypeOfUnits
```
public String getTypeOfUnits()
```
    The type of units used to record earnings
    
    Returns:
    
    typeOfUnits
  - setTypeOfUnits
```
public void setTypeOfUnits(String typeOfUnits)
```
    The type of units used to record earnings
    
    Parameters:
    
    typeOfUnits - String
  - currentRecord
```
public EarningsRate currentRecord(Boolean currentRecord)
```
    Indicates whether an earning type is active
    
    Parameters:
    
    currentRecord - Boolean
    
    Returns:
    
    EarningsRate
  - getCurrentRecord
```
public Boolean getCurrentRecord()
```
    Indicates whether an earning type is active
    
    Returns:
    
    currentRecord
  - setCurrentRecord
```
public void setCurrentRecord(Boolean currentRecord)
```
    Indicates whether an earning type is active
    
    Parameters:
    
    currentRecord - Boolean
  - expenseAccountID
```
public EarningsRate expenseAccountID(UUID expenseAccountID)
```
    The account that will be used for the earnings rate
    
    Parameters:
    
    expenseAccountID - UUID
    
    Returns:
    
    EarningsRate
  - getExpenseAccountID
```
public UUID getExpenseAccountID()
```
    The account that will be used for the earnings rate
    
    Returns:
    
    expenseAccountID
  - setExpenseAccountID
```
public void setExpenseAccountID(UUID expenseAccountID)
```
    The account that will be used for the earnings rate
    
    Parameters:
    
    expenseAccountID - UUID
  - ratePerUnit
```
public EarningsRate ratePerUnit(Double ratePerUnit)
```
    Default rate per unit (optional). Only applicable if RateType is RatePerUnit
    
    Parameters:
    
    ratePerUnit - Double
    
    Returns:
    
    EarningsRate
  - getRatePerUnit
```
public Double getRatePerUnit()
```
    Default rate per unit (optional). Only applicable if RateType is RatePerUnit
    
    Returns:
    
    ratePerUnit
  - setRatePerUnit
```
public void setRatePerUnit(Double ratePerUnit)
```
    Default rate per unit (optional). Only applicable if RateType is RatePerUnit
    
    Parameters:
    
    ratePerUnit - Double
  - multipleOfOrdinaryEarningsRate
```
public EarningsRate multipleOfOrdinaryEarningsRate(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
```
public Double 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
```
public void setMultipleOfOrdinaryEarningsRate(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
  - fixedAmount
```
public EarningsRate fixedAmount(Double fixedAmount)
```
    Optional Fixed Rate Amount. Applicable for FixedAmount Rate
    
    Parameters:
    
    fixedAmount - Double
    
    Returns:
    
    EarningsRate
  - getFixedAmount
```
public Double getFixedAmount()
```
    Optional Fixed Rate Amount. Applicable for FixedAmount Rate
    
    Returns:
    
    fixedAmount
  - setFixedAmount
```
public void setFixedAmount(Double fixedAmount)
```
    Optional Fixed Rate Amount. Applicable for FixedAmount Rate
    
    Parameters:
    
    fixedAmount - Double
  - 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 EarningsRate

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EarningsRate

Method Detail

earningsRateID

getEarningsRateID

setEarningsRateID

name

getName

setName

earningsType

getEarningsType

setEarningsType

rateType

getRateType

setRateType

typeOfUnits

getTypeOfUnits

setTypeOfUnits

currentRecord

getCurrentRecord

setCurrentRecord

expenseAccountID

getExpenseAccountID

setExpenseAccountID

ratePerUnit

getRatePerUnit

setRatePerUnit

multipleOfOrdinaryEarningsRate

getMultipleOfOrdinaryEarningsRate

setMultipleOfOrdinaryEarningsRate

fixedAmount

getFixedAmount

setFixedAmount

equals

hashCode

toString