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
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
stringfilterablenullableThe ISO 8601 timestamp that the location was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the location was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the department was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Locations
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalUsed to specify criteria to filter out the objects returned. Supports all filterable
fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
sort
stringqueryOptionalUsed to sort the returned objects, e.g. last_synced_at ASC
. Supports all filterable
fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at
and last_synced_at
fields are supported. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalDeprecated - 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_max
integerqueryOptionalDeprecated - 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_min
integerqueryOptionalDeprecated - 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_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
locations
arraylocations
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- 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 "connection": {
21 "id": "00000000-0000-0000-0000-000000000000",
22 "orgId": "00000000-0000-0000-0000-000000000000",
23 "platform": "NETSUITE"
24 }
25}
Fetch a Location
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
location
objectlocation
attributesconnection
objectconnection
attributes- NetSuite
- Sage Intacct
1{
2 "location": {
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": "SF Region",
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_data": {
13 "id": 123,
14 "data": "Varies by platform"
15 }
16 },
17 "connection": {
18 "id": "00000000-0000-0000-0000-000000000000",
19 "orgId": "00000000-0000-0000-0000-000000000000",
20 "platform": "NETSUITE"
21 }
22}
Have questions?
Contact support for personalized guidance.