latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Bank Transactions (Accounting)

List Bank Transactions

Supported for:

xero myob zohoBooks

get/v2/accounting/bankTransactions

Query parameters

connectionUuidstring required

Unique connection identifier.

startDatestring

The start date of the Transaction report frequency in the format: YYYY-MM-DD.

endDatestring

The end date of the Transaction report frequency in the format: YYYY-MM-DD.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber

This is the size of the results set you would like (default: 100).

orderBystring

Response

Example response

{
  "meta": {
    "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
    "businessName": "Railz",
    "serviceName": "xero",
    "reportId": [
      "5fad8a342a88364234392fb5",
      "5fad8a342a88364234392fb6"
    ],
    "startDate": "2020-11-25T01:02:03Z",
    "endDate": "2020-11-30T01:02:03Z",
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z"
  },
  "data": [
    {
      "id": "25",
      "postedDate": "2020-11-30T01:02:03Z",
      "transactionType": "payment",
      "bankAccountRef": {
        "id": "145",
        "name": "Example account"
      },
      "currency": "CAD",
      "currencyRate": 1.13,
      "totalAmount": 322,
      "lines": {
        "id": "8a3fdcc9-83eb-4fdd-83e0-52ec1b40b072",
        "description": "Railz store",
        "taxRateRef": {
          "id": "12"
        },
        "taxAmount": 20.5,
        "amount": 322,
        "accountRef": {
          "id": "145",
          "name": "Example account"
        },
        "trackingCategoryRefs": [
          {
            "id": "4040",
            "name": "Region",
            "type": "class"
          }
        ]
      },
      "memo": "Example memo.",
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z",
      "entityRef": {
        "type": "customer",
        "id": "130",
        "name": "ABC Inc"
      },
      "transactionDirection": "incoming"
    }
  ]
}