java.lang.Object
- com.xero.models.accounting.BankTransaction

public class BankTransaction
extends Object

BankTransaction

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`BankTransaction.StatusEnum`	See Bank Transaction Status Codes
`static class`	`BankTransaction.TypeEnum`	See Bank Transaction Types

Constructor Summary

Constructors
Constructor Description

BankTransaction()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BankTransaction`	`addLineItemsItem(LineItem lineItemsItem)`	See LineItems
`BankTransaction`	`addValidationErrorsItem(ValidationError validationErrorsItem)`	Displays array of validation error messages from the API
`BankTransaction`	`bankAccount(Account bankAccount)`	bankAccount
`BankTransaction`	`bankTransactionID(UUID bankTransactionID)`	Xero generated unique identifier for bank transaction
`BankTransaction`	`contact(Contact contact)`	contact
`BankTransaction`	`currencyCode(CurrencyCode currencyCode)`	currencyCode
`BankTransaction`	`currencyRate(Double currencyRate)`	Exchange rate to base currency when money is spent or received.
`BankTransaction`	`date(String date)`	Date of transaction – YYYY-MM-DD
`boolean`	`equals(Object o)`
`Account`	`getBankAccount()`	Get bankAccount
`UUID`	`getBankTransactionID()`	Xero generated unique identifier for bank transaction
`Contact`	`getContact()`	Get contact
`CurrencyCode`	`getCurrencyCode()`	Get currencyCode
`Double`	`getCurrencyRate()`	Exchange rate to base currency when money is spent or received.
`String`	`getDate()`	Date of transaction – YYYY-MM-DD
`org.threeten.bp.LocalDate`	`getDateAsDate()`	Date of transaction – YYYY-MM-DD
`Boolean`	`getHasAttachments()`	Boolean to indicate if a bank transaction has an attachment
`Boolean`	`getIsReconciled()`	Boolean to show if transaction is reconciled
`LineAmountTypes`	`getLineAmountTypes()`	Get lineAmountTypes
`List<LineItem>`	`getLineItems()`	See LineItems
`UUID`	`getOverpaymentID()`	Xero generated unique identifier for an Overpayment.
`UUID`	`getPrepaymentID()`	Xero generated unique identifier for a Prepayment.
`String`	`getReference()`	Reference for the transaction.
`BankTransaction.StatusEnum`	`getStatus()`	See Bank Transaction Status Codes
`String`	`getStatusAttributeString()`	A string to indicate if a invoice status
`Double`	`getSubTotal()`	Total of bank transaction excluding taxes
`Double`	`getTotal()`	Total of bank transaction tax inclusive
`Double`	`getTotalTax()`	Total tax on bank transaction
`BankTransaction.TypeEnum`	`getType()`	See Bank Transaction Types
`String`	`getUpdatedDateUTC()`	Last modified date UTC format
`org.threeten.bp.OffsetDateTime`	`getUpdatedDateUTCAsDate()`	Last modified date UTC format
`String`	`getUrl()`	URL link to a source document – shown as “Go to App Name”
`List<ValidationError>`	`getValidationErrors()`	Displays array of validation error messages from the API
`int`	`hashCode()`
`BankTransaction`	`isReconciled(Boolean isReconciled)`	Boolean to show if transaction is reconciled
`BankTransaction`	`lineAmountTypes(LineAmountTypes lineAmountTypes)`	lineAmountTypes
`BankTransaction`	`lineItems(List<LineItem> lineItems)`	See LineItems
`BankTransaction`	`reference(String reference)`	Reference for the transaction.
`void`	`setBankAccount(Account bankAccount)`	bankAccount
`void`	`setBankTransactionID(UUID bankTransactionID)`	Xero generated unique identifier for bank transaction
`void`	`setContact(Contact contact)`	contact
`void`	`setCurrencyCode(CurrencyCode currencyCode)`	currencyCode
`void`	`setCurrencyRate(Double currencyRate)`	Exchange rate to base currency when money is spent or received.
`void`	`setDate(String date)`	Date of transaction – YYYY-MM-DD
`void`	`setDate(org.threeten.bp.LocalDate date)`	Date of transaction – YYYY-MM-DD
`void`	`setIsReconciled(Boolean isReconciled)`	Boolean to show if transaction is reconciled
`void`	`setLineAmountTypes(LineAmountTypes lineAmountTypes)`	lineAmountTypes
`void`	`setLineItems(List<LineItem> lineItems)`	See LineItems
`void`	`setReference(String reference)`	Reference for the transaction.
`void`	`setStatus(BankTransaction.StatusEnum status)`	See Bank Transaction Status Codes
`void`	`setStatusAttributeString(String statusAttributeString)`	A string to indicate if a invoice status
`void`	`setSubTotal(Double subTotal)`	Total of bank transaction excluding taxes
`void`	`setTotal(Double total)`	Total of bank transaction tax inclusive
`void`	`setTotalTax(Double totalTax)`	Total tax on bank transaction
`void`	`setType(BankTransaction.TypeEnum type)`	See Bank Transaction Types
`void`	`setUrl(String url)`	URL link to a source document – shown as “Go to App Name”
`void`	`setValidationErrors(List<ValidationError> validationErrors)`	Displays array of validation error messages from the API
`BankTransaction`	`status(BankTransaction.StatusEnum status)`	See Bank Transaction Status Codes
`BankTransaction`	`statusAttributeString(String statusAttributeString)`	A string to indicate if a invoice status
`BankTransaction`	`subTotal(Double subTotal)`	Total of bank transaction excluding taxes
`String`	`toString()`
`BankTransaction`	`total(Double total)`	Total of bank transaction tax inclusive
`BankTransaction`	`totalTax(Double totalTax)`	Total tax on bank transaction
`BankTransaction`	`type(BankTransaction.TypeEnum type)`	See Bank Transaction Types
`BankTransaction`	`url(String url)`	URL link to a source document – shown as “Go to App Name”
`BankTransaction`	`validationErrors(List<ValidationError> validationErrors)`	Displays array of validation error messages from the API

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BankTransaction
```
public BankTransaction()
```
- Method Detail
  - type
```
public BankTransaction type(BankTransaction.TypeEnum type)
```
    See Bank Transaction Types
    
    Parameters:
    
    type - TypeEnum
    
    Returns:
    
    BankTransaction
  - getType
```
public BankTransaction.TypeEnum getType()
```
    See Bank Transaction Types
    
    Returns:
    
    type
  - setType
```
public void setType(BankTransaction.TypeEnum type)
```
    See Bank Transaction Types
    
    Parameters:
    
    type - TypeEnum
  - contact
```
public BankTransaction contact(Contact contact)
```
    contact
    
    Parameters:
    
    contact - Contact
    
    Returns:
    
    BankTransaction
  - getContact
```
public Contact getContact()
```
    Get contact
    
    Returns:
    
    contact
  - setContact
```
public void setContact(Contact contact)
```
    contact
    
    Parameters:
    
    contact - Contact
  - lineItems
```
public BankTransaction lineItems(List<LineItem> lineItems)
```
    See LineItems
    
    Parameters:
    
    lineItems - List<LineItem>
    
    Returns:
    
    BankTransaction
  - addLineItemsItem
```
public BankTransaction addLineItemsItem(LineItem lineItemsItem)
```
    See LineItems
    
    Parameters:
    
    lineItemsItem - LineItem
    
    Returns:
    
    BankTransaction
  - getLineItems
```
public List<LineItem> getLineItems()
```
    See LineItems
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
    See LineItems
    
    Parameters:
    
    lineItems - List<LineItem>
  - bankAccount
```
public BankTransaction bankAccount(Account bankAccount)
```
    bankAccount
    
    Parameters:
    
    bankAccount - Account
    
    Returns:
    
    BankTransaction
  - getBankAccount
```
public Account getBankAccount()
```
    Get bankAccount
    
    Returns:
    
    bankAccount
  - setBankAccount
```
public void setBankAccount(Account bankAccount)
```
    bankAccount
    
    Parameters:
    
    bankAccount - Account
  - isReconciled
```
public BankTransaction isReconciled(Boolean isReconciled)
```
    Boolean to show if transaction is reconciled
    
    Parameters:
    
    isReconciled - Boolean
    
    Returns:
    
    BankTransaction
  - getIsReconciled
```
public Boolean getIsReconciled()
```
    Boolean to show if transaction is reconciled
    
    Returns:
    
    isReconciled
  - setIsReconciled
```
public void setIsReconciled(Boolean isReconciled)
```
    Boolean to show if transaction is reconciled
    
    Parameters:
    
    isReconciled - Boolean
  - date
```
public BankTransaction date(String date)
```
    Date of transaction – YYYY-MM-DD
    
    Parameters:
    
    date - String
    
    Returns:
    
    BankTransaction
  - getDate
```
public String getDate()
```
    Date of transaction – YYYY-MM-DD
    
    Returns:
    
    date
  - getDateAsDate
```
public org.threeten.bp.LocalDate getDateAsDate()
```
    Date of transaction – YYYY-MM-DD
    
    Returns:
    
    LocalDate
  - setDate
```
public void setDate(String date)
```
    Date of transaction – YYYY-MM-DD
    
    Parameters:
    
    date - String
  - setDate
```
public void setDate(org.threeten.bp.LocalDate date)
```
    Date of transaction – YYYY-MM-DD
    
    Parameters:
    
    date - LocalDateTime
  - reference
```
public BankTransaction reference(String reference)
```
    Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
    
    Parameters:
    
    reference - String
    
    Returns:
    
    BankTransaction
  - getReference
```
public String getReference()
```
    Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
    Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
    
    Parameters:
    
    reference - String
  - currencyCode
```
public BankTransaction currencyCode(CurrencyCode currencyCode)
```
    currencyCode
    
    Parameters:
    
    currencyCode - CurrencyCode
    
    Returns:
    
    BankTransaction
  - getCurrencyCode
```
public CurrencyCode getCurrencyCode()
```
    Get currencyCode
    
    Returns:
    
    currencyCode
  - setCurrencyCode
```
public void setCurrencyCode(CurrencyCode currencyCode)
```
    currencyCode
    
    Parameters:
    
    currencyCode - CurrencyCode
  - currencyRate
```
public BankTransaction currencyRate(Double currencyRate)
```
    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.
    
    Parameters:
    
    currencyRate - Double
    
    Returns:
    
    BankTransaction
  - 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)
```
    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.
    
    Parameters:
    
    currencyRate - Double
  - url
