Bank Transfers

The BankTransfer Object

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

Properties

idstringRequired

The Rutter generated unique ID of the bank transfer.

platform_idstringRequired

The platform specific ID of the bank transfer.

class_idstringnullableRequired

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

credit_account_idstringnullableRequired

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

debit_account_idstringnullableRequired

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

department_idstringnullableRequired

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

location_idstringnullableRequired

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

subsidiary_idstringnullableRequired

The Rutter ID of the Subsidiary linked to the bank transfer. Supported for NetSuite.

transaction_datestringRequired

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

currency_codeenumRequired

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_amountnumberRequired

The total amount of the bank transfer.

memostringnullableRequired

The memo of the bank transfer.

created_atstringnullableRequired

The ISO 8601 timestamp that the bank transfer was created.

updated_atstringnullableRequired

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

last_synced_atstringRequired

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

platform_dataobject

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

List Bank Transfers

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringquery

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

expandenumquery

Used to request inclusion of optional objects.

Can beplatform_data.

force_fetchenumquery

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

One oftrue or false.

last_synced_at_minintegerquery

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

limitintegerquery

The limit on the number of entities returned.

sortstringquery

The field and direction to sort by (ASC or DESC), e.g. last_synced_at ASC. Currently supports the fields: updated_at, last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults, to updated_at DESC.

updated_at_maxintegerquery

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

updated_at_minintegerquery

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

Response Body

connectionobjectRequired

Show connection attributes

bank_transfersarrayRequired

Show bank_transfers attributes

next_cursorstringnullable

Support by integration

QuickBooks
Netsuite
Xero

Example Response Body

JSON

1{
2  "connection": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "orgId": "00000000-0000-0000-0000-000000000000",
5    "platform": "NETSUITE"
6  },
7  "bank_transfers": [
8    {
9      "id": "00000000-0000-0000-0000-000000000000",
10      "platform_id": "12345678",
11      "class_id": "00000000-0000-0000-0000-000000000000",
12      "credit_account_id": "00000000-0000-0000-0000-000000000000",
13      "debit_account_id": "00000000-0000-0000-0000-000000000000",
14      "department_id": "00000000-0000-0000-0000-000000000000",
15      "location_id": "00000000-0000-0000-0000-000000000000",
16      "subsidiary_id": "00000000-0000-0000-0000-000000000000",
17      "transaction_date": "2023-01-02T02:34:56.000Z",
18      "currency_code": "USD",
19      "total_amount": 123.45,
20      "memo": "This is a memo.",
21      "created_at": "2023-01-02T02:34:56.000Z",
22      "updated_at": "2023-01-02T02:34:56.000Z",
23      "last_synced_at": "2023-01-02T02:34:56.000Z",
24      "platform_data": {
25        "id": 123,
26        "data": "Varies by platform"
27      }
28    }
29  ],
30  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
31}

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.

force_fetchenumquery

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

One oftrue or false.

id_typeenumquery

Optionally, search for a connection by Rutter ID or platform ID. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

One ofrutter or platform.

Response Body

connectionobjectRequired

Show connection attributes

bank_transferobjectRequired

Show bank_transfer attributes

Support by integration

QuickBooks
Netsuite
Xero

Example Response Body

JSON

1{
2  "connection": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "orgId": "00000000-0000-0000-0000-000000000000",
5    "platform": "NETSUITE"
6  },
7  "bank_transfer": {
8    "id": "00000000-0000-0000-0000-000000000000",
9    "platform_id": "12345678",
10    "class_id": "00000000-0000-0000-0000-000000000000",
11    "credit_account_id": "00000000-0000-0000-0000-000000000000",
12    "debit_account_id": "00000000-0000-0000-0000-000000000000",
13    "department_id": "00000000-0000-0000-0000-000000000000",
14    "location_id": "00000000-0000-0000-0000-000000000000",
15    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
16    "transaction_date": "2023-01-02T02:34:56.000Z",
17    "currency_code": "USD",
18    "total_amount": 123.45,
19    "memo": "This is a memo.",
20    "created_at": "2023-01-02T02:34:56.000Z",
21    "updated_at": "2023-01-02T02:34:56.000Z",
22    "last_synced_at": "2023-01-02T02:34:56.000Z",
23    "platform_data": {
24      "id": 123,
25      "data": "Varies by platform"
26    }
27  }
28}

Create a Bank Transfer

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

bank_transferobjectRequired

Show bank_transfer attributes

Response Body

Any of:

bank_transferobjectRequired

Show bank_transfer attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

QuickBooks
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}

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_data": {
19      "id": 123,
20      "data": "Varies by platform"
21    }
22  }
23}

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

bank_transferobjectRequired

Show bank_transfer attributes

Response Body

Any of:

bank_transferobjectRequired

Show bank_transfer attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

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}

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_data": {
19      "id": 123,
20      "data": "Varies by platform"
21    }
22  }
23}

Have questions?

Contact support for personalized guidance.

Contact support