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.
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.
bank_account_number
stringnullableThe Financial Institution's account number or credit card number.
currency_code
enumnullableThe ISO 4217 currency code of the bank feed.
name
stringnullableThe name of the bank account.
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
stringqueryOptionalUsed to specify criteria to filter out the objects returned. Supports all filterable
fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
sort
stringqueryOptionalUsed to sort the returned objects, e.g. last_synced_at ASC
. Supports all filterable
fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at
and last_synced_at
fields are supported. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
.
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
- 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 "transaction_start_date": "2023-02-02T00:00:00.000Z",
8 "bank_account_type": "bank",
9 "feed_status": "active",
10 "bank_account_number": "182237382",
11 "currency_code": "USD",
12 "name": "Regan's Bank Account",
13 "last_synced_at": "2023-01-02T02:34:56.000Z",
14 "platform_data": {
15 "id": 123,
16 "data": "Varies by platform"
17 }
18 }
19 ],
20 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
21 "connection": {
22 "id": "00000000-0000-0000-0000-000000000000",
23 "orgId": "00000000-0000-0000-0000-000000000000",
24 "platform": "NETSUITE"
25 }
26}
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
- 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 "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 "connection": {
19 "id": "00000000-0000-0000-0000-000000000000",
20 "orgId": "00000000-0000-0000-0000-000000000000",
21 "platform": "NETSUITE"
22 }
23}
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
attributeserrors
arrayOptionalerrors
attributes- NetSuite
- Sage Intacct
- Sage Business Cloud
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}
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.