RIrillet
Subsidiaries

Retrieves a subsidiary

Changed on

Returns one subsidiary from your organization. Returns 404 if it does not exist or you cannot access it. Use GET /subsidiaries to find a 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, the response includes parent_subsidiary_id. This is the direct parent's ID, or null if there is no parent. The parent ID is included even if you cannot access the parent. If either feature is disabled, parent_subsidiary_id is omitted.

get/subsidiaries/{subsidiary_id}

Request

Path parameters

subsidiary_idstring required

UUID of the subsidiary to retrieve (must belong to the organization).

Response

OK

idstring uuid required
currencystring required

Currency code following ISO-4217

timezonestring required
trade_namestring required
legal_namestring

Registered legal name of the entity, as set in Settings → Subsidiary Details. Returned for LEGAL_ENTITY subsidiaries; omitted for ELIMINATION subsidiaries.

tax_idstring

Tax identification number of the entity (for example a US EIN or a VAT number), exactly as entered in the app. Omitted when none is set, and for ELIMINATION subsidiaries.

type'LEGAL_ENTITY' | 'ELIMINATION' required
parent_subsidiary_idstring uuid nullable

A UUID, or null to explicitly select nothing. Omitting the field is not the same as sending null.

Example response

{
  "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