HistoryBankTransactions
Used for querying and inserting the history and notes of bank transactions. This helps maintain historical records of financial activity within Xero.
Table Specific Information
The HistoryBankTransactions table allows you to read the notes created on a transaction, and the history of changes to that transaction. If a BankTransactionId is not provided, the history of all BankTransactions will be retrieved.
A BankTransactionId and Details is required for inserting a note:
INSERT INTO HistoryBankTransactions (BankTransactionId, Details) VALUES ('...', 'Refund for overpayment'),
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique identifier for the history item, combining its position in the history log with the timestamp of when the change occurred. This ensures each entry is distinctly identifiable in the log. |
| BankTransactionId | String | False |
The unique identifier of the bank transaction to which this history item is related. This field links the history entry to a specific bank transaction record, allowing users to track changes made to that transaction. |
| Changes | String | True |
Describes the type of change that occurred on the bank transaction. This could include updates such as changes to the transaction amount, category, date, or status, providing context for the nature of the modification. |
| Date | Datetime | True |
The timestamp of when the change occurred. This field records the exact time the change was made, providing a chronological record of modifications to the bank transaction. |
| User | String | True |
The name of the user who made the change. This field identifies the individual responsible for modifying the bank transaction, allowing for tracking and accountability in the system. |
| Details | String | False |
A detailed description of the change that was made. This provides specific information about what exactly was altered in the transaction, offering transparency into the modifications made. |
| TenantId | String | False |
The unique identifier of the tenant. This allows the query to access data specific to a particular tenant in multi-tenant environments, ensuring that the history item belongs to the correct organization. |