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	bankAccount(Object bankAccount)
BankTransaction	contact(Object contact)
BankTransaction	currencyCode(String currencyCode)
BankTransaction	currencyRate(Float currencyRate)
BankTransaction	date(String date)
boolean	equals(Object o)
Object	getBankAccount() Get bankAccount
UUID	getBankTransactionID() Xero generated unique identifier for bank transaction
Object	getContact() Get contact
String	getCurrencyCode() The currency that bank transaction has been raised in (see Currencies).
Float	getCurrencyRate() Exchange rate to base currency when money is spent or received.
String	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
String	getLineAmountTypes() Line amounts are exclusive of tax by default if you don’t specify this element.
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
Float	getSubTotal() Total of bank transaction excluding taxes
Float	getTotal() Total of bank transaction tax inclusive
Float	getTotalTax() Total tax on bank transaction
BankTransaction.TypeEnum	getType() See Bank Transaction Types
String	getUpdatedDateUTC() Last modified date UTC format
String	getUrl() URL link to a source document – shown as “Go to App Name”
int	hashCode()
BankTransaction	isReconciled(Boolean isReconciled)
BankTransaction	lineAmountTypes(String lineAmountTypes)
BankTransaction	lineitems(List<LineItem> lineitems)
BankTransaction	reference(String reference)
void	setBankAccount(Object bankAccount)
void	setContact(Object contact)
void	setCurrencyCode(String currencyCode)
void	setCurrencyRate(Float currencyRate)
void	setDate(String date)
void	setIsReconciled(Boolean isReconciled)
void	setLineAmountTypes(String lineAmountTypes)
void	setLineitems(List<LineItem> lineitems)
void	setReference(String reference)
void	setStatus(BankTransaction.StatusEnum status)
void	setSubTotal(Float subTotal)
void	setTotal(Float total)
void	setTotalTax(Float totalTax)
void	setType(BankTransaction.TypeEnum type)
void	setUrl(String url)
BankTransaction	status(BankTransaction.StatusEnum status)
BankTransaction	subTotal(Float subTotal)
String	toString()
BankTransaction	total(Float total)
BankTransaction	totalTax(Float totalTax)
BankTransaction	type(BankTransaction.TypeEnum type)
BankTransaction	url(String url)

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(Object contact)

getContact

public Object getContact()

Get contact

Returns:

contact

setContact

public void setContact(Object 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(Object bankAccount)

getBankAccount

public Object getBankAccount()

Get bankAccount

Returns:

bankAccount

setBankAccount

public void setBankAccount(Object 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

setDate

public void setDate(String 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(String currencyCode)

getCurrencyCode

public String getCurrencyCode()

The currency that bank transaction has been raised in (see Currencies). Setting currency is only supported on overpayments.

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(String currencyCode)

currencyRate

public BankTransaction currencyRate(Float currencyRate)

getCurrencyRate

public Float 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(Float 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(String lineAmountTypes)

getLineAmountTypes

public String getLineAmountTypes()

Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types

Returns:

lineAmountTypes

setLineAmountTypes

public void setLineAmountTypes(String lineAmountTypes)

subTotal

public BankTransaction subTotal(Float subTotal)

getSubTotal

public Float getSubTotal()

Total of bank transaction excluding taxes

Returns:

subTotal

setSubTotal

public void setSubTotal(Float subTotal)

totalTax

public BankTransaction totalTax(Float totalTax)

getTotalTax

public Float getTotalTax()

Total tax on bank transaction

Returns:

totalTax

setTotalTax

public void setTotalTax(Float totalTax)

total

public BankTransaction total(Float total)

getTotal

public Float getTotal()

Total of bank transaction tax inclusive

Returns:

total

setTotal

public void setTotal(Float total)

getBankTransactionID

public UUID getBankTransactionID()

Xero generated unique identifier for bank transaction

Returns:

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

getHasAttachments

public Boolean getHasAttachments()

Boolean to indicate if a bank transaction has an attachment

Returns:

hasAttachments

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