Subsidiaries

The Subsidiary Object

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

Properties

idstringRequired

The Rutter generated unique ID of the subsidiary.

platform_idstringRequired

The platform specific ID of the subsidiary.

parent_idstringnullableRequired

The Rutter generated unique ID of the parent subsidiary.

countrystringRequired

The country of the subsidiary.

statusenumRequired

The status of the subsidiary

One ofactive or inactive.
currency_codestringnullableRequired

The ISO 4217 currency code of the subsidiary.

namestringnullableRequired

The name of the subsidiary.

updated_atstringnullableRequired

The ISO 8601 timestamp that the subsidiary was last updated.

last_synced_atstringRequired

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

Endpoints
GET
/accounting/subsidiaries
GET
/accounting/subsidiaries/:id

List Subsidiaries

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringquery

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

    expandenumquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumquery

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

    One oftrue or false.
    last_synced_at_minintegerquery

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

    limitintegerquery

    The limit on the number of entities returned.

    sortstringquery

    The 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_maxintegerquery

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

    updated_at_minintegerquery

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

Response Body

    connectionobjectRequired
    Show connection attributes
    subsidiariesarrayRequired
    Show subsidiaries attributes
    next_cursorstringnullable
Support by integration
  • Netsuite
    Netsuite
Example Response Body
JSON
1
{


2
  "connection": {


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


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


5
    "platform": "NETSUITE"


6
  },


7
  "subsidiaries": [


8
    {


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


10
      "platform_id": "12345678",


11
      "parent_id": "00000000-0000-0000-0000-000000000000",


12
      "country": "USA",


13
      "status": "active",


14
      "currency_code": "USD",


15
      "name": "Johnson & Johnson LLC",


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


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


18
    }


19
  ],


20
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="


21
}

Fetch a Subsidiary

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

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumquery

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

    One oftrue or false.

Response Body

    connectionobjectRequired
    Show connection attributes
    subsidiaryobjectRequired
    Show subsidiary attributes
Support by integration
  • Netsuite
    Netsuite
Example Response Body
JSON
1
{


2
  "connection": {


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


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


5
    "platform": "NETSUITE"


6
  },


7
  "subsidiary": {


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


9
    "platform_id": "12345678",


10
    "parent_id": "00000000-0000-0000-0000-000000000000",


11
    "country": "USA",


12
    "status": "active",


13
    "currency_code": "USD",


14
    "name": "Johnson & Johnson LLC",


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


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


17
  }


18
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Tax Rates