Ir para o conteúdo

5.12. Histórico e Comentários

Gerencia o histórico de interações e comentários de uma Nota Comercial. Permite adicionar observações e acompanhar o registro cronológico de eventos.

Listar Histórico

🔗 Endpoint

Método URL
GET /public/v1/nota-comercial/{id}/historico

🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único da NC

🧪 Exemplo de cURL

curl -X GET https://api.vehub.com.br/public/v1/nota-comercial/100/historico \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

[
  {
    "id": 1,
    "data": "2025-10-01",
    "tipo": 1,
    "usuario": "joao.silva@empresaemissora.com.br",
    "descricao": "Nota Comercial criada."
  },
  {
    "id": 2,
    "data": "2025-10-02",
    "tipo": 2,
    "usuario": "maria.souza@financiadora.com.br",
    "descricao": "Documentação analisada. Aguardando parecer do escriturador."
  },
  {
    "id": 3,
    "data": "2025-10-03",
    "tipo": 3,
    "usuario": "operador@parceiro.com.br",
    "descricao": "Verificar validade do contrato social enviado."
  }
]

Detalhamento dos Campos

Campo Tipo Descrição
id integer Identificador único da interação
data string Data do registro (YYYY-MM-DD)
tipo integer 1 = Evento do sistema, 2 = Ação do usuário, 3 = Comentário
usuario string E-mail ou identificador do responsável pelo registro
descricao string Texto da interação ou comentário

Adicionar Comentário

🔗 Endpoint

Método URL
POST /public/v1/nota-comercial/{id}/historico

🧾 Descrição

Adiciona um comentário ao histórico da NC. Útil para registrar observações, pendências ou comunicações relevantes para a operação.

🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único da NC

📋 Payload (JSON)

{
  "descricao": "Solicitando revisão dos documentos de garantia enviados."
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
descricao string Sim Texto do comentário (máx. 2000 caracteres)

🧪 Exemplo de cURL

curl -X POST https://api.vehub.com.br/public/v1/nota-comercial/100/historico \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{ "descricao": "Solicitando revisão dos documentos de garantia enviados." }'

📥 Response — 201 Created

{
  "mensagem": "Comentário adicionado com sucesso.",
  "id": 4
}

❌ Erros Comuns

400 Bad Request

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Campo 'descricao' é obrigatório.",
    "O comentário excede o limite de 2000 caracteres."
  ]
}

404 Not Found

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "titulo": "Não encontrado",
  "status": 404,
  "erros": ["Nota Comercial não encontrada."]
}