Accounts

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

last_synced_atstring

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

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/accounts
GET
/accounting/accounts/:id
POST
/accounting/accounts

List Accounts

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

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    account_typeenumqueryOptional

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

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

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

    expandenumqueryOptional

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumqueryOptional

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

    One oftrue or false.
    last_synced_at_minintegerqueryOptional

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

    limitintegerqueryOptional

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

    sortstringqueryOptional

    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_maxintegerqueryOptional

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

    updated_at_minintegerqueryOptional

    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
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
  • QuickBooks Desktop
    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
  "accounts": [


8
    {


9
      "id": "00000000-0000-0000-0000-000000000000",


10
      "platform_id": "12345678",


11
      "account_type": "bank",


12
      "category": "asset",


13
      "status": "active",


14
      "balance": 123.45,


15
      "currency_code": "USD",


16
      "name": "Checking",


17
      "nominal_code": "1001",


18
      "subsidiaries": [


19
        {


20
          "id": "00000000-0000-0000-0000-000000000000"


21
        },


22
        {


23
          "id": "00000000-0000-0000-0000-000000000000"


24
        }


25
      ],


26
      "created_at": "2023-01-02T02:34:56.000Z",


27
      "updated_at": "2023-01-02T02:34:56.000Z",


28
      "last_synced_at": "2023-01-02T02:34:56.000Z",


29
      "platform_data": {


30
        "id": 123,


31
        "data": "Varies by platform"


32
      }


33
    }


34
  ],


35
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="


36
}

Fetch an Account

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

Request Parameters

    idstringpath

    The unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumqueryOptional

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

    One oftrue or false.
    id_typeenumqueryOptional

    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

    connectionobject
    Show connection attributes
    accountobject
    Show account attributes
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
  • QuickBooks Desktop
    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
  "account": {


8
    "id": "00000000-0000-0000-0000-000000000000",


9
    "platform_id": "12345678",


10
    "account_type": "bank",


11
    "category": "asset",


12
    "status": "active",


13
    "balance": 123.45,


14
    "currency_code": "USD",


15
    "name": "Checking",


16
    "nominal_code": "1001",


17
    "subsidiaries": [


18
      {


19
        "id": "00000000-0000-0000-0000-000000000000"


20
      },


21
      {


22
        "id": "00000000-0000-0000-0000-000000000000"


23
      }


24
    ],


25
    "created_at": "2023-01-02T02:34:56.000Z",


26
    "updated_at": "2023-01-02T02:34:56.000Z",


27
    "last_synced_at": "2023-01-02T02:34:56.000Z",


28
    "platform_data": {


29
      "id": 123,


30
      "data": "Varies by platform"


31
    }


32
  }


33
}

Create an Account

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

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
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Request Body
JSON
1
{


2
  "account": {


3
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


4
    "account_type": "bank",


5
    "currency_code": "USD",


6
    "name": "Checking",


7
    "nominal_code": "1000"


8
  }


9
}
Example Response Body
JSON
1
{


2
  "account": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "account_type": "bank",


6
    "category": "asset",


7
    "status": "active",


8
    "balance": 123.45,


9
    "currency_code": "USD",


10
    "name": "Checking",


11
    "nominal_code": "1001",


12
    "subsidiaries": [


13
      {


14
        "id": "00000000-0000-0000-0000-000000000000"


15
      },


16
      {


17
        "id": "00000000-0000-0000-0000-000000000000"


18
      }


19
    ],


20
    "created_at": "2023-01-02T02:34:56.000Z",


21
    "updated_at": "2023-01-02T02:34:56.000Z",


22
    "last_synced_at": "2023-01-02T02:34:56.000Z",


23
    "platform_data": {


24
      "id": 123,


25
      "data": "Varies by platform"


26
    }


27
  }


28
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Balance Sheets