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

idstring

The Rutter generated unique ID of the bank feed.

account_idstringnullable

The Rutter generated unique ID of the platform account.

internal_bank_account_idstringnullable

The Financial Institution's ID for the bank account.

parent_bank_feed_account_idstringnullable

The Rutter ID for the parent bank feed account.

last_statement_datestringnullable

Date of last statement.

next_payment_datestringnullable

Date of next payment.

transaction_start_datestringnullable

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

bank_account_typeenum

The Financial Institution's bank account type.

One ofbank, checking, credit_card, or savings.

feed_statusenum

The status of the bank feed connection.

One ofactive or inactive.

transaction_readyboolean

True if the bank feed account is ready to accept transactions.

available_balancenumbernullable

Balance of funds available for use.

available_creditnumbernullable

Available credit.

bank_account_numberstringnullable

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

credit_limitnumbernullable

Credit limit.

currency_codeenumnullable

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, ZMW, ETH, BTC, or null.

current_balancenumbernullable

Balance of funds in account.

finance_chargesnumbernullable

Finance charges.

last_statement_balancenumbernullable

Last statement balance.

line_of_businessstringnullable

The line of business, e,g. consumer, small business, corporate, etc.

minimum_payment_amountnumbernullable

Minimum payment amount.

namestringnullable

The name of the bank account.

next_payment_amountnumbernullable

Amount of next payment.

past_due_amountnumbernullable

Past due amount.

purchases_aprnumbernullable

Purchases APR.

routing_numberstringnullable

Routing transit number associated with account number at the Financial Institution.

last_synced_atstring

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

platform_dataobjectOptional

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

PATCH

/accounting/bank_feeds/accounts/:id

DELETE

/accounting/bank_feeds/accounts/:id

POST

/accounting/bank_feeds/accounts/mapping_link

List Bank Feed Accounts

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

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: 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 Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

Sortable fields: 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

200

Example Response Body

JSON

1{
2  "bank_feed_accounts": [
3    {
4      "id": "00000000-0000-0000-0000-000000000000",
5      "account_id": "00000000-0000-0000-0000-000000000000",
6      "internal_bank_account_id": "0674101002388",
7      "parent_bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
8      "last_statement_date": null,
9      "next_payment_date": null,
10      "transaction_start_date": "2023-02-02T00:00:00.000Z",
11      "bank_account_type": "bank",
12      "feed_status": "active",
13      "transaction_ready": true,
14      "available_balance": 1546.23,
15      "available_credit": null,
16      "bank_account_number": "182237382",
17      "credit_limit": null,
18      "currency_code": "USD",
19      "current_balance": 1833.21,
20      "finance_charges": null,
21      "last_statement_balance": null,
22      "line_of_business": "small business",
23      "minimum_payment_amount": null,
24      "name": "Regan's Bank Account",
25      "next_payment_amount": null,
26      "past_due_amount": null,
27      "purchases_apr": null,
28      "routing_number": "123456789",
29      "last_synced_at": "2023-01-02T02:34:56.000Z",
30      "platform_data": {
31        "id": 123,
32        "data": "Varies by platform"
33      }
34    }
35  ],
36  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
37  "connection": {
38    "id": "00000000-0000-0000-0000-000000000000",
39    "orgId": "00000000-0000-0000-0000-000000000000",
40    "platform": "NETSUITE"
41  }
42}

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_fetchenumqueryOptional

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

One oftrue or false.

Response Body

200

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    "parent_bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
7    "last_statement_date": null,
8    "next_payment_date": null,
9    "transaction_start_date": "2023-02-02T00:00:00.000Z",
10    "bank_account_type": "bank",
11    "feed_status": "active",
12    "transaction_ready": true,
13    "available_balance": 1546.23,
14    "available_credit": null,
15    "bank_account_number": "182237382",
16    "credit_limit": null,
17    "currency_code": "USD",
18    "current_balance": 1833.21,
19    "finance_charges": null,
20    "last_statement_balance": null,
21    "line_of_business": "small business",
22    "minimum_payment_amount": null,
23    "name": "Regan's Bank Account",
24    "next_payment_amount": null,
25    "past_due_amount": null,
26    "purchases_apr": null,
27    "routing_number": "123456789",
28    "last_synced_at": "2023-01-02T02:34:56.000Z",
29    "platform_data": {
30      "id": 123,
31      "data": "Varies by platform"
32    }
33  },
34  "connection": {
35    "id": "00000000-0000-0000-0000-000000000000",
36    "orgId": "00000000-0000-0000-0000-000000000000",
37    "platform": "NETSUITE"
38  }
39}

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

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_feed_accountobject

