Accounting

Accounts
Get API Keys

The Account object

A Rutter Account represents an account contained within the business entity's chart of accounts. Every account is part of one of the five categories asset, liability, equity, income, and expense, and contains an account_type representing the sub-category of account. The account object also contains a balance representing the running sum of all credits and debits applied against the account.

Properties

idstring

The Rutter generated unique ID of the account.

platform_idstring

The platform specific ID of the account.

created_atstringnullable

The ISO 8601 timestamp that the account was created.

updated_atstring

The ISO 8601 timestamp that the account was last updated.

namestringnullable

The business facing name of the account.

nominal_codestringnullable

The nominal code of the account used to classify accounts by department or account type.

currency_codeenumnullable

The ISO 4217 currency code of the account.

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, 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.
categoryenum

The category of the account.

One ofasset, expense, equity, liability, income, nonposting, or unknown.
account_typeenum

The account type of the account.

One ofaccounts_payable, accounts_receivable, bank, fixed_asset, other_asset, other_current_asset, liability, equity, expense, other_expense, income, other_income, credit_card, cost_of_goods_sold, other_current_liability, long_term_liability, non_posting, or unknown.
statusenum

The status of the account.

One ofactive, inactive, or pending.
platform_dataoptional

The raw platform data corresponding to the Rutter object.

current_balancenumbernullable

The running balance of all credits and debits applied to the account.

Example Account Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "name": "Checking",
  "nominal_code": "1001",
  "currency_code": "USD",
  "current_balance": 123.45,
  "category": "asset",
  "account_type": "bank",
  "status": "active"
}

List Accounts

GET /accounting/accounts
Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctWaveXeroZoho Books

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

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

    updated_at_minintegeroptionalquery

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

Response Body

    connectionConnection
    Show connection attributes
    accountsarray
    Show accounts attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "accounts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "name": "Checking",
      "nominal_code": "1001",
      "currency_code": "USD",
      "current_balance": 123.45,
      "category": "asset",
      "account_type": "bank",
      "status": "active"
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }
}

Fetch an Account

GET /accounting/accounts/:id
Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctWaveXeroZoho Books

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

    connectionConnection
    Show connection attributes
    accountAccount
    Show account attributes
Example Response Body
{
  "account": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "name": "Checking",
    "nominal_code": "1001",
    "currency_code": "USD",
    "current_balance": 123.45,
    "category": "asset",
    "account_type": "bank",
    "status": "active"
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }
}

Create an Account

POST /accounting/accounts
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    accountobject
    Show account attributes

Response Body

    Any of:

    Account Response

    accountAccount
    Show account attributes

    Async Response Payload

    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Response Body
{
  "account": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "name": "Checking",
    "nominal_code": "1001",
    "currency_code": "USD",
    "current_balance": 123.45,
    "category": "asset",
    "account_type": "bank",
    "status": "active"
  }
}
Next
Vendors