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

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.

statusenumfilterableOptional

The status of the location.

One ofactive or archived.
subsidiariesarray

An array of Subsidiary linked to the location. Supported for NetSuite and Sage Intacct.

Show subsidiaries attributes
created_atstringfilterablenullable

The ISO 8601 timestamp that the location was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the location was last updated.

last_synced_atstringfilterable

The ISO 8601 timestamp when the department was last synced by Rutter.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/locations
GET
/accounting/locations/:id

List Locations

GEThttps://production.rutterapi.com/versioned/accounting/locations

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.

    Filterable fields: status, created_at, updated_at, last_synced_at.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

    Sortable fields: status, created_at, updated_at, last_synced_at.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Deprecated - 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_maxintegerqueryOptional

    Deprecated - 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_minintegerqueryOptional

    Deprecated - 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_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
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
      "subsidiaries": [


11
        {


12
          "id": "00000000-0000-0000-0000-000000000000"


13
        }


14
      ],


15
      "created_at": "2023-01-02T02:34:56.000Z",


16
      "updated_at": "2023-01-02T02:34:56.000Z",


17
      "last_synced_at": "2023-01-02T02:34:56.000Z",


18
      "platform_data": {


19
        "id": 123,


20
        "data": "Varies by platform"


21
      }


22
    }


23
  ],


24
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


25
  "connection": {


26
    "id": "00000000-0000-0000-0000-000000000000",


27
    "orgId": "00000000-0000-0000-0000-000000000000",


28
    "platform": "NETSUITE"


29
  }


30
}

Fetch a Location

GEThttps://production.rutterapi.com/versioned/accounting/locations/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
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
    "subsidiaries": [


10
      {


11
        "id": "00000000-0000-0000-0000-000000000000"


12
      }


13
    ],


14
    "created_at": "2023-01-02T02:34:56.000Z",


15
    "updated_at": "2023-01-02T02:34:56.000Z",


16
    "last_synced_at": "2023-01-02T02:34:56.000Z",


17
    "platform_data": {


18
      "id": 123,


19
      "data": "Varies by platform"


20
    }


21
  },


22
  "connection": {


23
    "id": "00000000-0000-0000-0000-000000000000",


24
    "orgId": "00000000-0000-0000-0000-000000000000",


25
    "platform": "NETSUITE"


26
  }


27
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Payment Terms