curl --request GET \
--url https://product-api.thedatacity.com/api/v2/companies/{companyNumber}/group-structure \
--header 'Authorization: Bearer <token>'[
{
"CanBeConsolidated": true,
"ConsolidatedAccountsCompanyName": "<string>",
"ConsolidatedAccountsCompanyNumber": "<string>",
"IsLikelyDistinctBrand": true,
"IsSubGroup": true,
"ParentCompanyName": "<string>",
"ParentCompanyNumber": "<string>",
"SubsidiaryCompanyLevel": 123,
"SubsidiaryCompanyName": "<string>",
"SubsidiaryCompanyNumber": "<string>",
"SubsidiaryCompanyWebsite": "<string>",
"TypeOfAccounts": "<string>",
"UltimateParentCompanyName": "<string>",
"UltimateParentCompanyNumber": "<string>"
}
]Get company group structure
Group structure (parent / subsidiary rows) for a company.
curl --request GET \
--url https://product-api.thedatacity.com/api/v2/companies/{companyNumber}/group-structure \
--header 'Authorization: Bearer <token>'[
{
"CanBeConsolidated": true,
"ConsolidatedAccountsCompanyName": "<string>",
"ConsolidatedAccountsCompanyNumber": "<string>",
"IsLikelyDistinctBrand": true,
"IsSubGroup": true,
"ParentCompanyName": "<string>",
"ParentCompanyNumber": "<string>",
"SubsidiaryCompanyLevel": 123,
"SubsidiaryCompanyName": "<string>",
"SubsidiaryCompanyNumber": "<string>",
"SubsidiaryCompanyWebsite": "<string>",
"TypeOfAccounts": "<string>",
"UltimateParentCompanyName": "<string>",
"UltimateParentCompanyNumber": "<string>"
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Companies House company number.
Response
Group structure rows from the product API (data dictionary GroupStructureDetails).
Indicates whether the subsidiary company can be consolidated into the parent company's financial statements.
The name of the company whose accounts are consolidated with the subsidiary. There can be multiple consolidated accounts company names if the subsidiary's accounts are consolidated with more than one other company.
The Company Number of the company whose accounts are consolidated with the subsidiary. There can be multiple consolidated accounts company numbers if the subsidiary's accounts are consolidated with more than one other company.
Indicates whether the subsidiary is likely to be a distinct brand within the parent company's group structure.
Indicates whether the subsidiary is part of a sub-group within the parent company's group structure.
The name of the parent company directly above the subsidiary in the group structure.
The Company Number of the parent company directly above the subsidiary in the group structure.
The level at which the subsidiary company operates within the group structure. Level 0 is the ultimate parent company.
The name of the subsidiary company.
The Company Number of the subsidiary.
The website of the subsidiary company.
The type of accounts filed by the subsidiary company, which can indicate its financial reporting requirements and potential consolidation status.
The name of the ultimate parent company in the group structure.
The Company Number of the ultimate parent company in the group structure.