Package com.xero.models.payrollau

Class EarningsRate

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

  • Constructor Details

    • EarningsRate

      public EarningsRate()

  • Method Details

    • name

      public EarningsRate name​(String name)

    • getName

      public String getName()
      Name of the earnings rate (max length = 100)
      Returns:
      name

    • setName

      public void setName​(String name)

    • accountCode

      public EarningsRate accountCode​(String accountCode)

    • getAccountCode

      public String getAccountCode()
      See Accounts
      Returns:
      accountCode

    • setAccountCode

      public void setAccountCode​(String accountCode)

    • typeOfUnits

      public EarningsRate typeOfUnits​(String typeOfUnits)

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

    • isExemptFromTax

      public EarningsRate isExemptFromTax​(Boolean isExemptFromTax)

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

    • isExemptFromSuper

      public EarningsRate isExemptFromSuper​(Boolean isExemptFromSuper)

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

    • isReportableAsW1

      public EarningsRate isReportableAsW1​(Boolean isReportableAsW1)

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

    • earningsType

      public EarningsRate earningsType​(EarningsType earningsType)

    • getEarningsType

      public EarningsType getEarningsType()
      Get earningsType
      Returns:
      earningsType

    • setEarningsType

      public void setEarningsType​(EarningsType earningsType)

    • earningsRateID

      public EarningsRate earningsRateID​(UUID earningsRateID)

    • getEarningsRateID

      public UUID getEarningsRateID()
      Xero identifier
      Returns:
      earningsRateID

    • setEarningsRateID

      public void setEarningsRateID​(UUID earningsRateID)

    • rateType

      public EarningsRate rateType​(RateType rateType)

    • getRateType

      public RateType getRateType()
      Get rateType
      Returns:
      rateType

    • setRateType

      public void setRateType​(RateType rateType)

    • ratePerUnit

      public EarningsRate ratePerUnit​(String ratePerUnit)

    • getRatePerUnit

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

    • setRatePerUnit

      public void setRatePerUnit​(String ratePerUnit)

    • multiplier

      public EarningsRate multiplier​(Double multiplier)

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

    • accrueLeave

      public EarningsRate accrueLeave​(Boolean accrueLeave)

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

    • amount

      public EarningsRate amount​(Double amount)

    • getAmount

      public Double getAmount()
      Optional Amount for FIXEDAMOUNT RateType EarningsRate
      Returns:
      amount

    • setAmount

      public void setAmount​(Double amount)

    • employmentTerminationPaymentType

      public EarningsRate employmentTerminationPaymentType​(EmploymentTerminationPaymentType employmentTerminationPaymentType)

    • getEmploymentTerminationPaymentType

      public EmploymentTerminationPaymentType getEmploymentTerminationPaymentType()
      Get employmentTerminationPaymentType
      Returns:
      employmentTerminationPaymentType

    • setEmploymentTerminationPaymentType

      public void setEmploymentTerminationPaymentType​(EmploymentTerminationPaymentType employmentTerminationPaymentType)

    • getUpdatedDateUTC

      public String getUpdatedDateUTC()
      Last modified timestamp
      Returns:
      updatedDateUTC

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • currentRecord

      public EarningsRate currentRecord​(Boolean currentRecord)

    • getCurrentRecord

      public Boolean getCurrentRecord()
      Is the current record
      Returns:
      currentRecord

    • setCurrentRecord

      public void setCurrentRecord​(Boolean currentRecord)

    • allowanceType

      public EarningsRate allowanceType​(AllowanceType allowanceType)

    • getAllowanceType

      public AllowanceType getAllowanceType()
      Get allowanceType
      Returns:
      allowanceType

    • setAllowanceType

      public void setAllowanceType​(AllowanceType allowanceType)

    • 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