Subsidiaries

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.

created_atstringfilterablenullable

The ISO 8601 timestamp that the subsidiary was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the subsidiary was last updated.

last_synced_atstringfilterable

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.

    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

    Used 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.

    sortstringqueryOptional

    Used 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.

    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

    subsidiariesarray
    Show subsidiaries attributes
    next_cursorstringnullableOptional
    connectionobject
    Show connection attributes
Support by integration
  • NetSuite
    NetSuite
Example Response Body
JSON
1
{


2
  "subsidiaries": [


3
    {


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


5
      "platform_id": "12345678",


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


7
      "country": "USA",


8
      "status": "active",


9
      "currency_code": "USD",


10
      "name": "Johnson & Johnson LLC",


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


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


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


14
    }


15
  ],


16
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


17
  "connection": {


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


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


20
    "platform": "NETSUITE"


21
  }


22
}

Fetch a Subsidiary

GEThttps://production.rutterapi.com/versioned/accounting/subsidiaries/: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 supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    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

    subsidiaryobject
    Show subsidiary attributes
    connectionobject
    Show connection attributes
Support by integration
  • NetSuite
    NetSuite
Example Response Body
JSON
1
{


2
  "subsidiary": {


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


4
    "platform_id": "12345678",


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


6
    "country": "USA",


7
    "status": "active",


8
    "currency_code": "USD",


9
    "name": "Johnson & Johnson LLC",


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
  },


14
  "connection": {


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


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


17
    "platform": "NETSUITE"


18
  }


19
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Tax Rates