Bank Transfers

Overview

From the Bank Transfers endpoint, you can retrieve all Bank Transfers recorded in the accounting service providers for a specified business. See Bank Transfers endpoint for more details.

❗️

Bank Transfers

Railz supports Bank Transfers for Xero connections only.

Data Model

Field

Type

Description

id
sortable, filterable

string

Identifier for the bank transfer, unique to the business in the accounting service provider.

date
sortable, filterable

string
See Date

Date of the bank transfer as recorded in the accounting service provider.

currencyRef

Reference Types

Currency of the bank transfer.

Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency.

currencyRate

decimal

Rate between the currency of the bank transfer and the base currency of the business. Not applicable when multi-currency is not supported.

fromAccountRef

Reference Types

Reference to the account to which the bank transfer was sent from.

Pushing data requires a valid bank account reference. Query Accounts and use the id parameter of an account with isBankAccount=true as a value.

toAccountRef
sortable, filterable

Reference Types

Reference to the account to which the bank transfer was sent to.

Pushing data requires a valid bank account reference. Query Accounts and use the id parameter of an account with isBankAccount=true as a value.

fromBankTransactionId
filterable

string

The bank transaction id for the source account in the accounting service provider.

toBankTransactionId
filterable

string

The bank transaction id for the destination account in the accounting service provider.

totalAmount
sortable, filterable

decimal

Amount of the bank transfer.

memo

string

User-friendly reference for the bank transfer.

sourceModifiedData

string
See Date

Date the record was last changed in the accounting service provider.

Example Data

{
  "data":
  [
    {
      "id": "123",
      "date": "2021-03-09T10:18:29.985Z",
      "currencyRef":
      {
        "id": "CAD",
        "name": "Canadian Dollar"
      },
      "currencyRate": 1.13,
      "fromAccountRef":
      {
        "id": "1233455",
        "name": "Business Savings Account"
      },
      "toAccountRef":
      {
        "id": "327623",
        "name": "Business Bank Account"
      },
      "totalAmount": 1000.5,
      "fromBankTransactionId": "b11794bc",
      "toBankTransactionId": "b11794cd",
      "memo": "Reference to bank transfer.",
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z"
    }
  ]
}

Did this page help you?