```
public BankTransaction url(String url)
```
    URL link to a source document – shown as “Go to App Name”
    
    Parameters:
    
    url - String
    
    Returns:
    
    BankTransaction
  - getUrl
```
public String getUrl()
```
    URL link to a source document – shown as “Go to App Name”
    
    Returns:
    
    url
  - setUrl
```
public void setUrl(String url)
```
    URL link to a source document – shown as “Go to App Name”
    
    Parameters:
    
    url - String
  - status
```
public BankTransaction status(BankTransaction.StatusEnum status)
```
    See Bank Transaction Status Codes
    
    Parameters:
    
    status - StatusEnum
    
    Returns:
    
    BankTransaction
  - getStatus
```
public BankTransaction.StatusEnum getStatus()
```
    See Bank Transaction Status Codes
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(BankTransaction.StatusEnum status)
```
    See Bank Transaction Status Codes
    
    Parameters:
    
    status - StatusEnum
  - lineAmountTypes
```
public BankTransaction lineAmountTypes(LineAmountTypes lineAmountTypes)
```
    lineAmountTypes
    
    Parameters:
    
    lineAmountTypes - LineAmountTypes
    
    Returns:
    
    BankTransaction
  - getLineAmountTypes
```
public LineAmountTypes getLineAmountTypes()
```
    Get lineAmountTypes
    
    Returns:
    
    lineAmountTypes
  - setLineAmountTypes
```
public void setLineAmountTypes(LineAmountTypes lineAmountTypes)
```
    lineAmountTypes
    
    Parameters:
    
    lineAmountTypes - LineAmountTypes
  - subTotal
```
public BankTransaction subTotal(Double subTotal)
```
    Total of bank transaction excluding taxes
    
    Parameters:
    
    subTotal - Double
    
    Returns:
    
    BankTransaction
  - getSubTotal
```
public Double getSubTotal()
```
    Total of bank transaction excluding taxes
    
    Returns:
    
    subTotal
  - setSubTotal
```
public void setSubTotal(Double subTotal)
```
    Total of bank transaction excluding taxes
    
    Parameters:
    
    subTotal - Double
  - totalTax
```
public BankTransaction totalTax(Double totalTax)
```
    Total tax on bank transaction
    
    Parameters:
    
    totalTax - Double
    
    Returns:
    
    BankTransaction
  - getTotalTax
```
public Double getTotalTax()
```
    Total tax on bank transaction
    
    Returns:
    
    totalTax
  - setTotalTax
```
public void setTotalTax(Double totalTax)
```
    Total tax on bank transaction
    
    Parameters:
    
    totalTax - Double
  - total
```
public BankTransaction total(Double total)
```
    Total of bank transaction tax inclusive
    
    Parameters:
    
    total - Double
    
    Returns:
    
    BankTransaction
  - getTotal
```
public Double getTotal()
```
    Total of bank transaction tax inclusive
    
    Returns:
    
    total
  - setTotal
```
public void setTotal(Double total)
```
    Total of bank transaction tax inclusive
    
    Parameters:
    
    total - Double
  - bankTransactionID
```
public BankTransaction bankTransactionID(UUID bankTransactionID)
```
    Xero generated unique identifier for bank transaction
    
    Parameters:
    
    bankTransactionID - UUID
    
    Returns:
    
    BankTransaction
  - getBankTransactionID
```
public UUID getBankTransactionID()
```
    Xero generated unique identifier for bank transaction
    
    Returns:
    
    bankTransactionID
  - setBankTransactionID
```
public void setBankTransactionID(UUID bankTransactionID)
```
    Xero generated unique identifier for bank transaction
    
    Parameters:
    
    bankTransactionID - UUID
  - 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()
```
    Last modified date UTC format
    
    Returns:
    
    OffsetDateTime
  - getHasAttachments
