Accounting

Locations
Get API Keys

The Location object

A Rutter Location represents a categorization for bills and expenses that logs the origin or geographical domain of the purchase.

Properties

idstring

The Rutter generated unique ID of the location.

platform_idstring

The platform specific ID of the location.

parent_idstringnullable

The Rutter ID of the Parent Location linked to the location.

has_childrenbooleannullable

Describes whether the location has child locations.

namestringnullable

The name of the location.

statusenumoptional

The status of the location.

One ofactive or archived.
created_atstringnullable

The ISO 8601 timestamp that the location was created.

updated_atstringnullable

The ISO 8601 timestamp that the location was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example Location Object
{
  "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/locations
Supported for: NetSuite

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    locationsarray
    Show locations attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "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="
}
Next
Subsidiaries