BankTransfers
Manages bank transfer records. It allows for querying and editing transfers between accounts, helping track money movements between different bank accounts.
Table Specific Information
The BankTransfers table allows you to SELECT and INSERT bank transfers for a Xero organization.
SELECT
The Xero API allows extensive filtering and ordering. You can define WHERE and ORDER BY clauses in a query to filter and order the results using any non-line-item column.
Note: The Xero API does not support filtering on line items or journal lines.
INSERT
To insert a single row, set the required fields. A new table object is created as a single entry.
The following fields are required for inserts: FromBankAccount_Code, ToBankAccount_Code, and Amount
INSERT INTO BankTransfers (FromBankAccount_Code, ToBankAccount_Code, Amount) VALUES ('3d08fd48-434d-4c18-a57b-831663ab70d2', 'ceef65a5-a545-423b-9312-78a53caadbc4', '1000.00')
Columns
| Name | Type | ReadOnly | Description |
| BankTransferId [KEY] | String | True |
A unique identifier assigned by Xero to each bank transfer. This ID is used to reference a specific bank transfer transaction in the system. |
| FromBankAccount_Code | String | False |
The code associated with the bank account from which the money is being transferred. This code identifies the source account in financial transactions. |
| FromBankAccount_AccountId | String | False |
The unique identifier for the bank account from which the money is being sent. This ID links the transfer to the specific source account. |
| FromBankAccount_Name | String | False |
The name of the bank account from which the money is being transferred. This is a user-friendly label for the source account. |
| ToBankAccount_Code | String | False |
The code associated with the bank account to which the money is being transferred. This code identifies the destination account. |
| ToBankAccount_AccountId | String | False |
The unique identifier for the bank account to which the money is being sent. This ID links the transfer to the specific destination account. |
| ToBankAccount_Name | String | False |
The name of the bank account to which the money is being transferred. This is a user-friendly label for the destination account. |
| Amount | Decimal | False |
The amount of money being transferred. This represents the value being moved from the source bank account to the destination account. |
| Date | Date | False |
The date on which the bank transfer occurred, represented in the format YYYY-MM-DD. This is the date when the transaction was processed. |
| CurrencyRate | Decimal | True |
The exchange rate applied to the transfer if the source and destination accounts use different currencies. This rate determines the conversion between currencies. |
| FromBankTransactionID | String | True |
The unique identifier for the bank transaction associated with the source account. This ID links the bank transfer to the original transaction in the source account. |
| ToBankTransactionID | String | True |
The unique identifier for the bank transaction associated with the destination account. This ID links the bank transfer to the corresponding transaction in the destination account. |
| HasAttachments | Boolean | True |
A boolean value indicating whether the bank transfer includes any attachments, such as receipts, documents, or other supporting files. |
| TenantId | String | False |
The unique identifier for the tenant, allowing queries to access data specific to a particular tenant rather than using the default connection tenant. |