2.1. Enumerações¶

Esta seção descreve todos os enumeradores utilizados no fluxo de Nota Comercial. Parte dos enumeradores possui endpoints dinâmicos (retornados pela API). Outros são valores estáticos documentados abaixo.

Enumeradores com Endpoint Dinâmico¶

Os endpoints a seguir retornam listas no formato:

[
  { "id": 1, "nome": "Descrição" }
]

Exemplo de cURL¶

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

Exemplo de Resposta — 200 OK¶

[
  { "id": 1, "nome": "IPCA" },
  { "id": 2, "nome": "CDI" },
  { "id": 3, "nome": "CDI+" },
  { "id": 4, "nome": "IGPM" }
]

Enumeradores Estáticos¶

Indexador¶

Utilizado no campo idIndexador. Obrigatório quando idIndice = 2 (Pós-fixado).

Índice (Tipo de Taxa)¶

Utilizado no campo idIndice. Quando Pré-fixado, o campo idIndexador não é necessário.

Tabela de Cálculo¶

Utilizado no campo idTabelaCalculo.

Base de Cálculo¶

Utilizado no campo idBaseCalculo.

Periodicidade¶

Utilizado nos campos periodicidade e periodicidadeTaxa.

Tipo de Capitalização¶

Utilizado no campo capitalizacao.

Valor de Partida¶

Utilizado no campo valorPartida. Define se o valorSolicitado representa o valor líquido ou bruto da operação.

Status da Nota Comercial¶

Status da Parcela¶

Status de Habilitação no Escriturador¶

Apenas emitentes com status Aprovado podem emitir Notas Comerciais.

Tipo de Garantia¶