RIrillet
Subsidiaries

Lists all subsidiaries

Changed on

Returns legal-entity and elimination subsidiaries for your organization, limited by your access permissions. Each subsidiary includes its ID, currency, and timezone. Use its ID with endpoints that require subsidiary_id. Legal entity subsidiaries also include legal_name, address and tax_id, as shown in Settings → Subsidiary Details.

When the hierarchy feature and hierarchy API support are both enabled for your organization:

  • Each subsidiary includes parent_subsidiary_id: its direct parent's ID, or null if it has no parent.
  • The response includes root_subsidiary_id: the ID of the configured hierarchy root. The root can differ from the default subsidiary.

Otherwise, both fields are omitted. Parent and root IDs are included even if you cannot access those subsidiaries. The root ID is included even when the list is empty. Use a token with access to all subsidiaries to read the complete hierarchy.

get/subsidiaries

Request

Response

OK

root_subsidiary_idstring uuid

ID of the configured hierarchy root. The root can differ from the default subsidiary. Included even if you cannot access the root or the subsidiary list is empty. Omitted unless the hierarchy feature and hierarchy API support are both enabled for your organization.

Example response

{
  "subsidiaries": [
    {
      "currency": "USD",
      "timezone": "America/New_York",
      "trade_name": "Rillet Inc.",
      "legal_name": "Rillet Incorporated",
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      },
      "tax_id": "12-3456789"
    }
  ]
}

Changes

  • c393d0102005Revision changes
    • warning

      added the new ELIMINATION enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status