Bank Transactions
The BankTransaction Object
Properties
id
stringThe Rutter generated unique ID of the bank transaction.
platform_id
stringThe platform specific ID of the bank transaction.
account_id
stringnullableThe Rutter ID of the Bank Account linked to the bank transaction.
amount
numbernullableThe amount of the bank transaction.
currency_code
enumnullableThe ISO 4217 currency code of the bank transaction.
date
stringnullableThe ISO 8601 timestamp for when the bank transaction occurred.
merchant_name
stringnullableThe name of the merchant associated with the bank transaction.
status
enumOptionalThe status of the bank transaction.
category
arrayAn array of categories linked to the bank transaction. These values are not standardized and vary depending on the source data.
String array.
last_synced_at
stringThe ISO 8601 timestamp when the bank transaction was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Bank Transactions
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.
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
. Currently supports the updated_at
and last_synced_at
fields.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalUsed 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
integerqueryOptionalUsed 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
integerqueryOptionalUsed 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
1{
2 "bank_transactions": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "account_id": "00000000-0000-0000-0000-000000000000",
7 "amount": 100,
8 "currency_code": "USD",
9 "date": "2023-01-02",
10 "merchant_name": "Merchant Name",
11 "status": "posted",
12 "category": [
13 "category1",
14 "category2"
15 ],
16 "last_synced_at": "2023-01-02T02:34:56.000Z",
17 "platform_data": {
18 "id": 123,
19 "data": "Varies by platform"
20 }
21 }
22 ],
23 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
24 "connection": {
25 "id": "00000000-0000-0000-0000-000000000000",
26 "orgId": "00000000-0000-0000-0000-000000000000",
27 "platform": "NETSUITE"
28 }
29}
Support by integration
Expand to view platform rules- Plaid
Fetch a Bank Transaction
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not currently supported on Sage Intacct or Sage Business Cloud.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
1{
2 "bank_transaction": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_id": "00000000-0000-0000-0000-000000000000",
6 "amount": 100,
7 "currency_code": "USD",
8 "date": "2023-01-02",
9 "merchant_name": "Merchant Name",
10 "status": "posted",
11 "category": [
12 "category1",
13 "category2"
14 ],
15 "last_synced_at": "2023-01-02T02:34:56.000Z",
16 "platform_data": {
17 "id": 123,
18 "data": "Varies by platform"
19 }
20 },
21 "connection": {
22 "id": "00000000-0000-0000-0000-000000000000",
23 "orgId": "00000000-0000-0000-0000-000000000000",
24 "platform": "NETSUITE"
25 }
26}
Support by integration
Expand to view platform rules- Plaid
Have questions?
Contact support for personalized guidance.