Classes

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.

last_synced_atstring

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

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/classes

List Classes

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

Request Parameters

access_tokenstringquery

The access token of the connection.

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

classesarray

Show classes attributes

next_cursorstringnullableOptional

Support by integration

QuickBooks
NetSuite
Xero
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  "classes": [
8    {
9      "id": "00000000-0000-0000-0000-000000000000",
10      "platform_id": "12345678",
11      "parent_id": "00000000-0000-0000-0000-000000000000",
12      "has_children": false,
13      "name": "Generic Spend",
14      "status": "active",
15      "created_at": "2023-01-02T02:34:56.000Z",
16      "updated_at": "2023-01-02T02:34:56.000Z",
17      "last_synced_at": "2023-01-02T02:34:56.000Z",
18      "platform_data": {
19        "id": 123,
20        "data": "Varies by platform"
21      }
22    }
23  ],
24  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
25}

Have questions?

Contact support for personalized guidance.

Contact support