ReadMe_CreateCompaniesResponse

Resultado da criação de empresas

companyGroupIdstring<uuid>aceita valor nulo

Identificador do grupo econômico associado

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

companies object[]

Resultados por empresa processada

Lista [

companyIdstring<uuid>aceita valor nulo

Identificador da empresa criada

Exemplo 64091b0a-529d-48fc-9802-7b1600a07c8b

companyTaxIdstring

CPF ou CNPJ da empresa

Exemplo 12345678000195

statusstring

Status do processamento do item

Exemplo CREATED

errorstringaceita valor nulo

Mensagem de erro quando o item falha

Exemplo Empresa já cadastrada

]

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_CreateCompaniesResponse

{
  "companyGroupId": "90c6c8a2-3a14-4600-a295-9cda95640fba",
  "companies": [
    {
      "companyId": "64091b0a-529d-48fc-9802-7b1600a07c8b",
      "companyTaxId": "12345678000195",
      "status": "CREATED",
      "error": "Empresa já cadastrada"
    }
  ],
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}