Accounting

Bank Transfers
Get API Keys

The BankTransfer object

Currently, there's only support between accounts of the same currency.

Properties

idstring

The Rutter generated unique ID of the bank transfer.

platform_idstring

The platform specific ID of the bank transfer.

class_idstringnullable

The Rutter ID of the Class linked to the bank transfer line item.

credit_account_idstringnullable

The Rutter ID of the Account linked to the bank transfer. Represents the asset account being credited.

debit_account_idstringnullable

The Rutter ID of the Account linked to the bank transfer. Represents the asset account being debit.

department_idstringnullable

The Rutter ID of the Department linked to the bank transfer line item.

location_idstringnullable

The Rutter ID of the Location linked to the bank transfer line item.

subsidiary_idstringnullable

The Rutter ID of the Subsidiary linked to the bank transfer. This feature is currently only supported on NetSuite.

transaction_datestring

The ISO 8601 timestamp for the transaction date of the bank transfer.

currency_codeenum

The ISO 4217 currency code of the bank transfer.

One ofAED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, 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, 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, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, or ZMW.
total_amountnumber

The total amount on the bank transfer.

memostringnullable

Memo or description of the bank transfer

created_atstringnullable

The ISO 8601 timestamp that the bank transfer was created.

updated_atstringnullable

The ISO 8601 timestamp that the bank transfer was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example BankTransfer Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "class_id": "00000000-0000-0000-0000-000000000000",
  "credit_account_id": "00000000-0000-0000-0000-000000000000",
  "debit_account_id": "00000000-0000-0000-0000-000000000000",
  "department_id": "00000000-0000-0000-0000-000000000000",
  "location_id": "00000000-0000-0000-0000-000000000000",
  "subsidiary_id": "00000000-0000-0000-0000-000000000000",
  "transaction_date": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "total_amount": 123.45,
  "memo": "This is a memo.",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Bank Transfers

GET /accounting/bank_transfers
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    connectionobject
    Show connection attributes
    bank_transfersarray
    Show bank_transfers attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bank_transfers": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "class_id": "00000000-0000-0000-0000-000000000000",
      "credit_account_id": "00000000-0000-0000-0000-000000000000",
      "debit_account_id": "00000000-0000-0000-0000-000000000000",
      "department_id": "00000000-0000-0000-0000-000000000000",
      "location_id": "00000000-0000-0000-0000-000000000000",
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",
      "transaction_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "total_amount": 123.45,
      "memo": "This is a memo.",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Bank Transfer

GET /accounting/bank_transfers/:id
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    bank_transferobject
    Show bank_transfer attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bank_transfer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "class_id": "00000000-0000-0000-0000-000000000000",
    "credit_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "location_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "total_amount": 123.45,
    "memo": "This is a memo.",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Create a Bank Transfer

POST /accounting/bank_transfers
Supported for: QuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    bank_transferobject
    Show bank_transfer attributes

Response Body

    Any of:

    bank_transferobject
    Show bank_transfer attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "bank_transfer": {
    "class_id": "00000000-0000-0000-0000-000000000000",
    "credit_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "location_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "total_amount": 123.45,
    "memo": "This is a memo."
  }
}
Example Response Body
{
  "bank_transfer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "class_id": "00000000-0000-0000-0000-000000000000",
    "credit_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "location_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "total_amount": 123.45,
    "memo": "This is a memo.",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}
Next
Expenses