Package com.xero.models.payrollnz

Class EarningsRate

java.lang.Object
com.xero.models.payrollnz.EarningsRate
public class EarningsRate
extends Object
EarningsRate

  • Constructor Details

    • EarningsRate

      public EarningsRate()

  • Method Details

    • earningsRateID

      public EarningsRate earningsRateID​(UUID earningsRateID)

    • getEarningsRateID

      public UUID getEarningsRateID()
      Xero unique identifier for an earning rate
      Returns:
      earningsRateID

    • setEarningsRateID

      public void setEarningsRateID​(UUID earningsRateID)

    • name

      public EarningsRate name​(String name)

    • getName

      public String getName()
      Name of the earning rate
      Returns:
      name

    • setName

      public void setName​(String name)

    • earningsType

      public EarningsRate earningsType​(EarningsRate.EarningsTypeEnum earningsType)

    • 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)

    • rateType

      public EarningsRate rateType​(EarningsRate.RateTypeEnum rateType)

    • getRateType

      public EarningsRate.RateTypeEnum getRateType()
      Indicates the type of the earning rate
      Returns:
      rateType

    • setRateType

      public void setRateType​(EarningsRate.RateTypeEnum rateType)

    • typeOfUnits

      public EarningsRate typeOfUnits​(String typeOfUnits)

    • getTypeOfUnits

      public String getTypeOfUnits()
      The type of units used to record earnings
      Returns:
      typeOfUnits

    • setTypeOfUnits

      public void setTypeOfUnits​(String typeOfUnits)

    • currentRecord

      public EarningsRate currentRecord​(Boolean currentRecord)

    • getCurrentRecord

      public Boolean getCurrentRecord()
      Indicates whether an earning type is active
      Returns:
      currentRecord

    • setCurrentRecord

      public void setCurrentRecord​(Boolean currentRecord)

    • expenseAccountID

      public EarningsRate expenseAccountID​(UUID expenseAccountID)

    • getExpenseAccountID

      public UUID getExpenseAccountID()
      The account that will be used for the earnings rate
      Returns:
      expenseAccountID

    • setExpenseAccountID

      public void setExpenseAccountID​(UUID expenseAccountID)

    • ratePerUnit

      public EarningsRate ratePerUnit​(Double ratePerUnit)

    • getRatePerUnit

      public Double getRatePerUnit()
      Default rate per unit (optional). Only applicable if RateType is RatePerUnit
      Returns:
      ratePerUnit

    • setRatePerUnit

      public void setRatePerUnit​(Double ratePerUnit)

    • multipleOfOrdinaryEarningsRate

      public EarningsRate multipleOfOrdinaryEarningsRate​(Double multipleOfOrdinaryEarningsRate)

    • 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)

    • fixedAmount

      public EarningsRate fixedAmount​(Double fixedAmount)

    • getFixedAmount

      public Double getFixedAmount()
      Optional Fixed Rate Amount. Applicable for FixedAmount Rate
      Returns:
      fixedAmount

    • setFixedAmount

      public void setFixedAmount​(Double fixedAmount)

    • 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