BankStatement
Queries the transactions listed on a particular bank account. It includes deposits, withdrawals, and other banking activities associated with the organization's accounts.
Table Specific Information
SELECT
A bankAccountId may be provided when querying this view. If one is not given, then this report will be run for each bank account stored in Xero.
Note: To access bank statements, you must complete additional security requirements:
- Sign an addendum to Xero's developer terms and conditions.
- Request the accounting.reports.bankstatement.read scope in your custom OAuth app.
For more information and to complete these steps, reach out directly to Xero API support.
Columns
| Name | Type | Description |
| BankAccountId | String | The unique identifier for the bank account associated with the transaction. This ID links the transaction to a specific bank account. |
| Date | Date | The date on which the transaction occurred, indicating when the transaction was recorded in the bank account. |
| Description | String | A brief description of the transaction, which can include details such as the type of transaction, the party involved, or the purpose of the payment. |
| Reference | String | A reference value for the transaction, which could be a unique identifier, invoice number, or transaction ID used for tracking or linking to other records. |
| Reconciled | String | Indicates whether the transaction has been reconciled with the bank statement. Possible values are 'Yes' if reconciled, and 'No' if it has not yet been reconciled. |
| Source | String | The origin of the transaction, such as a bank deposit, transfer, payment, or withdrawal, providing context for where the transaction originated. |
| Amount | Decimal | The monetary value of the transaction, representing either the payment made or the deposit received in the bank account. |
| Balance | Decimal | The running balance of the account after the transaction has been applied. This reflects the total amount in the account after the transaction is processed. |
| TenantId | String | The unique identifier of the tenant, allowing the query to access data for a specific tenant rather than using the default connection tenant. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| fromDate | Date | The start date for the bank statement period, which is used to filter transactions from this specific date onward. |
| toDate | Date | The end date for the bank statement period. This date must be within 365 days from the 'fromDate' and is used to filter transactions up to this date. |