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
stringRequiredThe Rutter generated unique ID of the bank feed.
account_id
stringnullableRequiredThe Rutter generated unique ID of the platform account.
internal_bank_account_id
stringnullableRequiredThe Financial Institution's ID for the bank account.
transaction_start_date
stringnullableRequiredThe start date of the bank feed connection's synced historical transactions.
bank_account_type
enumRequiredThe Financial Institution's bank account type.
feed_status
enumRequiredThe status of the bank feed connection.
bank_account_number
stringnullableRequiredThe Financial Institution's account number or credit card number.
currency_code
enumnullableRequiredThe ISO 4217 currency code of the bank feed.
name
stringnullableRequiredThe name of the bank account.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the bank feed account was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Bank Feed Accounts
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. Use the value of next_cursor
provided in a previous response.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe number of entities to return. Defaults to 50. Maximum is 500.
sort
stringqueryThe 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_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectRequiredconnection
attributesbank_feed_accounts
arrayRequiredbank_feed_accounts
attributesnext_cursor
stringnullable- Netsuite
- Sage Intacct
- Sage Business Cloud
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
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectRequiredconnection
attributesbank_feed_account
objectRequiredbank_feed_account
attributes- Netsuite
- Sage Intacct
- Sage Business Cloud
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
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_feed_account
objectRequiredbank_feed_account
attributesResponse Body
Any of:
bank_feed_account
objectRequiredbank_feed_account
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
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.