```
public Boolean getHasAttachments()
```
    Boolean to indicate if a bank transaction has an attachment
    
    Returns:
    
    hasAttachments
  - statusAttributeString
```
public BankTransaction statusAttributeString(String statusAttributeString)
```
    A string to indicate if a invoice status
    
    Parameters:
    
    statusAttributeString - String
    
    Returns:
    
    BankTransaction
  - getStatusAttributeString
```
public String getStatusAttributeString()
```
    A string to indicate if a invoice status
    
    Returns:
    
    statusAttributeString
  - setStatusAttributeString
```
public void setStatusAttributeString(String statusAttributeString)
```
    A string to indicate if a invoice status
    
    Parameters:
    
    statusAttributeString - String
  - validationErrors
```
public BankTransaction validationErrors(List<ValidationError> validationErrors)
```
    Displays array of validation error messages from the API
    
    Parameters:
    
    validationErrors - List<ValidationError>
    
    Returns:
    
    BankTransaction
  - addValidationErrorsItem
```
public BankTransaction addValidationErrorsItem(ValidationError validationErrorsItem)
```
    Displays array of validation error messages from the API
    
    Parameters:
    
    validationErrorsItem - ValidationError
    
    Returns:
    
    BankTransaction
  - getValidationErrors
```
public List<ValidationError> getValidationErrors()
```
    Displays array of validation error messages from the API
    
    Returns:
    
    validationErrors
  - setValidationErrors
