Accounts - Rutter API Reference - the Common Language for Business Data

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.

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.

categoryenum

The category of the account.

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

statusenum

The status of the account.

One ofactive, inactive, or pending.

balancenumbernullable

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

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

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.

subsidiariesarray

An array of Subsidiaries linked to the account. This feature is currently only supported on NetSuite. A subsidiary_id query parameter can be optionally included in GET requests to filter the account results.

Show subsidiaries attributes

created_atstringnullable

The ISO 8601 timestamp that the account was created.

updated_atstring

The ISO 8601 timestamp that the account was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes

Example Account Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "account_type": "bank",
  "category": "asset",
  "status": "active",
  "balance": 123.45,
  "currency_code": "USD",
  "name": "Checking",
  "nominal_code": "1001",
  "subsidiaries": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "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 Accounts

GET /versioned/accounting/accounts

Supported for: Dynamics 365FreeAgentFreshBooksMoneybirdNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctTallyWaveXeroZoho Books

Request Parameters

access_tokenstringquery

The access token of the connection.

account_typeenumoptionalquery

The Rutter account type that you want to filter accounts by. Supported for the following platforms: QUICKBOOKS, NETSUITE, XERO, ZOHOBOOKS, DYNAMICS365, SAGE_INTACCT.

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

accountsarray

Show accounts attributes

next_cursorstringnullableoptional

Example Response Body

{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "accounts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_type": "bank",
      "category": "asset",
      "status": "active",
      "balance": 123.45,
      "currency_code": "USD",
      "name": "Checking",
      "nominal_code": "1001",
      "subsidiaries": [
        {
          "id": "00000000-0000-0000-0000-000000000000"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "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 an Account

GET /versioned/accounting/accounts/:id

Supported for: Dynamics 365FreeAgentFreshBooksMoneybirdNetSuiteQuickBooksQuickBooks DesktopSage Business CloudSage IntacctTallyWaveXeroZoho 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

connectionobject

Show connection attributes

accountobject

Show account attributes

Example Response Body

{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "account": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_type": "bank",
    "category": "asset",
    "status": "active",
    "balance": 123.45,
    "currency_code": "USD",
    "name": "Checking",
    "nominal_code": "1001",
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "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 an Account

POST /versioned/accounting/accounts

Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

accountobject

Show account attributes

Response Body

Any of:

accountobject

Show account attributes

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "account": {
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "account_type": "bank",
    "currency_code": "USD",
    "name": "Checking",
    "nominal_code": "1000"
  }
}

Example Response Body

{
  "account": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_type": "bank",
    "category": "asset",
    "status": "active",
    "balance": 123.45,
    "currency_code": "USD",
    "name": "Checking",
    "nominal_code": "1001",
    "subsidiaries": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}