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

The Department object

A Rutter Department represents a categorization for bills and expenses that logs the employer-level origin of the purchase.

Properties

idstring

The Rutter generated unique ID of the department.

platform_idstring

The platform specific ID of the department.

parent_idstringnullable

The Rutter ID of the Parent Department linked to the department.

has_childrenbooleannullable

Describes whether the department has child departments.

namestringnullable

The name of the department.

statusenumoptional

The status of the department.

One ofactive or archived.

created_atstringnullable

The ISO 8601 timestamp that the department was created.

updated_atstringnullable

The ISO 8601 timestamp that the department was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes

Example Department Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "has_children": false,
  "name": "Engineering",
  "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 Departments

GET /accounting/departments

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

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

updated_at_minintegeroptionalquery

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

Response Body

departmentsarray

Show departments attributes

next_cursorstringnullableoptional

Example Response Body

{
  "departments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "parent_id": "00000000-0000-0000-0000-000000000000",
      "has_children": false,
      "name": "Engineering",
      "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="
}