Pular para o conteúdo principal

ReadMe_CompanyGroupResponse

Dados de um grupo econômico

groupIdstring

ID do grupo econômico

Exemplo 90c6c8a2-3a14-4600-a295-9cda95640fba
groupNamestring

Nome do grupo

Exemplo grupo-econômico-001
externalGroupIdstring

ID externo do grupo

Exemplo group-id-001
createdAtstring<date-time>

Data de criação

Exemplo 2025-07-01T17:45:00Z
associatedCompanies object[]

Empresas associadas ao grupo

  • Lista [
    • companyIdstring

    ID da empresa

    Exemplo 90c6c8a2-3a14-4600-a295-9cda95640fba
  • ]
    • links object[]

    Links de navegação da API

  • Lista [
    • relstring

    Relação do link com o recurso atual

    Exemplo self
    methodstring

    Método HTTP do link

    Exemplo GET
    hrefstring

    Caminho relativo do recurso

    Exemplo /api/v2/companies
    descriptionstring

    Explicação em português do que este link permite fazer

    Exemplo Cadastre a empresa para o cliente
  • ]
    • ReadMe_CompanyGroupResponse
    {
      "groupId": "90c6c8a2-3a14-4600-a295-9cda95640fba",
      "groupName": "grupo-econômico-001",
      "externalGroupId": "group-id-001",
      "createdAt": "2025-07-01T17:45:00Z",
      "associatedCompanies": [
        {
          "companyId": "90c6c8a2-3a14-4600-a295-9cda95640fba"
        }
      ],
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "/api/v2/companies",
          "description": "Cadastre a empresa para o cliente"
        }
      ]
    }