The Department object
A Rutter Department represents a categorization for bills and expenses that logs the employer-level origin of the purchase.
Properties
id
stringThe Rutter generated unique ID of the department.
platform_id
stringThe platform specific ID of the department.
parent_id
stringnullableThe Rutter ID of the Parent Department linked to the department.
has_children
booleannullableDescribes whether the department has child departments.
name
stringnullableThe name of the department.
status
enumoptionalThe status of the department.
created_at
stringnullableThe ISO 8601 timestamp that the department was created.
updated_at
stringnullableThe ISO 8601 timestamp that the department was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"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/departmentsRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
departments
arraydepartments
attributesnext_cursor
stringnullableoptional{
"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="
}