```
public void setValidationErrors(List<ValidationError> validationErrors)
```
    Displays array of validation error messages from the API
    
    Parameters:
    
    validationErrors - List<ValidationError>
  - 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

Class BankTransaction

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BankTransaction

Method Detail

type

getType

setType

contact

getContact

setContact

lineItems

addLineItemsItem

getLineItems

setLineItems

bankAccount

getBankAccount

setBankAccount

isReconciled

getIsReconciled

setIsReconciled

date

getDate

getDateAsDate

setDate

setDate

reference

getReference

setReference

currencyCode

getCurrencyCode

setCurrencyCode

currencyRate

getCurrencyRate

setCurrencyRate

url

getUrl

setUrl

status

getStatus

setStatus

lineAmountTypes

getLineAmountTypes

setLineAmountTypes

subTotal

getSubTotal

setSubTotal

totalTax

getTotalTax

setTotalTax

total

getTotal

setTotal

bankTransactionID

getBankTransactionID

setBankTransactionID

getPrepaymentID

getOverpaymentID

getUpdatedDateUTC

getUpdatedDateUTCAsDate

getHasAttachments

statusAttributeString

getStatusAttributeString

setStatusAttributeString

validationErrors

addValidationErrorsItem

getValidationErrors

setValidationErrors

equals

hashCode

toString