Accounting

Bank Deposits
Get API Keys

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. This feature is currently only supported on 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, 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 on the bank deposit.

memostringnullable

Memo or description 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_atstringnullable

The ISO 8601 timestamp that the bank deposit was created.

updated_atstringnullable

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

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example BankDeposit Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "subsidiary_id": "00000000-0000-0000-0000-000000000000",
  "transaction_date": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "total_amount": 123.45,
  "memo": "This is a memo.",
  "linked_payments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "payment_amount": 5,
      "type": "invoice_payment"
    }
  ],
  "line_items": [
    {
      "account_id": "00000000-0000-0000-0000-000000000000",
      "class_id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "department_id": "00000000-0000-0000-0000-000000000000",
      "location_id": "00000000-0000-0000-0000-000000000000",
      "vendor_id": "00000000-0000-0000-0000-000000000000",
      "total_amount": 118.45,
      "description": "This is a description."
    }
  ],
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Bank Deposits

GET /accounting/bank_deposits
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

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

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

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

    updated_at_minintegeroptionalquery

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

Response Body

    connectionobject
    Show connection attributes
    bank_depositsarray
    Show bank_deposits attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bank_deposits": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",
      "transaction_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "total_amount": 123.45,
      "memo": "This is a memo.",
      "linked_payments": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "payment_amount": 5,
          "type": "invoice_payment"
        }
      ],
      "line_items": [
        {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "class_id": "00000000-0000-0000-0000-000000000000",
          "customer_id": "00000000-0000-0000-0000-000000000000",
          "department_id": "00000000-0000-0000-0000-000000000000",
          "location_id": "00000000-0000-0000-0000-000000000000",
          "vendor_id": "00000000-0000-0000-0000-000000000000",
          "total_amount": 118.45,
          "description": "This is a description."
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Bank Deposit

GET /accounting/bank_deposits/:id
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

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

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    bank_depositobject
    Show bank_deposit attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bank_deposit": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "total_amount": 123.45,
    "memo": "This is a memo.",
    "linked_payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "payment_amount": 5,
        "type": "invoice_payment"
      }
    ],
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "vendor_id": "00000000-0000-0000-0000-000000000000",
        "total_amount": 118.45,
        "description": "This is a description."
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Create a Bank Deposit

POST /accounting/bank_deposits
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    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
Example Request Body
{
  "bank_deposit": {
    "account_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "memo": "This is a memo.",
    "linked_payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "invoice_payment"
      }
    ],
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "vendor_id": "00000000-0000-0000-0000-000000000000",
        "total_amount": 118.45,
        "description": "This is a description."
      }
    ]
  }
}
Example Response Body
{
  "bank_deposit": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "total_amount": 123.45,
    "memo": "This is a memo.",
    "linked_payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "payment_amount": 5,
        "type": "invoice_payment"
      }
    ],
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "vendor_id": "00000000-0000-0000-0000-000000000000",
        "total_amount": 118.45,
        "description": "This is a description."
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}
Next
Bank Transfers