BankStatement
Query the transactions listed on the account.
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 ID of the bank account this is reporting on |
| Date | Date | The date when the transaction occurred |
| Description | String | The transaction's description |
| Reference | String | The transaction's reference value |
| Reconciled | String | Whether the transaction has been reconciled ('Yes' or 'No') |
| Source | String | Where the transaction came from |
| Amount | Decimal | The transaction's value |
| Balance | Decimal | The statement's running total |
| TenantId | String | The ID of the tenant to query instead of the 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 of the statement |
| toDate | Date | The end date of the statement. Must be within 365 days of the start. |