Subsidiaries - Rutter API Reference - the Common Language for Business Data

The Subsidiary object

Rutter Subsidiaries contains basic information about legal entities within a business.

Properties

idstring

The Rutter generated unique ID of the subsidiary.

platform_idstring

The platform specific ID of the subsidiary.

parent_idstringnullable

The Rutter generated unique ID of the parent subsidiary.

countrystring

The country of the subsidiary.

statusenum

The status of the subsidiary

One ofactive or inactive.

currency_codestringnullable

The ISO 4217 currency code of the subsidiary.

namestringnullable

The name of the subsidiary.

updated_atstringnullable

The ISO 8601 timestamp that the subsidiary was last updated.

Example Subsidiary Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "country": "USA",
  "status": "active",
  "currency_code": "USD",
  "name": "Johnson & Johnson LLC",
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Subsidiaries

GET /accounting/subsidiaries

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

connectionobject

Show connection attributes

subsidiariesarray

Show subsidiaries attributes

next_cursorstringnullableoptional

Example Response Body

{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "subsidiaries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "parent_id": "00000000-0000-0000-0000-000000000000",
      "country": "USA",
      "status": "active",
      "currency_code": "USD",
      "name": "Johnson & Johnson LLC",
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Subsidiary

GET /accounting/subsidiaries/:id