Bank Feed Transactions
The BankFeedTransaction Object
A Rutter Bank Feed Transaction represents a bank transaction from a Financial Institution account that has been uploaded into an accounting platform for a specific Rutter Bank Feed Account. The bank transactions synced into an accounting platform enable reconciliation for an accountant.
Properties
id
stringRequiredThe Rutter generated unique ID of the bank feed transaction.
bank_feed_account_id
stringnullableRequiredThe Rutter generated unique ID of the linked bank feed.
transaction_id
stringnullableRequiredThe Financial Institution's ID for the transaction.
posted_at
stringnullableRequiredWhen the transaction was posted by the Financial Institution.
amount
numbernullableRequiredThe amount of the transaction.
description
stringnullableRequiredThe description of the transaction.
payee
stringnullableRequiredThe payee of the transaction.
platform_ingested
booleannullableRequiredIndicates whether the transaction has been ingested by the platform.
transaction_type
enumnullableRequiredThe type of the transaction.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the bank feed transaction was last synced by Rutter.
List Bank Feed Transactions
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_transactions
arrayRequiredbank_feed_transactions
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_transactions": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
11 "transaction_id": "ACRAF23DB3C4",
12 "posted_at": "2023-02-02T02:34:56.000Z",
13 "amount": 300,
14 "description": "Office supplies",
15 "payee": "Office Depot",
16 "platform_ingested": true,
17 "transaction_type": "debit",
18 "last_synced_at": "2023-01-02T02:34:56.000Z"
19 }
20 ],
21 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
22}
Fetch a Bank Feed Transaction
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_transaction
objectRequiredbank_feed_transaction
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_transaction": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
10 "transaction_id": "ACRAF23DB3C4",
11 "posted_at": "2023-02-02T02:34:56.000Z",
12 "amount": 300,
13 "description": "Office supplies",
14 "payee": "Office Depot",
15 "platform_ingested": true,
16 "transaction_type": "debit",
17 "last_synced_at": "2023-01-02T02:34:56.000Z"
18 }
19}
Create Bank Feed Transactions
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_feed_transactions
objectRequiredbank_feed_transactions
attributesResponse Body
bank_feed_transactions
arrayRequiredbank_feed_transactions
attributes- Netsuite
- Sage Intacct
- Sage Business Cloud
1{
2 "bank_feed_transactions": {
3 "bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
4 "transactions": [
5 {
6 "transaction_id": "ACRAF23DB3C4",
7 "posted_at": "2023-02-02T02:34:56.000Z",
8 "amount": 300,
9 "description": "Office supplies",
10 "transaction_type": "debit",
11 "payee": "Office Depot"
12 }
13 ]
14 }
15}
1{
2 "bank_feed_transactions": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "bank_feed_account_id": "00000000-0000-0000-0000-000000000000",
6 "transaction_id": "ACRAF23DB3C4",
7 "posted_at": "2023-02-02T02:34:56.000Z",
8 "amount": 300,
9 "description": "Office supplies",
10 "duplicate": false,
11 "payee": "Office Depot",
12 "platform_ingested": true,
13 "transaction_type": "debit",
14 "last_synced_at": "2023-01-02T02:34:56.000Z"
15 }
16 ]
17}
Have questions?
Contact support for personalized guidance.