Departments

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.

statusenumfilterableOptional

The status of the department.

One ofactive or archived.
created_atstringfilterablenullable

The ISO 8601 timestamp that the department was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the department was last updated.

last_synced_atstringfilterable

The ISO 8601 timestamp when the department 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/departments
GET
/accounting/departments/:id
POST
/accounting/departments

List Departments

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

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: status, created_at, updated_at, 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: status, created_at, updated_at, last_synced_at.

    expandenumqueryOptional

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

    Must beplatform_data.
    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
  "departments": [


3
    {


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


5
      "platform_id": "12345678",


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


7
      "has_children": false,


8
      "name": "Engineering",


9
      "status": "active",


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


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


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


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


14
      "platform_data": {


15
        "id": 123,


16
        "data": "Varies by platform"


17
      }


18
    }


19
  ],


20
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


21
  "connection": {


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


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


24
    "platform": "NETSUITE"


25
  }


26
}

Fetch a Department

GEThttps://production.rutterapi.com/versioned/accounting/departments/: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
  "department": {


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


4
    "platform_id": "12345678",


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


6
    "has_children": false,


7
    "name": "Engineering",


8
    "status": "active",


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


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


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


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


13
    "platform_data": {


14
      "id": 123,


15
      "data": "Varies by platform"


16
    }


17
  },


18
  "connection": {


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


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


21
    "platform": "NETSUITE"


22
  }


23
}

Create a Department

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

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.
    departmentobject
    Show department attributes

Response Body

Example Request Body
JSON
1
{


2
  "department": {


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


4
    "name": "Engineering"


5
  }


6
}
200
Example Response Body
JSON
1
{


2
  "department": {


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


4
    "platform_id": "12345678",


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


6
    "has_children": false,


7
    "name": "Engineering",


8
    "status": "active",


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


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


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


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


13
    "platform_data": {


14
      "id": 123,


15
      "data": "Varies by platform"


16
    }


17
  }


18
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Items