Package com.xero.models.accounting

Class BankTransaction

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

  • Constructor Details

    • BankTransaction

      public BankTransaction()

  • Method Details

    • type

      public BankTransaction type​(BankTransaction.TypeEnum type)

    • getType

      public BankTransaction.TypeEnum getType()
      See Bank Transaction Types
      Returns:
      type

    • setType

      public void setType​(BankTransaction.TypeEnum type)

    • contact

      public BankTransaction contact​(Contact contact)

    • getContact

      public Contact getContact()
      Get contact
      Returns:
      contact

    • setContact

      public void setContact​(Contact contact)

    • lineItems

      public BankTransaction lineItems​(List<LineItem> lineItems)

    • addLineItemsItem

      public BankTransaction addLineItemsItem​(LineItem lineItemsItem)

    • getLineItems

      public List<LineItem> getLineItems()
      See LineItems
      Returns:
      lineItems

    • setLineItems

      public void setLineItems​(List<LineItem> lineItems)

    • bankAccount

      public BankTransaction bankAccount​(Account bankAccount)

    • getBankAccount

      public Account getBankAccount()
      Get bankAccount
      Returns:
      bankAccount

    • setBankAccount

      public void setBankAccount​(Account bankAccount)

    • isReconciled

      public BankTransaction isReconciled​(Boolean isReconciled)

    • getIsReconciled

      public Boolean getIsReconciled()
      Boolean to show if transaction is reconciled
      Returns:
      isReconciled

    • setIsReconciled

      public void setIsReconciled​(Boolean isReconciled)

    • date

      public BankTransaction date​(String date)

    • getDate

      public String getDate()
      Date of transaction – 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)

    • reference

      public BankTransaction reference​(String reference)

    • getReference

      public String getReference()
      Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
      Returns:
      reference

    • setReference

      public void setReference​(String reference)

    • currencyCode

      public BankTransaction currencyCode​(CurrencyCode currencyCode)

    • getCurrencyCode

      public CurrencyCode getCurrencyCode()
      Get currencyCode
      Returns:
      currencyCode

    • setCurrencyCode

      public void setCurrencyCode​(CurrencyCode currencyCode)

    • currencyRate

      public BankTransaction currencyRate​(Double currencyRate)

    • getCurrencyRate

      public Double getCurrencyRate()
      Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments.
      Returns:
      currencyRate

    • setCurrencyRate

      public void setCurrencyRate​(Double currencyRate)

    • url

      public BankTransaction url​(String url)

    • getUrl

      public String getUrl()
      URL link to a source document – shown as “Go to App Name”
      Returns:
      url

    • setUrl

      public void setUrl​(String url)

    • status

      public BankTransaction status​(BankTransaction.StatusEnum status)

    • getStatus

      public BankTransaction.StatusEnum getStatus()
      See Bank Transaction Status Codes
      Returns:
      status

    • setStatus

      public void setStatus​(BankTransaction.StatusEnum status)

    • lineAmountTypes

      public BankTransaction lineAmountTypes​(LineAmountTypes lineAmountTypes)

    • getLineAmountTypes

      public LineAmountTypes getLineAmountTypes()
      Get lineAmountTypes
      Returns:
      lineAmountTypes

    • setLineAmountTypes

      public void setLineAmountTypes​(LineAmountTypes lineAmountTypes)

    • subTotal

      public BankTransaction subTotal​(Double subTotal)

    • getSubTotal

      public Double getSubTotal()
      Total of bank transaction excluding taxes
      Returns:
      subTotal

    • setSubTotal

      public void setSubTotal​(Double subTotal)

    • totalTax

      public BankTransaction totalTax​(Double totalTax)

    • getTotalTax

      public Double getTotalTax()
      Total tax on bank transaction
      Returns:
      totalTax

    • setTotalTax

      public void setTotalTax​(Double totalTax)

    • total

      public BankTransaction total​(Double total)

    • getTotal

      public Double getTotal()
      Total of bank transaction tax inclusive
      Returns:
      total

    • setTotal

      public void setTotal​(Double total)

    • bankTransactionID

      public BankTransaction bankTransactionID​(UUID bankTransactionID)

    • getBankTransactionID

      public UUID getBankTransactionID()
      Xero generated unique identifier for bank transaction
      Returns:
      bankTransactionID

    • setBankTransactionID

      public void setBankTransactionID​(UUID bankTransactionID)

    • getPrepaymentID

      public UUID getPrepaymentID()
      Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT
      Returns:
      prepaymentID

    • getOverpaymentID

      public UUID getOverpaymentID()
      Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT
      Returns:
      overpaymentID

    • getUpdatedDateUTC

      public String getUpdatedDateUTC()
      Last modified date UTC format
      Returns:
      updatedDateUTC

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • getHasAttachments

      public Boolean getHasAttachments()
      Boolean to indicate if a bank transaction has an attachment
      Returns:
      hasAttachments

    • statusAttributeString

      public BankTransaction 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 BankTransaction validationErrors​(List<ValidationError> validationErrors)

    • addValidationErrorsItem

      public BankTransaction 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