Bank Feed Accounts

The BankFeedAccount Object

A Rutter Bank Feed Account represents a Financial Institution account that can have a connection, or a "bank feed", set up with an account within an accounting platform. A feed connection allows Financial Institution bank data to be imported into an accounting system for the account that is connected. This bank data can be used to reconcile transactions in the platform.

Properties

idstringRequired

The Rutter generated unique ID of the bank feed.

account_idstringnullableRequired

The Rutter generated unique ID of the platform account.

internal_bank_account_idstringnullableRequired

The Financial Institution's ID for the bank account.

transaction_start_datestringnullableRequired

The start date of the bank feed connection's synced historical transactions.

bank_account_typeenumRequired

The Financial Institution's bank account type.

One ofbank or credit_card.

feed_statusenumRequired

The status of the bank feed connection.

One ofactive or inactive.

bank_account_numberstringnullableRequired

The Financial Institution's account number or credit card number.

currency_codeenumnullableRequired

The ISO 4217 currency code of the bank feed.

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.

namestringnullableRequired

The name of the bank account.

last_synced_atstringRequired

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

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/bank_feeds/accounts

GET

/accounting/bank_feeds/accounts/:id

POST

/accounting/bank_feeds/accounts

List Bank Feed Accounts

GEThttps://production.rutterapi.com/versioned/accounting/bank_feeds/accounts

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringquery

The cursor to use for pagination. Use the value of next_cursor provided in a previous response.

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 number of entities to return. Defaults to 50. Maximum is 500.

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_feed_accountsarrayRequired

Show bank_feed_accounts attributes

next_cursorstringnullable

Support by integration

Netsuite
Sage Intacct
Sage Business Cloud

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_feed_accounts": [
8    {
9      "id": "00000000-0000-0000-0000-000000000000",
10      "account_id": "00000000-0000-0000-0000-000000000000",
11      "internal_bank_account_id": "0674101002388",
12      "transaction_start_date": "2023-02-02T00:00:00.000Z",
13      "bank_account_type": "bank",
14      "feed_status": "active",
15      "bank_account_number": "182237382",
16      "currency_code": "USD",
17      "name": "Regan's Bank Account",
18      "last_synced_at": "2023-01-02T02:34:56.000Z",
19      "platform_data": {
20        "id": 123,
21        "data": "Varies by platform"
22      }
23    }
24  ],
25  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
26}

Fetch a Bank Feed Account

GEThttps://production.rutterapi.com/versioned/accounting/bank_feeds/accounts/: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.

Response Body

connectionobjectRequired

Show connection attributes

bank_feed_accountobjectRequired

Show bank_feed_account attributes

Support by integration

Netsuite
Sage Intacct
Sage Business Cloud

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_feed_account": {
8    "id": "00000000-0000-0000-0000-000000000000",
9    "account_id": "00000000-0000-0000-0000-000000000000",
10    "internal_bank_account_id": "0674101002388",
11    "transaction_start_date": "2023-02-02T00:00:00.000Z",
12    "bank_account_type": "bank",
13    "feed_status": "active",
14    "bank_account_number": "182237382",
15    "currency_code": "USD",
16    "name": "Regan's Bank Account",
17    "last_synced_at": "2023-01-02T02:34:56.000Z",
18    "platform_data": {
19      "id": 123,
20      "data": "Varies by platform"
21    }
22  }
23}

Create a Bank Feed Account

POSThttps://production.rutterapi.com/versioned/accounting/bank_feeds/accounts

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

bank_feed_accountobjectRequired

Show bank_feed_account attributes

Response Body

Any of:

bank_feed_accountobjectRequired

Show bank_feed_account attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

Netsuite
Sage Intacct
Sage Business Cloud

Example Request Body

JSON

1{
2  "bank_feed_account": {
3    "account_id": "00000000-0000-0000-0000-000000000000",
4    "internal_bank_account_id": "0674101002388",
5    "transaction_start_date": "2023-02-02T00:00:00.000Z",
6    "bank_account_type": "bank",
7    "currency_code": "USD",
8    "name": "Regan's Bank Account",
9    "bank_account_number": "182237382"
10  }
11}

Example Response Body

JSON

1{
2  "bank_feed_account": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "account_id": "00000000-0000-0000-0000-000000000000",
5    "internal_bank_account_id": "0674101002388",
6    "transaction_start_date": "2023-02-02T00:00:00.000Z",
7    "bank_account_type": "bank",
8    "feed_status": "active",
9    "bank_account_number": "182237382",
10    "currency_code": "USD",
11    "name": "Regan's Bank Account",
12    "last_synced_at": "2023-01-02T02:34:56.000Z",
13    "platform_data": {
14      "id": 123,
15      "data": "Varies by platform"
16    }
17  }
18}

Have questions?

Contact support for personalized guidance.

Contact support