The Location object
A Rutter Location represents a categorization for bills and expenses that logs the origin or geographical domain of the purchase.
Properties
id
stringThe Rutter generated unique ID of the location.
platform_id
stringThe platform specific ID of the location.
parent_id
stringnullableThe Rutter ID of the Parent Location linked to the location.
has_children
booleannullableDescribes whether the location has child locations.
name
stringnullableThe name of the location.
status
enumoptionalThe status of the location.
created_at
stringnullableThe ISO 8601 timestamp that the location was created.
updated_at
stringnullableThe ISO 8601 timestamp that the location 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": "SF Region",
"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 Locations
GET /accounting/locationsRequest 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
locations
arraylocations
attributesnext_cursor
stringnullableoptional{
"locations": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"parent_id": "00000000-0000-0000-0000-000000000000",
"has_children": false,
"name": "SF Region",
"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="
}