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

The Class object

A Rutter Class represents the generic categorization for bills and expenses used for financial reporting purposes. In some instances, it is referred to as a Tracking Category.

Properties

idstring

The Rutter generated unique ID of the class.

platform_idstring

The platform specific ID of the class.

parent_idstringnullable

The Rutter ID of the Parent Class linked to the class.

has_childrenbooleannullable

Describes whether the class has child classes.

namestringnullable

The name of the class.

statusenumoptional

The status of the class.

One ofactive or archived.

created_atstringnullable

The ISO 8601 timestamp that the class was created.

updated_atstringnullable

The ISO 8601 timestamp that the class was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes

Example Class Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "has_children": false,
  "name": "Generic Spend",
  "status": "active",
  "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 Classes

GET /accounting/classes

Supported for: NetSuiteQuickBooks

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

classesarray

Show classes attributes

next_cursorstringnullable

Example Response Body

{
  "classes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "parent_id": "00000000-0000-0000-0000-000000000000",
      "has_children": false,
      "name": "Generic Spend",
      "status": "active",
      "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="
}