Ir para o conteúdo

5.3. Criar Nota Comercial com Dados da Simulação

🔗 Endpoint

Método URL
POST /public/v1/nota-comercial

🧾 Descrição

Cria uma nova Nota Comercial utilizando os parâmetros retornados por uma simulação prévia (endpoints 5.1 ou 5.2). O financiador e o emitente são obrigatórios.

O emitente informado deve estar com status Aprovado no escriturador escolhido para a operação.

A NC criada ficará com status Em Digitação (1) até ser enviada para aprovação.

📤 Requisição

📋 Payload (JSON)

{
  "idEmitente": 42,
  "idFinanciador": 3,
  "idEsteira": 10,
  "dataEmissao": "2025-10-01",
  "dataPrimeiraParcela": "2025-11-01",
  "valorSolicitado": 500000.00,
  "valorPartida": 1,
  "idIndice": 1,
  "idTabelaCalculo": 1,
  "idBaseCalculo": 1,
  "taxa": 1.25,
  "periodicidade": 1,
  "quantidadeParcelas": 12,
  "capitalizacao": 2,
  "intervaloAmortizacao": 1,
  "idIndexador": null,
  "percentualIndexador": null,
  "carenciaPrincipal": 0,
  "periodicidadeTaxa": 1,
  "valorSeguro": null,
  "valorGravame": null
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
idEmitente integer Sim ID do emitente (deve estar aprovado no escriturador)
idFinanciador integer Sim ID do financiador
idEsteira integer Sim ID da esteira a utilizar (ver 3.3. Esteiras)
dataEmissao string Sim Data de emissão (YYYY-MM-DD)
dataPrimeiraParcela string Sim Data da 1ª parcela (YYYY-MM-DD)
valorSolicitado number Sim Valor da operação
valorPartida integer Sim 1 = Valor Líquido, 2 = Valor Bruto
idIndice integer Sim 1 = Pré-fixado, 2 = Pós-fixado
idTabelaCalculo integer Sim 1 = PRICE, 2 = SAC
idBaseCalculo integer Sim Base de cálculo (ver Enumerações)
taxa number Sim Taxa de juros no período
periodicidade integer Sim Periodicidade das parcelas (ver Enumerações)
quantidadeParcelas integer Sim Número total de parcelas
capitalizacao integer Sim 1 = Diária, 2 = Mensal
intervaloAmortizacao integer Sim Intervalo de amortização em períodos
idIndexador integer Não Obrigatório quando idIndice = 2
percentualIndexador number Não Percentual sobre o indexador (ex: 100 = 100% do CDI)
carenciaPrincipal integer Não Carência em dias (padrão: 0)
periodicidadeTaxa integer Não Periodicidade da taxa de juros
valorSeguro number Não Custo de seguro
valorGravame number Não Custo de gravame

🧪 Exemplo de cURL

curl -X POST https://api.vehub.com.br/public/v1/nota-comercial \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{
    "idEmitente": 42,
    "idFinanciador": 3,
    "idEsteira": 10,
    "dataEmissao": "2025-10-01",
    "dataPrimeiraParcela": "2025-11-01",
    "valorSolicitado": 500000.00,
    "valorPartida": 1,
    "idIndice": 1,
    "idTabelaCalculo": 1,
    "idBaseCalculo": 1,
    "taxa": 1.25,
    "periodicidade": 1,
    "quantidadeParcelas": 12,
    "capitalizacao": 2,
    "intervaloAmortizacao": 1,
    "carenciaPrincipal": 0
  }'

📥 Responses

✅ 201 Created

{
  "mensagem": "Nota Comercial criada com sucesso.",
  "id": 100,
  "status": 1,
  "descricaoStatus": "Em Digitação"
}
Campo Tipo Descrição
mensagem string Confirmação da operação
id integer ID da NC criada
status integer Status atual da NC
descricaoStatus string Descrição do status

❌ 400 Bad Request

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Campo 'idEmitente' é obrigatório.",
    "Campo 'idFinanciador' é obrigatório.",
    "O emitente informado não está aprovado em nenhum escriturador."
  ]
}