XExeroapi
Accounting

Retrieves all bank transfers

Changed on
get/BankTransfers

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/BankTransfers
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: accounting.transactions, accounting.transactions.read

Query parameters

wherestring

Filter by an any element

orderstring

Order by an any element

includeDeletedboolean

e.g. includeDeleted=true - Bank transfers with a status of DELETED will be included in the response

Headers

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Response

Success - return response of BankTransfers array of 0 to N BankTransfer

Example response

{
  "BankTransfers": [
    {
      "FromBankAccount": {
        "Name": "Food Sales",
        "AccountID": "00000000-0000-0000-0000-000000000000",
        "UpdatedDateUTC": "/Date(1573755038314)/"
      },
      "ToBankAccount": {
        "Name": "Food Sales",
        "AccountID": "00000000-0000-0000-0000-000000000000",
        "UpdatedDateUTC": "/Date(1573755038314)/"
      },
      "CreatedDateUTC": "/Date(1573755038314)/"
    }
  ]
}

Changes

  • ab6641f4d82bRevision changes
    • info

      added the new optional query request parameter includeDeleted

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status