Package com.xero.models.accounting

Class Overpayment

java.lang.Object
com.xero.models.accounting.Overpayment
public class Overpayment
extends Object
Overpayment

  • Constructor Details

    • Overpayment

      public Overpayment()

  • Method Details

    • type

      public Overpayment type​(Overpayment.TypeEnum type)

    • getType

      public Overpayment.TypeEnum getType()
      See Overpayment Types
      Returns:
      type

    • setType

      public void setType​(Overpayment.TypeEnum type)

    • contact

      public Overpayment contact​(Contact contact)

    • getContact

      public Contact getContact()
      Get contact
      Returns:
      contact

    • setContact

      public void setContact​(Contact contact)

    • date

      public Overpayment date​(String date)

    • getDate

      public String getDate()
      The date the overpayment is created YYYY-MM-DD
      Returns:
      date

    • getDateAsDate

      public org.threeten.bp.LocalDate getDateAsDate()

    • setDate

      public void setDate​(String date)

    • setDate

      public void setDate​(org.threeten.bp.LocalDate date)

    • status

      public Overpayment status​(Overpayment.StatusEnum status)

    • getStatus

      public Overpayment.StatusEnum getStatus()
      See Overpayment Status Codes
      Returns:
      status

    • setStatus

      public void setStatus​(Overpayment.StatusEnum status)

    • lineAmountTypes

      public Overpayment lineAmountTypes​(LineAmountTypes lineAmountTypes)

    • getLineAmountTypes

      public LineAmountTypes getLineAmountTypes()
      Get lineAmountTypes
      Returns:
      lineAmountTypes

    • setLineAmountTypes

      public void setLineAmountTypes​(LineAmountTypes lineAmountTypes)

    • lineItems

      public Overpayment lineItems​(List<LineItem> lineItems)

    • addLineItemsItem

      public Overpayment addLineItemsItem​(LineItem lineItemsItem)

    • getLineItems

      public List<LineItem> getLineItems()
      See Overpayment Line Items
      Returns:
      lineItems

    • setLineItems

      public void setLineItems​(List<LineItem> lineItems)

    • subTotal

      public Overpayment subTotal​(Double subTotal)

    • getSubTotal

      public Double getSubTotal()
      The subtotal of the overpayment excluding taxes
      Returns:
      subTotal

    • setSubTotal

      public void setSubTotal​(Double subTotal)

    • totalTax

      public Overpayment totalTax​(Double totalTax)

    • getTotalTax

      public Double getTotalTax()
      The total tax on the overpayment
      Returns:
      totalTax

    • setTotalTax

      public void setTotalTax​(Double totalTax)

    • total

      public Overpayment total​(Double total)

    • getTotal

      public Double getTotal()
      The total of the overpayment (subtotal + total tax)
      Returns:
      total

    • setTotal

      public void setTotal​(Double total)

    • getUpdatedDateUTC

      public String getUpdatedDateUTC()
      UTC timestamp of last update to the overpayment
      Returns:
      updatedDateUTC

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • currencyCode

      public Overpayment currencyCode​(CurrencyCode currencyCode)

    • getCurrencyCode

      public CurrencyCode getCurrencyCode()
      Get currencyCode
      Returns:
      currencyCode

    • setCurrencyCode

      public void setCurrencyCode​(CurrencyCode currencyCode)

    • overpaymentID

      public Overpayment overpaymentID​(UUID overpaymentID)

    • getOverpaymentID

      public UUID getOverpaymentID()
      Xero generated unique identifier
      Returns:
      overpaymentID

    • setOverpaymentID

      public void setOverpaymentID​(UUID overpaymentID)

    • currencyRate

      public Overpayment currencyRate​(Double currencyRate)

    • getCurrencyRate

      public Double getCurrencyRate()
      The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used
      Returns:
      currencyRate

    • setCurrencyRate

      public void setCurrencyRate​(Double currencyRate)

    • remainingCredit

      public Overpayment remainingCredit​(Double remainingCredit)

    • getRemainingCredit

      public Double getRemainingCredit()
      The remaining credit balance on the overpayment
      Returns:
      remainingCredit

    • setRemainingCredit

      public void setRemainingCredit​(Double remainingCredit)

    • allocations

      public Overpayment allocations​(List<Allocation> allocations)

    • addAllocationsItem

      public Overpayment addAllocationsItem​(Allocation allocationsItem)

    • getAllocations

      public List<Allocation> getAllocations()
      See Allocations
      Returns:
      allocations

    • setAllocations

      public void setAllocations​(List<Allocation> allocations)

    • appliedAmount

      public Overpayment appliedAmount​(Double appliedAmount)

    • getAppliedAmount

      public Double getAppliedAmount()
      The amount of applied to an invoice
      Returns:
      appliedAmount

    • setAppliedAmount

      public void setAppliedAmount​(Double appliedAmount)

    • payments

      public Overpayment payments​(List<Payment> payments)

    • addPaymentsItem

      public Overpayment addPaymentsItem​(Payment paymentsItem)

    • getPayments

      public List<Payment> getPayments()
      See Payments
      Returns:
      payments

    • setPayments

      public void setPayments​(List<Payment> payments)

    • getHasAttachments

      public Boolean getHasAttachments()
      boolean to indicate if a overpayment has an attachment
      Returns:
      hasAttachments

    • attachments

      public Overpayment attachments​(List<Attachment> attachments)

    • addAttachmentsItem

      public Overpayment addAttachmentsItem​(Attachment attachmentsItem)

    • getAttachments

      public List<Attachment> getAttachments()
      See Attachments
      Returns:
      attachments

    • setAttachments

      public void setAttachments​(List<Attachment> attachments)

    • 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