Bank Transfers
The BankTransfer Object
Currently, there's only support between accounts of the same currency.
Properties
id
stringRequiredThe Rutter generated unique ID of the bank transfer.
platform_id
stringRequiredThe platform specific ID of the bank transfer.
class_id
stringnullableRequiredThe Rutter ID of the Class linked to the bank transfer line item.
credit_account_id
stringnullableRequiredThe Rutter ID of the Account linked to the bank transfer. Represents the asset account being credited.
debit_account_id
stringnullableRequiredThe Rutter ID of the Account linked to the bank transfer. Represents the asset account being debit.
department_id
stringnullableRequiredThe Rutter ID of the Department linked to the bank transfer line item.
location_id
stringnullableRequiredThe Rutter ID of the Location linked to the bank transfer line item.
subsidiary_id
stringnullableRequiredThe Rutter ID of the Subsidiary linked to the bank transfer. Supported for NetSuite.
transaction_date
stringRequiredThe ISO 8601 timestamp for the transaction date of the bank transfer.
currency_code
enumRequiredThe ISO 4217 currency code of the bank transfer.
total_amount
numberRequiredThe total amount of the bank transfer.
memo
stringnullableRequiredThe memo of the bank transfer.
created_at
stringnullableRequiredThe ISO 8601 timestamp that the bank transfer was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the bank transfer was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the bank transfer was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Bank Transfers
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_transfers
arrayRequiredbank_transfers
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
- Xero
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "bank_transfers": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "class_id": "00000000-0000-0000-0000-000000000000",
12 "credit_account_id": "00000000-0000-0000-0000-000000000000",
13 "debit_account_id": "00000000-0000-0000-0000-000000000000",
14 "department_id": "00000000-0000-0000-0000-000000000000",
15 "location_id": "00000000-0000-0000-0000-000000000000",
16 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
17 "transaction_date": "2023-01-02T02:34:56.000Z",
18 "currency_code": "USD",
19 "total_amount": 123.45,
20 "memo": "This is a memo.",
21 "created_at": "2023-01-02T02:34:56.000Z",
22 "updated_at": "2023-01-02T02:34:56.000Z",
23 "last_synced_at": "2023-01-02T02:34:56.000Z",
24 "platform_data": {
25 "id": 123,
26 "data": "Varies by platform"
27 }
28 }
29 ],
30 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
31}
Fetch a Bank Transfer
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.
id_type
enumqueryOptionally, search for a connection by Rutter ID or platform ID. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
Response Body
connection
objectRequiredconnection
attributesbank_transfer
objectRequiredbank_transfer
attributes- QuickBooks
- Netsuite
- Xero
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "bank_transfer": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "class_id": "00000000-0000-0000-0000-000000000000",
11 "credit_account_id": "00000000-0000-0000-0000-000000000000",
12 "debit_account_id": "00000000-0000-0000-0000-000000000000",
13 "department_id": "00000000-0000-0000-0000-000000000000",
14 "location_id": "00000000-0000-0000-0000-000000000000",
15 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
16 "transaction_date": "2023-01-02T02:34:56.000Z",
17 "currency_code": "USD",
18 "total_amount": 123.45,
19 "memo": "This is a memo.",
20 "created_at": "2023-01-02T02:34:56.000Z",
21 "updated_at": "2023-01-02T02:34:56.000Z",
22 "last_synced_at": "2023-01-02T02:34:56.000Z",
23 "platform_data": {
24 "id": 123,
25 "data": "Varies by platform"
26 }
27 }
28}
Create a Bank Transfer
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_transfer
objectRequiredbank_transfer
attributesResponse Body
Any of:
bank_transfer
objectRequiredbank_transfer
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Xero
1{
2 "bank_transfer": {
3 "class_id": "00000000-0000-0000-0000-000000000000",
4 "credit_account_id": "00000000-0000-0000-0000-000000000000",
5 "debit_account_id": "00000000-0000-0000-0000-000000000000",
6 "department_id": "00000000-0000-0000-0000-000000000000",
7 "location_id": "00000000-0000-0000-0000-000000000000",
8 "transaction_date": "2023-01-02T02:34:56.000Z",
9 "total_amount": 123.45,
10 "memo": "This is a memo."
11 }
12}
1{
2 "bank_transfer": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "class_id": "00000000-0000-0000-0000-000000000000",
6 "credit_account_id": "00000000-0000-0000-0000-000000000000",
7 "debit_account_id": "00000000-0000-0000-0000-000000000000",
8 "department_id": "00000000-0000-0000-0000-000000000000",
9 "location_id": "00000000-0000-0000-0000-000000000000",
10 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
11 "transaction_date": "2023-01-02T02:34:56.000Z",
12 "currency_code": "USD",
13 "total_amount": 123.45,
14 "memo": "This is a memo.",
15 "created_at": "2023-01-02T02:34:56.000Z",
16 "updated_at": "2023-01-02T02:34:56.000Z",
17 "last_synced_at": "2023-01-02T02:34:56.000Z",
18 "platform_data": {
19 "id": 123,
20 "data": "Varies by platform"
21 }
22 }
23}
Update a Bank Transfer
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_transfer
objectRequiredbank_transfer
attributesResponse Body
Any of:
bank_transfer
objectRequiredbank_transfer
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
1{
2 "bank_transfer": {
3 "credit_account_id": "00000000-0000-0000-0000-000000000000",
4 "debit_account_id": "00000000-0000-0000-0000-000000000000",
5 "transaction_date": "2023-01-02T02:34:56.000Z",
6 "total_amount": 123.45,
7 "memo": "This is a memo."
8 }
9}
1{
2 "bank_transfer": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "class_id": "00000000-0000-0000-0000-000000000000",
6 "credit_account_id": "00000000-0000-0000-0000-000000000000",
7 "debit_account_id": "00000000-0000-0000-0000-000000000000",
8 "department_id": "00000000-0000-0000-0000-000000000000",
9 "location_id": "00000000-0000-0000-0000-000000000000",
10 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
11 "transaction_date": "2023-01-02T02:34:56.000Z",
12 "currency_code": "USD",
13 "total_amount": 123.45,
14 "memo": "This is a memo.",
15 "created_at": "2023-01-02T02:34:56.000Z",
16 "updated_at": "2023-01-02T02:34:56.000Z",
17 "last_synced_at": "2023-01-02T02:34:56.000Z",
18 "platform_data": {
19 "id": 123,
20 "data": "Varies by platform"
21 }
22 }
23}
Have questions?
Contact support for personalized guidance.