Bank
Bank Transfers

GET /bankTransfers

Changed on

Gets the latest bank transfers for a business.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
Example:Railz

Unique business name identifier.

serviceName'xero' | 'sageBusinessCloud' | 'myob' | 'zohoBooks' required

Name of accounting service provider.

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
Example:100

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

orderBystring

Response

countinteger required

Example response

{
  "meta": {
    "reportId": [
      "5fad8a342a88364234392fb5",
      "5fad8a342a88364234392fb6"
    ],
    "serviceName": "xero",
    "businessName": "Railz",
    "startDate": "2020-11-25T01:02:03Z",
    "endDate": "2020-11-30T01:02:03Z",
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z"
  },
  "count": 1,
  "data": [
    {
      "id": "123",
      "date": "2021-03-09T10:18:29.985Z",
      "currencyRate": 1.13,
      "totalAmount": 1000.5,
      "fromAccountRef": {
        "id": "1233455",
        "name": "Business Savings Account"
      },
      "toAccountRef": {
        "id": "327623",
        "name": "Business Bank Account"
      },
      "fromBankTransactionId": "b11794bc",
      "toBankTransactionId": "b11794cd",
      "memo": "Reference to bank transfer.",
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z",
      "currencyRef": {
        "id": "CAD",
        "name": "Canadian Dollar",
        "symbol": "USD,CAD"
      }
    }
  ]
}

Changes

    • info

      api tag Bank added

    • warning

      added the new byod enum value to the / response property for the response status

    • warning

      added the new byod enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamics365Finance enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new freshbooks enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new myob enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new oracleNetsuite enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooks enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new sageIntacct enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new wave enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new xero enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum value to the / response property for the response status

    • warning

      added the new zohoBooks enum value to the / response property for the response status

    • info

      added the new enum value myob to the query request parameter serviceName

    • info

      added the new enum value sageBusinessCloud to the query request parameter serviceName

    • info

      added the new enum value zohoBooks to the query request parameter serviceName

    • info

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

    • info

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

    • info

      response property count deprecated

    • info

      response property count deprecated