Bank Deposits
The BankDeposit Object
Currently, there's only support between accounts of the same currency.
Properties
id
stringRequiredThe Rutter generated unique ID of the bank deposit.
platform_id
stringRequiredThe platform specific ID of the bank deposit.
account_id
stringnullableRequiredThe Rutter ID of the Account linked to the bank deposit. Represents the asset account being debited.
subsidiary_id
stringnullableRequiredThe Rutter ID of the Subsidiary linked to the bank deposit. Supported for NetSuite.
transaction_date
stringRequiredThe ISO 8601 timestamp for the transaction date of the bank deposit.
currency_code
enumRequiredThe ISO 4217 currency code of the bank deposit.
total_amount
numberRequiredThe total amount of the sales order bank deposit.
memo
stringnullableRequiredThe memo of the bank deposit.
linked_payments
arrayRequiredAny previously created transactions associated with this deposit, used for reconciliation.
linked_payments
attributesline_items
arrayRequiredAn array of line items associated with the bank deposit.
line_items
attributescreated_at
stringnullableRequiredThe ISO 8601 timestamp that the bank deposit was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the bank deposit was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the bank deposit was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Bank Deposits
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_deposits
arrayRequiredbank_deposits
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "bank_deposits": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "account_id": "00000000-0000-0000-0000-000000000000",
12 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
13 "transaction_date": "2023-01-02T02:34:56.000Z",
14 "currency_code": "USD",
15 "total_amount": 123.45,
16 "memo": "This is a memo.",
17 "linked_payments": [
18 {
19 "id": "00000000-0000-0000-0000-000000000000",
20 "payment_amount": 5,
21 "type": "invoice_payment"
22 }
23 ],
24 "line_items": [
25 {
26 "platform_id": "12345678",
27 "account_id": "00000000-0000-0000-0000-000000000000",
28 "class_id": "00000000-0000-0000-0000-000000000000",
29 "customer_id": "00000000-0000-0000-0000-000000000000",
30 "department_id": "00000000-0000-0000-0000-000000000000",
31 "location_id": "00000000-0000-0000-0000-000000000000",
32 "vendor_id": "00000000-0000-0000-0000-000000000000",
33 "total_amount": 118.45,
34 "description": "This is a description."
35 }
36 ],
37 "created_at": "2023-01-02T02:34:56.000Z",
38 "updated_at": "2023-01-02T02:34:56.000Z",
39 "last_synced_at": "2023-01-02T02:34:56.000Z",
40 "platform_data": {
41 "id": 123,
42 "data": "Varies by platform"
43 }
44 }
45 ],
46 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
47}
Fetch a Bank Deposit
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_deposit
objectRequiredbank_deposit
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "bank_deposit": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "account_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 "linked_payments": [
17 {
18 "id": "00000000-0000-0000-0000-000000000000",
19 "payment_amount": 5,
20 "type": "invoice_payment"
21 }
22 ],
23 "line_items": [
24 {
25 "platform_id": "12345678",
26 "account_id": "00000000-0000-0000-0000-000000000000",
27 "class_id": "00000000-0000-0000-0000-000000000000",
28 "customer_id": "00000000-0000-0000-0000-000000000000",
29 "department_id": "00000000-0000-0000-0000-000000000000",
30 "location_id": "00000000-0000-0000-0000-000000000000",
31 "vendor_id": "00000000-0000-0000-0000-000000000000",
32 "total_amount": 118.45,
33 "description": "This is a description."
34 }
35 ],
36 "created_at": "2023-01-02T02:34:56.000Z",
37 "updated_at": "2023-01-02T02:34:56.000Z",
38 "last_synced_at": "2023-01-02T02:34:56.000Z",
39 "platform_data": {
40 "id": 123,
41 "data": "Varies by platform"
42 }
43 }
44}
Create a Bank Deposit
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_deposit
objectRequiredbank_deposit
attributesResponse Body
Any of:
bank_deposit
objectRequiredbank_deposit
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
1{
2 "bank_deposit": {
3 "account_id": "00000000-0000-0000-0000-000000000000",
4 "transaction_date": "2023-01-02T02:34:56.000Z",
5 "memo": "This is a memo.",
6 "linked_payments": [
7 {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "type": "invoice_payment"
10 }
11 ],
12 "line_items": [
13 {
14 "account_id": "00000000-0000-0000-0000-000000000000",
15 "class_id": "00000000-0000-0000-0000-000000000000",
16 "customer_id": "00000000-0000-0000-0000-000000000000",
17 "department_id": "00000000-0000-0000-0000-000000000000",
18 "location_id": "00000000-0000-0000-0000-000000000000",
19 "vendor_id": "00000000-0000-0000-0000-000000000000",
20 "total_amount": 118.45,
21 "description": "This is a description."
22 }
23 ]
24 }
25}
1{
2 "bank_deposit": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_id": "00000000-0000-0000-0000-000000000000",
6 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
7 "transaction_date": "2023-01-02T02:34:56.000Z",
8 "currency_code": "USD",
9 "total_amount": 123.45,
10 "memo": "This is a memo.",
11 "linked_payments": [
12 {
13 "id": "00000000-0000-0000-0000-000000000000",
14 "payment_amount": 5,
15 "type": "invoice_payment"
16 }
17 ],
18 "line_items": [
19 {
20 "platform_id": "12345678",
21 "account_id": "00000000-0000-0000-0000-000000000000",
22 "class_id": "00000000-0000-0000-0000-000000000000",
23 "customer_id": "00000000-0000-0000-0000-000000000000",
24 "department_id": "00000000-0000-0000-0000-000000000000",
25 "location_id": "00000000-0000-0000-0000-000000000000",
26 "vendor_id": "00000000-0000-0000-0000-000000000000",
27 "total_amount": 118.45,
28 "description": "This is a description."
29 }
30 ],
31 "created_at": "2023-01-02T02:34:56.000Z",
32 "updated_at": "2023-01-02T02:34:56.000Z",
33 "last_synced_at": "2023-01-02T02:34:56.000Z",
34 "platform_data": {
35 "id": 123,
36 "data": "Varies by platform"
37 }
38 }
39}
Update a Bank Deposit
If a field value is provided, that field will take the updated value. If the field is not provided, the existing value will persist.
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
bank_deposit
objectRequiredbank_deposit
attributesResponse Body
Any of:
bank_deposit
objectRequiredbank_deposit
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
1{
2 "bank_deposit": {
3 "account_id": "00000000-0000-0000-0000-000000000000",
4 "memo": "This is a memo.",
5 "linked_payments": [
6 {
7 "id": "00000000-0000-0000-0000-000000000000",
8 "type": "invoice_payment"
9 }
10 ],
11 "line_items": [
12 {
13 "platform_id": "12345678",
14 "account_id": "00000000-0000-0000-0000-000000000000",
15 "class_id": "00000000-0000-0000-0000-000000000000",
16 "customer_id": "00000000-0000-0000-0000-000000000000",
17 "department_id": "00000000-0000-0000-0000-000000000000",
18 "location_id": "00000000-0000-0000-0000-000000000000",
19 "vendor_id": "00000000-0000-0000-0000-000000000000",
20 "description": "This is a description.",
21 "total_amount": 123.45
22 }
23 ]
24 }
25}
1{
2 "bank_deposit": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "account_id": "00000000-0000-0000-0000-000000000000",
6 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
7 "transaction_date": "2023-01-02T02:34:56.000Z",
8 "currency_code": "USD",
9 "total_amount": 123.45,
10 "memo": "This is a memo.",
11 "linked_payments": [
12 {
13 "id": "00000000-0000-0000-0000-000000000000",
14 "payment_amount": 5,
15 "type": "invoice_payment"
16 }
17 ],
18 "line_items": [
19 {
20 "platform_id": "12345678",
21 "account_id": "00000000-0000-0000-0000-000000000000",
22 "class_id": "00000000-0000-0000-0000-000000000000",
23 "customer_id": "00000000-0000-0000-0000-000000000000",
24 "department_id": "00000000-0000-0000-0000-000000000000",
25 "location_id": "00000000-0000-0000-0000-000000000000",
26 "vendor_id": "00000000-0000-0000-0000-000000000000",
27 "total_amount": 118.45,
28 "description": "This is a description."
29 }
30 ],
31 "created_at": "2023-01-02T02:34:56.000Z",
32 "updated_at": "2023-01-02T02:34:56.000Z",
33 "last_synced_at": "2023-01-02T02:34:56.000Z",
34 "platform_data": {
35 "id": 123,
36 "data": "Varies by platform"
37 }
38 }
39}
Have questions?
Contact support for personalized guidance.