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
id
stringThe Rutter generated unique ID of the bank feed.
account_id
stringnullableThe Rutter generated unique ID of the platform account.
internal_bank_account_id
stringnullableThe Financial Institution's ID for the bank account.
parent_bank_feed_account_id
stringnullableThe Rutter ID for the parent bank feed account.
last_statement_date
stringnullableDate of last statement.
next_payment_date
stringnullableDate of next payment.
transaction_start_date
stringnullableThe start date of the bank feed connection's synced historical transactions.
bank_account_type
enumThe Financial Institution's bank account type.
feed_status
enumThe status of the bank feed connection.
available_balance
numbernullableBalance of funds available for use.
available_credit
numbernullableAvailable credit.
bank_account_number
stringnullableThe Financial Institution's account number or credit card number.
credit_limit
numbernullableCredit limit.
currency_code
enumnullableThe ISO 4217 currency code of the bank feed.
current_balance
numbernullableBalance of funds in account.
finance_charges
numbernullableFinance charges.
last_statement_balance
numbernullableLast statement balance.
line_of_business
stringnullableThe line of business, e,g. consumer, small business, corporate, etc.
minimum_payment_amount
numbernullableMinimum payment amount.
name
stringnullableThe name of the bank account.
next_payment_amount
numbernullableAmount of next payment.
past_due_amount
numbernullablePast due amount.
purchases_apr
numbernullablePurchases APR.
routing_number
stringnullableRouting transit number associated with account number at the Financial Institution.
last_synced_at
stringThe ISO 8601 timestamp when the bank feed account was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Bank Feed Accounts
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalNot yet supported on Sage Intacct or Dynamics 365 Business Central yet. 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.
sort
stringqueryOptionalUsed 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
and last_synced_at
fields are supported.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - 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_max
integerqueryOptionalDeprecated - 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_min
integerqueryOptionalDeprecated - 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_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
bank_feed_accounts
arraybank_feed_accounts
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- NetSuite
- Sage Intacct
- Intuit Bank Feeds
- Sage Business Cloud
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 "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 ],
35 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
36 "connection": {
37 "id": "00000000-0000-0000-0000-000000000000",
38 "orgId": "00000000-0000-0000-0000-000000000000",
39 "platform": "NETSUITE"
40 }
41}
Fetch a Bank Feed Account
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
bank_feed_account
objectbank_feed_account
attributesconnection
objectconnection
attributes- NetSuite
- Sage Intacct
- Intuit Bank Feeds
- Sage Business Cloud
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 "available_balance": 1546.23,
13 "available_credit": null,
14 "bank_account_number": "182237382",
15 "credit_limit": null,
16 "currency_code": "USD",
17 "current_balance": 1833.21,
18 "finance_charges": null,
19 "last_statement_balance": null,
20 "line_of_business": "small business",
21 "minimum_payment_amount": null,
22 "name": "Regan's Bank Account",
23 "next_payment_amount": null,
24 "past_due_amount": null,
25 "purchases_apr": null,
26 "routing_number": "123456789",
27 "last_synced_at": "2023-01-02T02:34:56.000Z",
28 "platform_data": {
29 "id": 123,
30 "data": "Varies by platform"
31 }
32 },
33 "connection": {
34 "id": "00000000-0000-0000-0000-000000000000",
35 "orgId": "00000000-0000-0000-0000-000000000000",
36 "platform": "NETSUITE"
37 }
38}
Create a Bank Feed Account
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_feed_account
objectbank_feed_account
attributesResponse Body
Any of:
bank_feed_account
objectbank_feed_account
attributesasync_response
objectOptionalasync_response
attributes- NetSuite
- Sage Intacct
- Intuit Bank Feeds
- Sage Business Cloud
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}
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 "available_balance": 1546.23,
13 "available_credit": null,
14 "bank_account_number": "182237382",
15 "credit_limit": null,
16 "currency_code": "USD",
17 "current_balance": 1833.21,
18 "finance_charges": null,
19 "last_statement_balance": null,
20 "line_of_business": "small business",
21 "minimum_payment_amount": null,
22 "name": "Regan's Bank Account",
23 "next_payment_amount": null,
24 "past_due_amount": null,
25 "purchases_apr": null,
26 "routing_number": "123456789",
27 "last_synced_at": "2023-01-02T02:34:56.000Z",
28 "platform_data": {
29 "id": 123,
30 "data": "Varies by platform"
31 }
32 }
33}
Update a Bank Feed Account
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_feed_account
objectbank_feed_account
attributesResponse Body
Any of:
bank_feed_account
objectbank_feed_account
attributesasync_response
objectOptionalasync_response
attributes- NetSuite
1{
2 "bank_feed_account": {
3 "status": "inactive"
4 }
5}
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 "available_balance": 1546.23,
13 "available_credit": null,
14 "bank_account_number": "182237382",
15 "credit_limit": null,
16 "currency_code": "USD",
17 "current_balance": 1833.21,
18 "finance_charges": null,
19 "last_statement_balance": null,
20 "line_of_business": "small business",
21 "minimum_payment_amount": null,
22 "name": "Regan's Bank Account",
23 "next_payment_amount": null,
24 "past_due_amount": null,
25 "purchases_apr": null,
26 "routing_number": "123456789",
27 "last_synced_at": "2023-01-02T02:34:56.000Z",
28 "platform_data": {
29 "id": 123,
30 "data": "Varies by platform"
31 }
32 }
33}
Have questions?
Contact support for personalized guidance.