Bank Transfers
The BankTransfer Object
Currently, there's only support between accounts of the same currency.
Properties
id
stringThe Rutter generated unique ID of the bank transfer.
platform_id
stringThe platform specific ID of the bank transfer.
class_id
stringnullableThe Rutter ID of the Class linked to the bank transfer line item.
credit_account_id
stringnullableThe Rutter ID of the Account linked to the bank transfer. Represents the asset account being credited.
debit_account_id
stringnullableThe Rutter ID of the Account linked to the bank transfer. Represents the asset account being debit.
department_id
stringnullableThe Rutter ID of the Department linked to the bank transfer line item.
location_id
stringnullableThe Rutter ID of the Location linked to the bank transfer line item.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the bank transfer. Supported for NetSuite.
transaction_date
stringThe ISO 8601 timestamp for the transaction date of the bank transfer.
currency_code
enumThe ISO 4217 currency code of the bank transfer.
total_amount
numberThe total amount of the bank transfer.
memo
stringnullableThe memo of the bank transfer.
created_at
stringfilterablenullableThe ISO 8601 timestamp that the bank transfer was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the bank transfer was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the bank transfer was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Bank Transfers
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_transfers
arraybank_transfers
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
1{
2 "bank_transfers": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "class_id": "00000000-0000-0000-0000-000000000000",
7 "credit_account_id": "00000000-0000-0000-0000-000000000000",
8 "debit_account_id": "00000000-0000-0000-0000-000000000000",
9 "department_id": "00000000-0000-0000-0000-000000000000",
10 "location_id": "00000000-0000-0000-0000-000000000000",
11 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
12 "transaction_date": "2023-01-02T02:34:56.000Z",
13 "currency_code": "USD",
14 "total_amount": 123.45,
15 "memo": "This is a memo.",
16 "created_at": "2023-01-02T02:34:56.000Z",
17 "updated_at": "2023-01-02T02:34:56.000Z",
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 "connection": {
27 "id": "00000000-0000-0000-0000-000000000000",
28 "orgId": "00000000-0000-0000-0000-000000000000",
29 "platform": "NETSUITE"
30 }
31}
Fetch a Bank Transfer
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 supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
bank_transfer
objectbank_transfer
attributesconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
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 "connection": {
24 "id": "00000000-0000-0000-0000-000000000000",
25 "orgId": "00000000-0000-0000-0000-000000000000",
26 "platform": "NETSUITE"
27 }
28}
Create a Bank Transfer
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_transfer
objectbank_transfer
attributesResponse Body
Any of:
bank_transfer
objectbank_transfer
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
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
objectbank_transfer
attributesResponse Body
Any of:
bank_transfer
objectbank_transfer
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
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.