--- title: "Retrieves all bank transfers" method: GET path: "/BankTransfers" tags: ["Accounting"] --- # Retrieves all bank transfers `GET /BankTransfers` ## Query parameters - `where` string - `order` string - `includeDeleted` boolean ## Headers - `If-Modified-Since` string, date-time ## Response `200` Success - return response of BankTransfers array of 0 to N BankTransfer - BankTransfers - `BankTransfers` BankTransfer[] - `FromBankAccount` Account, required - `Code` string — Customer defined alpha numeric account code e.g 200 or SALES (max length = 10) - `Name` string — Name of account (max length = 150) - `AccountID` string, uuid — The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `Type` 'BANK' | 'CURRENT' | 'CURRLIAB' | 'DEPRECIATN' | 'DIRECTCOSTS' | 'EQUITY' | 'EXPENSE' | 'FIXED' | 'INVENTORY' | 'LIABILITY' | 'NONCURRENT' | 'OTHERINCOME' | 'OVERHEADS' | 'PREPAYMENT' | 'REVENUE' | 'SALES' | 'TERMLIAB' | 'PAYG' — See Account Types - `BankAccountNumber` string — For bank accounts only (Account Type BANK) - `Status` 'ACTIVE' | 'ARCHIVED' | 'DELETED' — Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes - `Description` string — Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000) - `BankAccountType` 'BANK' | 'CREDITCARD' | 'PAYPAL' | 'NONE' | '' — For bank accounts only. See Bank Account types - `CurrencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EEK' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZMK' | 'ZWD' — 3 letter alpha code for the currency – see list of currency codes - `TaxType` string — The tax type from taxRates - `EnablePaymentsToAccount` boolean — Boolean – describes whether account can have payments applied to it - `ShowInExpenseClaims` boolean — Boolean – describes whether account code is available for use with expense claims - `Class` 'ASSET' | 'EQUITY' | 'EXPENSE' | 'LIABILITY' | 'REVENUE' — See Account Class Types - `SystemAccount` 'DEBTORS' | 'CREDITORS' | 'BANKCURRENCYGAIN' | 'GST' | 'GSTONIMPORTS' | 'HISTORICAL' | 'REALISEDCURRENCYGAIN' | 'RETAINEDEARNINGS' | 'ROUNDING' | 'TRACKINGTRANSFERS' | 'UNPAIDEXPCLM' | 'UNREALISEDCURRENCYGAIN' | 'WAGEPAYABLES' | 'CISASSETS' | 'CISASSET' | 'CISLABOUR' | 'CISLABOUREXPENSE' | 'CISLABOURINCOME' | 'CISLIABILITY' | 'CISMATERIALS' | '' — If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null. - `ReportingCode` string — Shown if set - `ReportingCodeName` string — Shown if set - `HasAttachments` boolean — boolean to indicate if an account has an attachment (read only) - `UpdatedDateUTC` string — Last modified date UTC format - `AddToWatchlist` boolean — Boolean – describes whether the account is shown in the watchlist widget on the dashboard - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `ToBankAccount` Account, required - `Code` string — Customer defined alpha numeric account code e.g 200 or SALES (max length = 10) - `Name` string — Name of account (max length = 150) - `AccountID` string, uuid — The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 - `Type` 'BANK' | 'CURRENT' | 'CURRLIAB' | 'DEPRECIATN' | 'DIRECTCOSTS' | 'EQUITY' | 'EXPENSE' | 'FIXED' | 'INVENTORY' | 'LIABILITY' | 'NONCURRENT' | 'OTHERINCOME' | 'OVERHEADS' | 'PREPAYMENT' | 'REVENUE' | 'SALES' | 'TERMLIAB' | 'PAYG' — See Account Types - `BankAccountNumber` string — For bank accounts only (Account Type BANK) - `Status` 'ACTIVE' | 'ARCHIVED' | 'DELETED' — Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes - `Description` string — Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000) - `BankAccountType` 'BANK' | 'CREDITCARD' | 'PAYPAL' | 'NONE' | '' — For bank accounts only. See Bank Account types - `CurrencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EEK' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZMK' | 'ZWD' — 3 letter alpha code for the currency – see list of currency codes - `TaxType` string — The tax type from taxRates - `EnablePaymentsToAccount` boolean — Boolean – describes whether account can have payments applied to it - `ShowInExpenseClaims` boolean — Boolean – describes whether account code is available for use with expense claims - `Class` 'ASSET' | 'EQUITY' | 'EXPENSE' | 'LIABILITY' | 'REVENUE' — See Account Class Types - `SystemAccount` 'DEBTORS' | 'CREDITORS' | 'BANKCURRENCYGAIN' | 'GST' | 'GSTONIMPORTS' | 'HISTORICAL' | 'REALISEDCURRENCYGAIN' | 'RETAINEDEARNINGS' | 'ROUNDING' | 'TRACKINGTRANSFERS' | 'UNPAIDEXPCLM' | 'UNREALISEDCURRENCYGAIN' | 'WAGEPAYABLES' | 'CISASSETS' | 'CISASSET' | 'CISLABOUR' | 'CISLABOUREXPENSE' | 'CISLABOURINCOME' | 'CISLIABILITY' | 'CISMATERIALS' | '' — If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null. - `ReportingCode` string — Shown if set - `ReportingCodeName` string — Shown if set - `HasAttachments` boolean — boolean to indicate if an account has an attachment (read only) - `UpdatedDateUTC` string — Last modified date UTC format - `AddToWatchlist` boolean — Boolean – describes whether the account is shown in the watchlist widget on the dashboard - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message - `Amount` number, double, required — amount of the transaction - `Date` string — The date of the Transfer YYYY-MM-DD - `BankTransferID` string, uuid — The identifier of the Bank Transfer - `CurrencyRate` number, double — The currency rate - `FromBankTransactionID` string, uuid — The Bank Transaction ID for the source account - `ToBankTransactionID` string, uuid — The Bank Transaction ID for the destination account - `FromIsReconciled` boolean — The Bank Transaction boolean to show if it is reconciled for the source account - `ToIsReconciled` boolean — The Bank Transaction boolean to show if it is reconciled for the destination account - `Reference` string — Reference for the transactions. - `HasAttachments` boolean — Boolean to indicate if a Bank Transfer has an attachment - `CreatedDateUTC` string — UTC timestamp of creation date of bank transfer - `Status` 'AUTHORISED' | 'DELETED' — AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED. - `FromTracking` TrackingReference[] — Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account. - `TrackingCategoryID` string, uuid, required — The Xero identifier for a tracking category - `TrackingOptionID` string, uuid, required — The Xero identifier for a tracking category option - `Name` string — The name of the tracking category - `Option` string — See Tracking Options - `ToTracking` TrackingReference[] — Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account. - `TrackingCategoryID` string, uuid, required — The Xero identifier for a tracking category - `TrackingOptionID` string, uuid, required — The Xero identifier for a tracking category option - `Name` string — The name of the tracking category - `Option` string — See Tracking Options - `ValidationErrors` ValidationError[] — Displays array of validation error messages from the API - `Message` string — Validation error message --- [API](https://skmtc.net/xeroapi/apis/xero-accounting-api.md) · [All operations](https://skmtc.net/xeroapi/apis/xero-accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xeroapi/xero-accounting-api/versions/dc231cafd8de/schema)