Xero Accounting Endpoint: BankTransactionsExpanded
Jump to navigation
Jump to search
Overview
The Xero BankTransactionsExpanded endpoint provides the bank transactions.
Bank transactions include:
- spend money transactions
- receive money transactions
- overpayments
- prepayments
This endpoints provides access to all fields and details. It is also optimised for larger data files.
In most situations, it is recommended to use this endpoint instead of the BankTransactions endpoint.
Fields
The following fields are available for the BankTransfers endpoint.
- BankTransactionID
- A guid field that provides the id of the transaction.
- BankAccount
- A record field that provides the bank account affected by the transaction.
- BatchPayment
- A record field that provides the batch payment linked to this transaction if it is part of a batch payment.
- Type
- A text field that indicates the type of bank transaction.
- Possible values are:
- RECEIVE: Indicates the transaction is a receive money transaction.
- RECEIVE-OVERPAYMENT: Indicates the transaction is an overpayment on the accounts receivable / customer side.
- RECEIVE-PREPAYMENT: Indicates the transaction is an prepayment on the accounts receivable / customer side.
- RECEIVE-TRANSFER: Indicates the transaction is a transfer on the accounts receivable / customer side.
- SPEND: Indicates the transaction is a spend money transaction.
- SPEND-OVERPAYMENT: Indicates the transaction is an overpayment on the accounts payable /supplier side.
- SPEND-PREPAYMENT: Indicates the transaction is an prepayment on the accounts payable /supplier side.
- SPEND-TRANSFER: Indicates the transaction is transfer on the accounts payable /supplier side.
- Reference
- A text field that indicates the reference of the transaction.
- This field is only available for transactions whose Type is either RECEIVE or SPEND.
- IsReconciled
- A true/false field that indicates if the transaction has been reconciled.
- PrepaymentID
- A guid field that provides the id of of the prepayment if applicable.
- This field is only available for transactions whose Type is either RECEIVE-PREPAYMENT or SPEND-PREPAYMENT.
- OverpaymentID
- A guid field that provides the id of of the overpayment if applicable.
- This field is only available for transactions whose Type is either RECEIVE-OVERPAYMENT or SPEND-OVERPAYMENT.
- HasAttachments
- A true/false field that indicates if attachments were uploaded against the transaction.
- Contact
- A record field that provides the contact associated with the transaction.
- Date
- A date field that provides the date on which the transaction occurred.
- Status
- A text field that indicates the status of the bank transaction.
- Possible values are:
- AUTHORISED: Indicates the transaction is authorised and has been processed.
- DELETED: Indicates the transaction has been deleted.
- LineAmountTypes
- A text field that indicates the type of values on the lines.
- Possible values are:
- Exclusive: Indicates that line items are exclusive of tax.
- Inclusive: Indicates that line items are inclusive tax.
- NoTax: Indicates that line items have no tax.
- LineItems
- A table field that provides the lines entered against the transaction.
- See LineItems Fields for more information.
- Subtotal
- A decimal field that provides the tax exclusive amount of the transaction.
- TotalTax
- A decimal field that provides the tax amount of the transaction.
- Total
- A decimal field that provides the total amount of the transaction.
- CurrencyCode
- A text field that indicates the currency of the bank transaction.
- CurrencyRate
- A decimal field that provides the exchange rate applied to the transaction.
- Url
- A text field that provides the url to the source document.
- UpdatedDateUTC
- A date time field that indicates the date and time this transfer was created and/or updated.
LineItems Fields
The LineItems Fields include the following sub fields.
- ItemCode
- A text field that provides the item of the line.
- Description
- A text field that provides the description of the line.
- UnitAmount
- A decimal field that provides the unit amount of the line.
- TaxType
- A text field that provides the tax type of the line.
- TaxAmount
- A decimal field that provides the tax amount of the line.
- LineAmount
- A decimal field that provides the amount of the line.
- AccountID
- A guid field that provides the account id of the line.
- AccountCode
- A text field that provides the account code of the line.
- Tracking
- A table field that provides the tracking category options assigned to the line.
- Quantity
- A decimal field that provides the quantity entered on the line.
- LineItemID
- A text field that provides the internal id of the line.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints
- Accounts
- BankTransactions
- BatchPayments
- Contacts
- ContactsExpanded
- Currencies
- Items
- Overpayments
- OverpaymentsExpanded
- Prepayments
- PrepaymentsExpanded
- TaxRates
- TrackingCategories