Ir para o conteúdo

5.7. Resumo e Envio para Aprovação

Consultar Resumo da NC

🔗 Endpoint

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

🧾 Descrição

Retorna o resumo completo de uma Nota Comercial: dados financeiros, partes envolvidas, garantias, assinantes e documentos.

🔹 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 \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

{
  "id": 100,
  "status": 1,
  "descricaoStatus": "Em Digitação",
  "numeroEmissao": 3,
  "numeroSerie": "A",
  "financiador": {
    "id": 3,
    "nome": "Financiadora Alpha S.A.",
    "documento": "12345678000199"
  },
  "emitente": {
    "id": 42,
    "nome": "Empresa Emissora LTDA",
    "documento": "98765432000155",
    "email": "financeiro@empresaemissora.com.br",
    "telefone": "11999990000"
  },
  "simulacao": {
    "dataEmissao": "2025-10-01",
    "dataPrimeiraParcela": "2025-11-01",
    "periodicidade": 1,
    "capitalizacao": 2,
    "valor": 500000.00,
    "quantidadeParcela": 12,
    "idBaseCalculo": 1,
    "idIndice": 1,
    "idTabelaCalculo": 1,
    "taxa": 1.25,
    "intervaloAmortizacao": 1
  },
  "totais": {
    "valorLiquido": 500000.00,
    "valorBruto": 515000.00,
    "taxa": 1.25,
    "custoEmissao": 15000.00,
    "jurosTotal": 38745.50,
    "quantidadeParcelas": 12,
    "cet": 1.52,
    "valorParcela": 44753.62
  },
  "garantias": [
    {
      "id": 5,
      "idTipoGarantia": 1,
      "tipoGarantia": "Cessão Fiduciária",
      "descricao": "Cessão fiduciária de recebíveis"
    }
  ],
  "assinantes": [
    {
      "id": 10,
      "nome": "João da Silva",
      "documento": "12345678901",
      "email": "joao.silva@empresaemissora.com.br",
      "telefone": "11988880000",
      "origem": "Emitente"
    }
  ]
}

Detalhamento dos Campos — totais

Campo Tipo Descrição
valorLiquido number Valor líquido liberado ao emitente
valorBruto number Valor bruto financiado
taxa number Taxa de juros no período
custoEmissao number Custo total de emissão e escrituração
jurosTotal number Total de juros da operação
quantidadeParcelas integer Quantidade de parcelas
cet number Custo Efetivo Total (%)
valorParcela number Valor médio das parcelas

Enviar para Aprovação

🔗 Endpoint

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

🧾 Descrição

Envia a Nota Comercial para análise e aprovação pelo escriturador. Após o envio, o status muda para Enviado para Análise (2).

Pré-requisitos para envio: - Status atual: Em Digitação (1) - Garantias e minutas configuradas - Assinantes vinculados

🔹 Path Parameter

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

🧪 Exemplo de cURL

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

📥 Response — 200 OK

{
  "mensagem": "Nota Comercial enviada para análise com sucesso.",
  "status": 2,
  "descricaoStatus": "Enviado para Análise"
}

❌ Erros Comuns

400 Bad Request

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "A Nota Comercial não está em status que permita envio para análise.",
    "A operação não possui assinantes cadastrados.",
    "A operação não possui garantias vinculadas."
  ]
}

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."]
}