Bank Deposits

The BankDeposit Object

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

Properties

idstring

The Rutter generated unique ID of the bank deposit.

platform_idstring

The platform specific ID of the bank deposit.

account_idstringnullable

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

subsidiary_idstringnullable

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

transaction_datestring

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

currency_codeenum

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_amountnumber

The total amount of the sales order bank deposit.

memostringnullable

The memo of the bank deposit.

linked_paymentsarray

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

Show linked_payments attributes

line_itemsarray

An array of line items associated with the bank deposit.

Show line_items attributes

created_atstringfilterablenullable

The ISO 8601 timestamp that the bank deposit was created.

updated_atstringfilterablenullable

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

last_synced_atstringfilterable

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

platform_dataobjectOptional

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.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

filterstringqueryOptional

Used 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.

sortstringqueryOptional

Used 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.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

last_synced_at_minintegerqueryOptional

Deprecated - 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_maxintegerqueryOptional

Deprecated - 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_minintegerqueryOptional

Deprecated - 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_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

bank_depositsarray

Show bank_deposits attributes

next_cursorstringnullableOptional

connectionobject

Show connection attributes

Support by integration

QuickBooks
NetSuite
Xero
QuickBooks Desktop

Example Response Body

JSON

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_data": {
36        "id": 123,
37        "data": "Varies by platform"
38      }
39    }
40  ],
41  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
42  "connection": {
43    "id": "00000000-0000-0000-0000-000000000000",
44    "orgId": "00000000-0000-0000-0000-000000000000",
45    "platform": "NETSUITE"
46  }
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.

id_typeenumqueryOptional

Used to indicate the type of id that is supplied. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

One ofrutter or platform.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

bank_depositobject

Show bank_deposit attributes

connectionobject

Show connection attributes

Support by integration

QuickBooks
NetSuite
Xero
QuickBooks Desktop

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  "connection": {
40    "id": "00000000-0000-0000-0000-000000000000",
41    "orgId": "00000000-0000-0000-0000-000000000000",
42    "platform": "NETSUITE"
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_depositobject

Show bank_deposit attributes

Response Body

Any of:

bank_depositobject

Show bank_deposit attributes

async_responseobjectOptional

Show async_response attributes

errorsarrayOptional

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_depositobject

Show bank_deposit attributes

Response Body

Any of:

bank_depositobject

Show bank_deposit attributes

async_responseobjectOptional

Show async_response attributes

errorsarrayOptional

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