Package com.xero.models.accounting

Class BatchPayment

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

  • Constructor Details

    • BatchPayment

      public BatchPayment()

  • Method Details

    • account

      public BatchPayment account​(Account account)

    • getAccount

      public Account getAccount()
      Get account
      Returns:
      account

    • setAccount

      public void setAccount​(Account account)

    • reference

      public BatchPayment reference​(String reference)

    • getReference

      public String getReference()
      (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.
      Returns:
      reference

    • setReference

      public void setReference​(String reference)

    • particulars

      public BatchPayment particulars​(String particulars)

    • getParticulars

      public String getParticulars()
      (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.
      Returns:
      particulars

    • setParticulars

      public void setParticulars​(String particulars)

    • code

      public BatchPayment code​(String code)

    • getCode

      public String getCode()
      (NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.
      Returns:
      code

    • setCode

      public void setCode​(String code)

    • details

      public BatchPayment details​(String details)

    • getDetails

      public String getDetails()
      (Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
      Returns:
      details

    • setDetails

      public void setDetails​(String details)

    • narrative

      public BatchPayment narrative​(String narrative)

    • getNarrative

      public String getNarrative()
      (UK Only) Only shows on the statement line in Xero. Max length =18
      Returns:
      narrative

    • setNarrative

      public void setNarrative​(String narrative)

    • getBatchPaymentID

      public UUID getBatchPaymentID()
      The Xero generated unique identifier for the bank transaction (read-only)
      Returns:
      batchPaymentID

    • dateString

      public BatchPayment dateString​(String dateString)

    • getDateString

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

    • setDateString

      public void setDateString​(String dateString)

    • date

      public BatchPayment 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)

    • amount

      public BatchPayment 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)

    • payments

      public BatchPayment payments​(List<Payment> payments)

    • addPaymentsItem

      public BatchPayment addPaymentsItem​(Payment paymentsItem)

    • getPayments

      public List<Payment> getPayments()
      An array of payments
      Returns:
      payments

    • setPayments

      public void setPayments​(List<Payment> payments)

    • getType

      public BatchPayment.TypeEnum getType()
      PAYBATCH for bill payments or RECBATCH for sales invoice payments (read-only)
      Returns:
      type

    • getStatus

      public BatchPayment.StatusEnum getStatus()
      AUTHORISED or DELETED (read-only). New batch payments will have a status of AUTHORISED. It is not possible to delete batch payments via the API.
      Returns:
      status

    • getTotalAmount

      public String getTotalAmount()
      The total of the payments that make up the batch (read-only)
      Returns:
      totalAmount

    • getUpdatedDateUTC

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

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • getIsReconciled

      public String getIsReconciled()
      Booelan that tells you if the batch payment has been reconciled (read-only)
      Returns:
      isReconciled

    • 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