Locations
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
stringRequiredThe Rutter generated unique ID of the location.
platform_id
stringRequiredThe platform specific ID of the location.
parent_id
stringnullableRequiredThe Rutter ID of the Parent Location linked to the location.
has_children
booleannullableRequiredDescribes whether the location has child locations.
name
stringnullableRequiredThe name of the location.
status
enumThe status of the location.
created_at
stringnullableRequiredThe ISO 8601 timestamp that the location was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the location was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the department was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Locations
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
locations
arrayRequiredlocations
attributesnext_cursor
stringnullable- Netsuite
- Sage Intacct
1{
2 "locations": [
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": "SF Region",
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_data": {
14 "id": 123,
15 "data": "Varies by platform"
16 }
17 }
18 ],
19 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
20}
Have questions?
Contact support for personalized guidance.