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
id
stringRequiredThe Rutter generated unique ID of the class.
platform_id
stringRequiredThe platform specific ID of the class.
parent_id
stringnullableRequiredThe Rutter ID of the Parent Class linked to the class.
has_children
booleannullableRequiredDescribes whether the class has child classes.
name
stringnullableRequiredThe name of the class.
status
enumThe status of the class.
created_at
stringnullableRequiredThe ISO 8601 timestamp that the class was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the class was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the class was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Classes
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe limit on the number of entities returned.
sort
stringqueryThe 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_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectRequiredconnection
attributesclasses
arrayRequiredclasses
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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.