Bank Deposits
The BankDeposit Object
Bank deposits are used to group payments together into a single bank deposit record and record any payment processing or transfer fees so that accountants can reconcile bank transactions with matching bank deposit amounts. In many cases, payments do not hit the bank account directly, so they are first made to an "Undeposited" funds account. Afterwards, once the payment is processed, the payment will hit the bank/asset account and a bank deposit can be used to represent this change.
Currently, there's only support between accounts of the same currency.
Properties
id
stringThe Rutter generated unique ID of the bank deposit.
platform_id
stringThe platform specific ID of the bank deposit.
account_id
stringnullableThe Rutter ID of the Account linked to the bank deposit. Represents the asset account being debited.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the bank deposit. Supported for NetSuite.
transaction_date
stringThe ISO 8601 timestamp for the transaction date of the bank deposit.
currency_code
enumThe ISO 4217 currency code of the bank deposit.
total_amount
numberThe total amount of the sales order bank deposit.
memo
stringnullableThe memo of the bank deposit.
linked_payments
arrayAny previously created transactions associated with this deposit, used for reconciliation.
linked_payments
attributesline_items
arrayAn array of line items associated with the bank deposit.
line_items
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the bank deposit was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the bank deposit was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the bank deposit was last synced by Rutter.
platform_url
stringnullableA URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Bank Deposits
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
stringqueryOptionalNot currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable
tag in the response object.
Filterable fields: created_at
, updated_at
, last_synced_at
.
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
. Supports only fields decorated with a filterable
tag in the response object except on Sage Intacct and Dynamics 365 Business Central. For those platforms, only updated_at_min
, updated_at_max
and last_synced_at_min
fields are supported and not deprecated.
Sortable fields: created_at
, updated_at
, last_synced_at
.
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
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
1{
2 "bank_deposits": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "account_id": "00000000-0000-0000-0000-000000000000",
7 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
8 "transaction_date": "2023-01-02T02:34:56.000Z",
9 "currency_code": "USD",
10 "total_amount": 123.45,
11 "memo": "This is a memo.",
12 "linked_payments": [
13 {
14 "id": "00000000-0000-0000-0000-000000000000",
15 "payment_amount": 5,
16 "type": "invoice_payment"
17 }
18 ],
19 "line_items": [
20 {
21 "platform_id": "12345678",
22 "account_id": "00000000-0000-0000-0000-000000000000",
23 "class_id": "00000000-0000-0000-0000-000000000000",
24 "customer_id": "00000000-0000-0000-0000-000000000000",
25 "department_id": "00000000-0000-0000-0000-000000000000",
26 "location_id": "00000000-0000-0000-0000-000000000000",
27 "vendor_id": "00000000-0000-0000-0000-000000000000",
28 "total_amount": 118.45,
29 "description": "This is a description."
30 }
31 ],
32 "created_at": "2023-01-02T02:34:56.000Z",
33 "updated_at": "2023-01-02T02:34:56.000Z",
34 "last_synced_at": "2023-01-02T02:34:56.000Z",
35 "platform_url": "https://platform.com/resource?id=123",
36 "platform_data": {
37 "id": 123,
38 "data": "Varies by platform"
39 }
40 }
41 ],
42 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
43 "connection": {
44 "id": "00000000-0000-0000-0000-000000000000",
45 "orgId": "00000000-0000-0000-0000-000000000000",
46 "platform": "NETSUITE"
47 }
48}
Fetch a Bank Deposit
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
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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_url": "https://platform.com/resource?id=123",
35 "platform_data": {
36 "id": 123,
37 "data": "Varies by platform"
38 }
39 },
40 "connection": {
41 "id": "00000000-0000-0000-0000-000000000000",
42 "orgId": "00000000-0000-0000-0000-000000000000",
43 "platform": "NETSUITE"
44 }
45}
Create a Bank Deposit
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe response mode for our async endpoints. prefer_sync
allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async
makes the API respond with the asynchronous response. See Asynchronous Operations.
bank_deposit
objectbank_deposit
attributesResponse Body
- QuickBooks
- Xero
- QuickBooks Desktop
- NetSuite
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_url": "https://platform.com/resource?id=123",
35 "platform_data": {
36 "id": 123,
37 "data": "Varies by platform"
38 }
39 }
40}
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
response_mode
enumOptionalThe response mode for our async endpoints. prefer_sync
allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async
makes the API respond with the asynchronous response. See Asynchronous Operations.
bank_deposit
objectbank_deposit
attributesResponse Body
- 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_url": "https://platform.com/resource?id=123",
35 "platform_data": {
36 "id": 123,
37 "data": "Varies by platform"
38 }
39 }
40}
Delete a Bank Deposit
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
response_mode
enumOptionalThe response mode for our async endpoints. prefer_sync
allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async
makes the API respond with the asynchronous response. See Asynchronous Operations.
Response Body
- QuickBooks
1{
2 "code": "deleted",
3 "success": true
4}
Have questions?
Contact support for personalized guidance.