BankSummary
Displays a summary of balances and cash movements for each bank account in a Xero organization. It is useful for analyzing cash flow and understanding the financial status of bank accounts.
Columns
| Name | Type | Description |
| ID [KEY] | Integer | A unique identifier for the row, representing the sequential number of the record in the report. |
| BankAccount | String | The unique number assigned to the bank account. This number is used to identify the specific bank account associated with the financial data. |
| OpeningBalance | Decimal | The amount of funds in the account at the start of the financial period. This is the balance carried forward from the previous period. |
| CashReceived | Decimal | The total amount of money added to the account during the financial period, such as deposits, transfers, or other income. |
| CashSpent | Decimal | The total amount of money spent or withdrawn from the account during the financial period, including payments or transfers out of the account. |
| FXGain | Decimal | The changes in the account balance caused by fluctuations in exchange rates. This reflects the impact of currency conversion on the account balance during the period. |
| ClosingBalance | Decimal | The amount of funds in the account at the end of the financial period, calculated by taking the opening balance and adjusting for cash received, cash spent, and Foreign Exchange (FX) gain or loss. |
| TenantId | String | The unique identifier for the tenant, allowing queries to access data specific to a 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 |
| toDate | Datetime | The starting date for the financial period or report. This is used to filter data starting from this date. |
| fromDate | Datetime | The closing date for the financial period or report. This date marks the end of the reporting period and is used to filter data up to this date. |
| PaymentsOnly | Boolean | If the value is set to 'true', the query will return only cash transactions, filtering out non-cash-related entries such as transfers or credits. |