Skip to main content

Company Group Detail

Overview​

The company_group_detail module links a company into a company group. This module depends on company_group. The referenced group_company_id must already exist, so the corresponding company group must be synchronized first.

Request​

  • Method: POST
  • Path: {{base_url}}/api/sync-master-data

Request Envelope​

The Company Group Detail module uses the standard Open API request envelope with company_group_detail as the module and an array of company group detail objects as data.

{
  "module": "company_group_detail",
  "data": [
    {}
  ],
  "chunk_metadata": {}
}

Request Body Fields​

FieldTypeRequiredDescriptionExample
idstringYesCompany group detail identifier.GRPDET-01
group_company_idstringYesMust match an id already sent via company_group.GRP-01
company_idstringYesIdentifier of the company linked to the group.HTL-001

Request Example​

{
  "module": "company_group_detail",
  "data": [
    {
      "id": "GRPDET-01",
      "group_company_id": "GRP-01",
      "company_id": "HTL-001"
    }
  ],
  "chunk_metadata": {
    "process_id": "sync-htl001-2026-08-30",
    "chunk_sequence": 1,
    "is_last_chunk": true,
    "total_records_in_chunk": 1
  }
}