ReadMe_CompanyV2Response

Empresa retornada pela API v2

companyIdstring<uuid>

Identificador da empresa

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

companyTaxIdstring

CPF ou CNPJ da empresa

Exemplo 12345678000195

companyNamestring

Nome da empresa

Exemplo Empresa Teste v2

statusstring

Status da empresa

Valores possíveis: [ACTIVE, INACTIVE]

Exemplo ACTIVE

scheduleStatusstring

Status da agenda da empresa

Valores possíveis: [ACTIVE, INACTIVE, PERFORMED, PENDING, SENT]

Exemplo PENDING

createdAtstring<date-time>

Data de criação em UTC

Exemplo 2026-04-17T12:30:00Z

updatedAtstring<date-time>aceita valor nulo

Data de atualização em UTC

Exemplo 2026-04-17T13:45:00Z

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_CompanyV2Response

{
  "companyId": "64091b0a-529d-48fc-9802-7b1600a07c8b",
  "companyTaxId": "12345678000195",
  "companyName": "Empresa Teste v2",
  "status": "ACTIVE",
  "scheduleStatus": "PENDING",
  "createdAt": "2026-04-17T12:30:00Z",
  "updatedAt": "2026-04-17T13:45:00Z",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}