Show bank_feed_account attributes

Response Body

Example Request Body

JSON

1{
2  "bank_feed_account": {
3    "account_id": "00000000-0000-0000-0000-000000000000",
4    "internal_bank_account_id": "0674101002388",
5    "parent_bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
6    "transaction_start_date": "2023-02-02T00:00:00.000Z",
7    "bank_account_type": "bank",
8    "currency_code": "USD",
9    "name": "Regan's Bank Account",
10    "available_balance": 1546.23,
11    "bank_account_number": "182237382",
12    "current_balance": 1833.21,
13    "line_of_business": "small business",
14    "routing_number": "123456789",
15    "additional_fields": {
16      "override_existing": true
17    }
18  }
19}

200

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    "parent_bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
7    "last_statement_date": null,
8    "next_payment_date": null,
9    "transaction_start_date": "2023-02-02T00:00:00.000Z",
10    "bank_account_type": "bank",
11    "feed_status": "active",
12    "transaction_ready": true,
13    "available_balance": 1546.23,
14    "available_credit": null,
15    "bank_account_number": "182237382",
16    "credit_limit": null,
17    "currency_code": "USD",
18    "current_balance": 1833.21,
19    "finance_charges": null,
20    "last_statement_balance": null,
21    "line_of_business": "small business",
22    "minimum_payment_amount": null,
23    "name": "Regan's Bank Account",
24    "next_payment_amount": null,
25    "past_due_amount": null,
26    "purchases_apr": null,
27    "routing_number": "123456789",
28    "last_synced_at": "2023-01-02T02:34:56.000Z",
29    "platform_data": {
30      "id": 123,
31      "data": "Varies by platform"
32    }
33  }
34}

Update a Bank Feed Account

PATCHhttps://production.rutterapi.com/versioned/accounting/bank_feeds/accounts/:id

Request Parameters

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

One ofasync or prefer_sync.

bank_feed_accountobject

Show bank_feed_account attributes

Response Body

Example Request Body

JSON

1{
2  "bank_feed_account": {
3    "status": "inactive"
4  }
5}

200

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    "parent_bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
7    "last_statement_date": null,
8    "next_payment_date": null,
9    "transaction_start_date": "2023-02-02T00:00:00.000Z",
10    "bank_account_type": "bank",
11    "feed_status": "active",
12    "transaction_ready": true,
13    "available_balance": 1546.23,
14    "available_credit": null,
15    "bank_account_number": "182237382",
16    "credit_limit": null,
17    "currency_code": "USD",
18    "current_balance": 1833.21,
19    "finance_charges": null,
20    "last_statement_balance": null,
21    "line_of_business": "small business",
22    "minimum_payment_amount": null,
23    "name": "Regan's Bank Account",
24    "next_payment_amount": null,
25    "past_due_amount": null,
26    "purchases_apr": null,
27    "routing_number": "123456789",
28    "last_synced_at": "2023-01-02T02:34:56.000Z",
29    "platform_data": {
30      "id": 123,
31      "data": "Varies by platform"
32    }
33  }
34}

Delete a Bank Feed Account

DELETEhttps://production.rutterapi.com/versioned/accounting/bank_feeds/accounts/:id

Request Parameters

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

One ofasync or prefer_sync.

Response Body

200

Example Response Body

JSON

1{
2  "code": "deleted",
3  "success": true
4}

Generate Link for Bank Feed Account Mapping UI

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

This endpoint returns a link providing the end user with an interface to link bank accounts to their G/L accounts. This functionality is only required for NetSuite and Xero, and should be used after a connection is established through the main Rutter Link flow and an Initial Sync is completed.

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

Response Body

Example Request Body

JSON

1{}

200

Example Response Body

JSON

1{
2  "bank_feed_account_mapping_link": {
3    "expires_at": "2023-01-10T00:00:00.000Z",
4    "url": "https://link.rutterapi.com/bank_feeds_link?token=00000000-0000-0000-0000-000000000000"
5  }
6}

Have questions?

Contact support for personalized guidance.

Contact support