com.xero.models.accounting

Class BankTransaction

java.lang.Object

com.xero.models.accounting.BankTransaction

public class BankTransaction
extends Object

BankTransaction

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
BankTransaction()

Method Summary

Modifier and Type	Method and Description
BankTransaction	addLineitemsItem(LineItem lineitemsItem)
BankTransaction	addValidationErrorsItem(ValidationError validationErrorsItem)
BankTransaction	bankAccount(Account bankAccount)
BankTransaction	bankTransactionID(UUID bankTransactionID)
BankTransaction	contact(Contact contact)
BankTransaction	currencyCode(CurrencyCode currencyCode)
BankTransaction	currencyRate(Double currencyRate)
BankTransaction	date(org.threeten.bp.LocalDate date)
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.
org.threeten.bp.LocalDate	getDate() 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
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() 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)
BankTransaction	lineAmountTypes(LineAmountTypes lineAmountTypes)
BankTransaction	lineitems(List<LineItem> lineitems)
BankTransaction	reference(String reference)
void	setBankAccount(Account bankAccount)
void	setBankTransactionID(UUID bankTransactionID)
void	setContact(Contact contact)
void	setCurrencyCode(CurrencyCode currencyCode)
void	setCurrencyRate(Double currencyRate)
void	setDate(org.threeten.bp.LocalDate date)
void	setIsReconciled(Boolean isReconciled)
void	setLineAmountTypes(LineAmountTypes lineAmountTypes)
void	setLineitems(List<LineItem> lineitems)
void	setReference(String reference)
void	setStatus(BankTransaction.StatusEnum status)
void	setStatusAttributeString(String statusAttributeString)
void	setSubTotal(Double subTotal)
void	setTotal(Double total)
void	setTotalTax(Double totalTax)
void	setType(BankTransaction.TypeEnum type)
void	setUrl(String url)
void	setValidationErrors(List<ValidationError> validationErrors)
BankTransaction	status(BankTransaction.StatusEnum status)
BankTransaction	statusAttributeString(String statusAttributeString)
BankTransaction	subTotal(Double subTotal)
String	toString()
BankTransaction	total(Double total)
BankTransaction	totalTax(Double totalTax)
BankTransaction	type(BankTransaction.TypeEnum type)
BankTransaction	url(String url)
BankTransaction	validationErrors(List<ValidationError> validationErrors)

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)

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(org.threeten.bp.LocalDate date)

getDate

public org.threeten.bp.LocalDate getDate()

Date of transaction – YYYY-MM-DD

Returns:

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 org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

Last modified date UTC format

Returns:

updatedDateUTC

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