Package com.xero.models.accounting

Class Payment

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

  • Constructor Details

    • Payment

      public Payment()

  • Method Details

    • invoice

      public Payment invoice​(Invoice invoice)

    • getInvoice

      public Invoice getInvoice()
      Get invoice
      Returns:
      invoice

    • setInvoice

      public void setInvoice​(Invoice invoice)

    • creditNote

      public Payment creditNote​(CreditNote creditNote)

    • getCreditNote

      public CreditNote getCreditNote()
      Get creditNote
      Returns:
      creditNote

    • setCreditNote

      public void setCreditNote​(CreditNote creditNote)

    • prepayment

      public Payment prepayment​(Prepayment prepayment)

    • getPrepayment

      public Prepayment getPrepayment()
      Get prepayment
      Returns:
      prepayment

    • setPrepayment

      public void setPrepayment​(Prepayment prepayment)

    • overpayment

      public Payment overpayment​(Overpayment overpayment)

    • getOverpayment

      public Overpayment getOverpayment()
      Get overpayment
      Returns:
      overpayment

    • setOverpayment

      public void setOverpayment​(Overpayment overpayment)

    • invoiceNumber

      public Payment invoiceNumber​(String invoiceNumber)

    • getInvoiceNumber

      public String getInvoiceNumber()
      Number of invoice or credit note you are applying payment to e.g.INV-4003
      Returns:
      invoiceNumber

    • setInvoiceNumber

      public void setInvoiceNumber​(String invoiceNumber)

    • creditNoteNumber

      public Payment creditNoteNumber​(String creditNoteNumber)

    • getCreditNoteNumber

      public String getCreditNoteNumber()
      Number of invoice or credit note you are applying payment to e.g. INV-4003
      Returns:
      creditNoteNumber

    • setCreditNoteNumber

      public void setCreditNoteNumber​(String creditNoteNumber)

    • account

      public Payment account​(Account account)

    • getAccount

      public Account getAccount()
      Get account
      Returns:
      account

    • setAccount

      public void setAccount​(Account account)

    • code

      public Payment code​(String code)

    • getCode

      public String getCode()
      Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)
      Returns:
      code

    • setCode

      public void setCode​(String code)

    • date

      public Payment date​(String date)

    • getDate

      public String getDate()
      Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
      Returns:
      date

    • getDateAsDate

      public org.threeten.bp.LocalDate getDateAsDate()

    • setDate

      public void setDate​(String date)

    • setDate

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

    • currencyRate

      public Payment currencyRate​(Double currencyRate)

    • getCurrencyRate

      public Double getCurrencyRate()
      Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500
      Returns:
      currencyRate

    • setCurrencyRate

      public void setCurrencyRate​(Double currencyRate)

    • amount

      public Payment amount​(Double amount)

    • getAmount

      public Double getAmount()
      The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00
      Returns:
      amount

    • setAmount

      public void setAmount​(Double amount)

    • reference

      public Payment reference​(String reference)

    • getReference

      public String getReference()
      An optional description for the payment e.g. Direct Debit
      Returns:
      reference

    • setReference

      public void setReference​(String reference)

    • isReconciled

      public Payment isReconciled​(Boolean isReconciled)

    • getIsReconciled

      public Boolean getIsReconciled()
      An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET
      Returns:
      isReconciled

    • setIsReconciled

      public void setIsReconciled​(Boolean isReconciled)

    • status

      public Payment status​(Payment.StatusEnum status)

    • getStatus

      public Payment.StatusEnum getStatus()
      The status of the payment.
      Returns:
      status

    • setStatus

      public void setStatus​(Payment.StatusEnum status)

    • getPaymentType

      public Payment.PaymentTypeEnum getPaymentType()
      See Payment Types.
      Returns:
      paymentType

    • getUpdatedDateUTC

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

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • paymentID

      public Payment paymentID​(UUID paymentID)

    • getPaymentID

      public UUID getPaymentID()
      The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
      Returns:
      paymentID

    • setPaymentID

      public void setPaymentID​(UUID paymentID)

    • bankAccountNumber

      public Payment bankAccountNumber​(String bankAccountNumber)

    • getBankAccountNumber

      public String getBankAccountNumber()
      The suppliers bank account number the payment is being made to
      Returns:
      bankAccountNumber

    • setBankAccountNumber

      public void setBankAccountNumber​(String bankAccountNumber)

    • particulars

      public Payment particulars​(String particulars)

    • getParticulars

      public String getParticulars()
      The suppliers bank account number the payment is being made to
      Returns:
      particulars

    • setParticulars

      public void setParticulars​(String particulars)

    • details

      public Payment details​(String details)

    • getDetails

      public String getDetails()
      The information to appear on the supplier's bank account
      Returns:
      details

    • setDetails

      public void setDetails​(String details)

    • hasAccount

      public Payment hasAccount​(Boolean hasAccount)

    • getHasAccount

      public Boolean getHasAccount()
      A boolean to indicate if a contact has an validation errors
      Returns:
      hasAccount

    • setHasAccount

      public void setHasAccount​(Boolean hasAccount)

    • hasValidationErrors

      public Payment hasValidationErrors​(Boolean hasValidationErrors)

    • getHasValidationErrors

      public Boolean getHasValidationErrors()
      A boolean to indicate if a contact has an validation errors
      Returns:
      hasValidationErrors

    • setHasValidationErrors

      public void setHasValidationErrors​(Boolean hasValidationErrors)

    • statusAttributeString

      public Payment statusAttributeString​(String statusAttributeString)

    • getStatusAttributeString

      public String getStatusAttributeString()
      A string to indicate if a invoice status
      Returns:
      statusAttributeString

    • setStatusAttributeString

      public void setStatusAttributeString​(String statusAttributeString)

    • validationErrors

      public Payment validationErrors​(List<ValidationError> validationErrors)

    • addValidationErrorsItem

      public Payment addValidationErrorsItem​(ValidationError validationErrorsItem)

    • getValidationErrors

      public List<ValidationError> getValidationErrors()
      Displays array of validation error messages from the API
      Returns:
      validationErrors

    • setValidationErrors

      public void setValidationErrors​(List<ValidationError> validationErrors)

    • 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