Bank Transfers

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. Supported for 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, SVC, 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 of the bank transfer.

memostringnullable

The memo of the bank transfer.

created_atstringfilterablenullable

The ISO 8601 timestamp that the bank transfer was created.

updated_atstringfilterablenullable

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

last_synced_atstringfilterable

The ISO 8601 timestamp when the bank transfer was last synced by Rutter.

platform_urlstringnullable

A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/bank_transfers
GET
/accounting/bank_transfers/:id
POST
/accounting/bank_transfers
PATCH
/accounting/bank_transfers/:id
DELETE
/accounting/bank_transfers/:id

List Bank Transfers

GEThttps://production.rutterapi.com/versioned/accounting/bank_transfers

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.

    Filterable fields: created_at, updated_at, last_synced_at.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Dynamics 365 Business Central. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

    Sortable fields: created_at, updated_at, last_synced_at.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • NetSuite
    NetSuite
  • Sage Intacct
    Sage Intacct
200
Example Response Body
JSON
1
{


2
  "bank_transfers": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "platform_id": "12345678",


6
      "class_id": "00000000-0000-0000-0000-000000000000",


7
      "credit_account_id": "00000000-0000-0000-0000-000000000000",


8
      "debit_account_id": "00000000-0000-0000-0000-000000000000",


9
      "department_id": "00000000-0000-0000-0000-000000000000",


10
      "location_id": "00000000-0000-0000-0000-000000000000",


11
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",


12
      "transaction_date": "2023-01-02T02:34:56.000Z",


13
      "currency_code": "USD",


14
      "total_amount": 123.45,


15
      "memo": "This is a memo.",


16
      "created_at": "2023-01-02T02:34:56.000Z",


17
      "updated_at": "2023-01-02T02:34:56.000Z",


18
      "last_synced_at": "2023-01-02T02:34:56.000Z",


19
      "platform_url": "https://platform.com/resource?id=123",


20
      "platform_data": {


21
        "id": 123,


22
        "data": "Varies by platform"


23
      }


24
    }


25
  ],


26
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


27
  "connection": {


28
    "id": "00000000-0000-0000-0000-000000000000",


29
    "orgId": "00000000-0000-0000-0000-000000000000",


30
    "platform": "NETSUITE"


31
  }


32
}

Fetch a Bank Transfer

GEThttps://production.rutterapi.com/versioned/accounting/bank_transfers/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • NetSuite
    NetSuite
  • Sage Intacct
    Sage Intacct
200
Example Response Body
JSON
1
{


2
  "bank_transfer": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "class_id": "00000000-0000-0000-0000-000000000000",


6
    "credit_account_id": "00000000-0000-0000-0000-000000000000",


7
    "debit_account_id": "00000000-0000-0000-0000-000000000000",


8
    "department_id": "00000000-0000-0000-0000-000000000000",


9
    "location_id": "00000000-0000-0000-0000-000000000000",


10
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


11
    "transaction_date": "2023-01-02T02:34:56.000Z",


12
    "currency_code": "USD",


13
    "total_amount": 123.45,


14
    "memo": "This is a memo.",


15
    "created_at": "2023-01-02T02:34:56.000Z",


16
    "updated_at": "2023-01-02T02:34:56.000Z",


17
    "last_synced_at": "2023-01-02T02:34:56.000Z",


18
    "platform_url": "https://platform.com/resource?id=123",


19
    "platform_data": {


20
      "id": 123,


21
      "data": "Varies by platform"


22
    }


23
  },


24
  "connection": {


25
    "id": "00000000-0000-0000-0000-000000000000",


26
    "orgId": "00000000-0000-0000-0000-000000000000",


27
    "platform": "NETSUITE"


28
  }


29
}

Create a Bank Transfer

POSThttps://production.rutterapi.com/versioned/accounting/bank_transfers

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    bank_transferobject
    Show bank_transfer attributes

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
Example Request Body
JSON
1
{


2
  "bank_transfer": {


3
    "class_id": "00000000-0000-0000-0000-000000000000",


4
    "credit_account_id": "00000000-0000-0000-0000-000000000000",


5
    "debit_account_id": "00000000-0000-0000-0000-000000000000",


6
    "department_id": "00000000-0000-0000-0000-000000000000",


7
    "location_id": "00000000-0000-0000-0000-000000000000",


8
    "transaction_date": "2023-01-02T02:34:56.000Z",


9
    "total_amount": 123.45,


10
    "memo": "This is a memo."


11
  }


12
}
200
Example Response Body
JSON
1
{


2
  "bank_transfer": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "class_id": "00000000-0000-0000-0000-000000000000",


6
    "credit_account_id": "00000000-0000-0000-0000-000000000000",


7
    "debit_account_id": "00000000-0000-0000-0000-000000000000",


8
    "department_id": "00000000-0000-0000-0000-000000000000",


9
    "location_id": "00000000-0000-0000-0000-000000000000",


10
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


11
    "transaction_date": "2023-01-02T02:34:56.000Z",


12
    "currency_code": "USD",


13
    "total_amount": 123.45,


14
    "memo": "This is a memo.",


15
    "created_at": "2023-01-02T02:34:56.000Z",


16
    "updated_at": "2023-01-02T02:34:56.000Z",


17
    "last_synced_at": "2023-01-02T02:34:56.000Z",


18
    "platform_url": "https://platform.com/resource?id=123",


19
    "platform_data": {


20
      "id": 123,


21
      "data": "Varies by platform"


22
    }


23
  }


24
}

Update a Bank Transfer

PATCHhttps://production.rutterapi.com/versioned/accounting/bank_transfers/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    bank_transferobject
    Show bank_transfer attributes

Response Body

Support by integration
  • QuickBooks
    QuickBooks
Example Request Body
JSON
1
{


2
  "bank_transfer": {


3
    "credit_account_id": "00000000-0000-0000-0000-000000000000",


4
    "debit_account_id": "00000000-0000-0000-0000-000000000000",


5
    "transaction_date": "2023-01-02T02:34:56.000Z",


6
    "total_amount": 123.45,


7
    "memo": "This is a memo."


8
  }


9
}
200
Example Response Body
JSON
1
{


2
  "bank_transfer": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "class_id": "00000000-0000-0000-0000-000000000000",


6
    "credit_account_id": "00000000-0000-0000-0000-000000000000",


7
    "debit_account_id": "00000000-0000-0000-0000-000000000000",


8
    "department_id": "00000000-0000-0000-0000-000000000000",


9
    "location_id": "00000000-0000-0000-0000-000000000000",


10
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


11
    "transaction_date": "2023-01-02T02:34:56.000Z",


12
    "currency_code": "USD",


13
    "total_amount": 123.45,


14
    "memo": "This is a memo.",


15
    "created_at": "2023-01-02T02:34:56.000Z",


16
    "updated_at": "2023-01-02T02:34:56.000Z",


17
    "last_synced_at": "2023-01-02T02:34:56.000Z",


18
    "platform_url": "https://platform.com/resource?id=123",


19
    "platform_data": {


20
      "id": 123,


21
      "data": "Varies by platform"


22
    }


23
  }


24
}

Delete a Bank Transfer

DELETEhttps://production.rutterapi.com/versioned/accounting/bank_transfers/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
200
Example Response Body
JSON
1
{


2
  "code": "deleted",


3
  "success": true


4
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Bank Transfer Attachments