Bank Deposits

The BankDeposit Object

Currently, there's only support between accounts of the same currency.

Properties

idstringRequired

The Rutter generated unique ID of the bank deposit.

platform_idstringRequired

The platform specific ID of the bank deposit.

account_idstringnullableRequired

The Rutter ID of the Account linked to the bank deposit. Represents the asset account being debited.

subsidiary_idstringnullableRequired

The Rutter ID of the Subsidiary linked to the bank deposit. Supported for NetSuite.

transaction_datestringRequired

The ISO 8601 timestamp for the transaction date of the bank deposit.

currency_codeenumRequired

The ISO 4217 currency code of the bank deposit.

One ofAED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, or ZMW.

total_amountnumberRequired

The total amount of the sales order bank deposit.

memostringnullableRequired

The memo of the bank deposit.

linked_paymentsarrayRequired

Any previously created transactions associated with this deposit, used for reconciliation.

Show linked_payments attributes

line_itemsarrayRequired

An array of line items associated with the bank deposit.

Show line_items attributes

created_atstringnullableRequired

The ISO 8601 timestamp that the bank deposit was created.

updated_atstringnullableRequired

The ISO 8601 timestamp that the bank deposit was last updated.

last_synced_atstringRequired

The ISO 8601 timestamp when the bank deposit was last synced by Rutter.

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/bank_deposits

GET

/accounting/bank_deposits/:id

POST

/accounting/bank_deposits

PATCH

/accounting/bank_deposits/:id

List Bank Deposits

GEThttps://production.rutterapi.com/versioned/accounting/bank_deposits

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringquery

The cursor to use for pagination. Use the value of next_cursor provided in a previous response.

expandenumquery

Used to request inclusion of optional objects.

Can beplatform_data.

force_fetchenumquery

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

last_synced_at_minintegerquery

Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

limitintegerquery

The number of entities to return. Defaults to 50. Maximum is 500.

sortstringquery

The 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_maxintegerquery

Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

updated_at_minintegerquery

Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

connectionobjectRequired

Show connection attributes

bank_depositsarrayRequired

Show bank_deposits attributes

next_cursorstringnullable

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

Example Response Body

JSON

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

GEThttps://production.rutterapi.com/versioned/accounting/bank_deposits/:id

Request Parameters

idstringpathRequired

The unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

force_fetchenumquery

Force a response even if the underlying connection hasn't finished the initial sync.

One oftrue or false.

id_typeenumquery

Optionally, search for a connection by Rutter ID or platform ID. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

One ofrutter or platform.

Response Body

connectionobjectRequired

Show connection attributes

bank_depositobjectRequired

Show bank_deposit attributes

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

Example Response Body

JSON

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

POSThttps://production.rutterapi.com/versioned/accounting/bank_deposits

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

bank_depositobjectRequired

Show bank_deposit attributes

Response Body

Any of:

bank_depositobjectRequired

Show bank_deposit attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

QuickBooks
Netsuite
Xero
QuickBooks Desktop

Example Request Body

JSON

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}

Example Response Body

JSON

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

PATCHhttps://production.rutterapi.com/versioned/accounting/bank_deposits/:id

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

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

bank_depositobjectRequired

Show bank_deposit attributes

Response Body

Any of:

bank_depositobjectRequired

Show bank_deposit attributes

async_responseobject

Show async_response attributes

errorsarray

Show errors attributes

Support by integration

QuickBooks
Netsuite

Example Request Body

JSON

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}

Example Response Body

JSON

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.

Contact support