Xero Accounting Endpoint: BankTransactions
Jump to navigation
Jump to search
Overview
The Xero BankTransactions endpoint provides the bank transactions.
Bank transactions include:
- spend money transactions
- receive money transactions
- overpayments
- prepayments
This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many bank transactions.
In most situations, it is recommended to use the BankTransactionsExpanded. It provides many additional fields and is also optimised for larger data files.
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.
- 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.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints
- Accounts
- BatchPayments
- BankTransactionsExpanded
- Contacts
- ContactsExpanded
- Currencies
- Overpayments
- OverpaymentsExpanded
- Prepayments
- PrepaymentsExpanded