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.

parent_idstringnullableOptional

The Rutter ID of the Parent Account linked to the account. Supported for QuickBooks.

account_typeenumfilterable

The account type of the account. Warning: for Sage Intacct, account type can only be determined on QuickStart implementations. Otherwise, the account type will be returned as unknown.

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

The status of the account.

One ofactive, inactive, or pending.
balancenumberfilterablenullable

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, ZMW, ETH, BTC, or null.
namestringfilterablenullable

The business facing name of the account.

nominal_codestringfilterablenullable

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 and Sage Intacct.

Show subsidiaries attributes
created_atstringfilterablenullable

The ISO 8601 timestamp that the account was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the account was last updated.

last_synced_atstringfilterable

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

platform_urlstringnullable

A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

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

List Accounts

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

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

    Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.

    Filterable fields: created_at, updated_at, name, nominal_code, balance, account_type, status, last_synced_at.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

    Sortable fields: created_at, updated_at, name, nominal_code, balance, account_type, status, last_synced_at.

    expandenumqueryOptional

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

    Must beplatform_data.
    account_typeenumfilterablequeryOptional

    Deprecated - use filter instead. The exact account type to filter on.

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

200
Example Response Body
JSON
1
{


2
  "accounts": [


3
    {


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


5
      "platform_id": "12345678",


6
      "parent_id": "00000000-0000-0000-0000-000000000000",


7
      "account_type": "bank",


8
      "category": "asset",


9
      "status": "active",


10
      "balance": 123.45,


11
      "currency_code": "USD",


12
      "name": "Checking",


13
      "nominal_code": "1001",


14
      "subsidiaries": [


15
        {


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


17
          "status": "active"


18
        },


19
        {


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


21
          "status": "active"


22
        }


23
      ],


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


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


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


27
      "platform_url": "https://platform.com/resource?id=123",


28
      "platform_data": {


29
        "id": 123,


30
        "data": "Varies by platform"


31
      }


32
    }


33
  ],


34
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


35
  "connection": {


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


37
    "orgId": "00000000-0000-0000-0000-000000000000",


38
    "platform": "NETSUITE"


39
  }


40
}

Fetch an Account

GEThttps://production.rutterapi.com/versioned/accounting/accounts/: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 currently supported on Sage Intacct or Sage Business Cloud.

    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

200
Example Response Body
JSON
1
{


2
  "account": {


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


4
    "platform_id": "12345678",


5
    "parent_id": "00000000-0000-0000-0000-000000000000",


6
    "account_type": "bank",


7
    "category": "asset",


8
    "status": "active",


9
    "balance": 123.45,


10
    "currency_code": "USD",


11
    "name": "Checking",


12
    "nominal_code": "1001",


13
    "subsidiaries": [


14
      {


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


16
        "status": "active"


17
      },


18
      {


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


20
        "status": "active"


21
      }


22
    ],


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


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


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


26
    "platform_url": "https://platform.com/resource?id=123",


27
    "platform_data": {


28
      "id": 123,


29
      "data": "Varies by platform"


30
    }


31
  },


32
  "connection": {


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


34
    "orgId": "00000000-0000-0000-0000-000000000000",


35
    "platform": "NETSUITE"


36
  }


37
}

Create an Account

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    accountobject
    Show account attributes

Response Body

Example Request Body
JSON
1
{


2
  "account": {


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


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


5
    "account_type": "bank",


6
    "currency_code": "USD",


7
    "name": "Checking",


8
    "nominal_code": "1000"


9
  }


10
}
200
Example Response Body
JSON
1
{


2
  "account": {


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


4
    "platform_id": "12345678",


5
    "parent_id": "00000000-0000-0000-0000-000000000000",


6
    "account_type": "bank",


7
    "category": "asset",


8
    "status": "active",


9
    "balance": 123.45,


10
    "currency_code": "USD",


11
    "name": "Checking",


12
    "nominal_code": "1001",


13
    "subsidiaries": [


14
      {


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


16
        "status": "active"


17
      },


18
      {


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


20
        "status": "active"


21
      }


22
    ],


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


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


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


26
    "platform_url": "https://platform.com/resource?id=123",


27
    "platform_data": {


28
      "id": 123,


29
      "data": "Varies by platform"


30
    }


31
  }


32
}

Update an Account

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

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    accountobject
    Show account attributes

Response Body

Example Request Body
JSON
1
{


2
  "account": {


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


4
    "name": "Checking 1001",


5
    "nominal_code": "1001"


6
  }


7
}
200
Example Response Body
JSON
1
{


2
  "account": {


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


4
    "platform_id": "12345678",


5
    "parent_id": "00000000-0000-0000-0000-000000000000",


6
    "account_type": "bank",


7
    "category": "asset",


8
    "status": "active",


9
    "balance": 123.45,


10
    "currency_code": "USD",


11
    "name": "Checking",


12
    "nominal_code": "1001",


13
    "subsidiaries": [


14
      {


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


16
        "status": "active"


17
      },


18
      {


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


20
        "status": "active"


21
      }


22
    ],


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


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


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


26
    "platform_url": "https://platform.com/resource?id=123",


27
    "platform_data": {


28
      "id": 123,


29
      "data": "Varies by platform"


30
    }


31
  }


32
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Bank Deposits