--- title: 2.1. Enumerações url: https://docs.vehub.com.br/API/Nota%20Comercial/2.%20Enumera%C3%A7%C3%B5es/2.1.%20Enumera%C3%A7%C3%B5es/ --- # 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: ```json [ { "id": 1, "nome": "Descrição" } ] ``` | Enumerador | Endpoint | |------------|----------| | Base de Cálculo | `GET /public/v1/enumeracoes/base-calculo` | | Índice | `GET /public/v1/enumeracoes/indice` | | Indexador | `GET /public/v1/enumeracoes/indexador` | | Tabela de Cálculo | `GET /public/v1/enumeracoes/tabela-calculo` | | Tipo de Capitalização | `GET /public/v1/enumeracoes/tipo-capitalizacao` | | Tipo de Garantia | `GET /public/v1/enumeracoes/tipo-garantia` | | Tipo de Documento | `GET /public/v1/enumeracoes/tipo-documento` | | Tipo de Assinatura | `GET /public/v1/enumeracoes/tipo-assinatura` | | UF | `GET /public/v1/enumeracoes/uf` | | Ramo de Atividade | `GET /public/v1/enumeracoes/ramo-atividade` | ### Exemplo de cURL ```bash 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` ```json [ { "id": 1, "nome": "IPCA" }, { "id": 2, "nome": "CDI" }, { "id": 3, "nome": "CDI+" }, { "id": 4, "nome": "IGPM" } ] ``` --- ## Enumeradores Estáticos ### Indexador | Código | Descrição | |--------|-----------| | `1` | IPCA | | `2` | CDI | | `3` | CDI+ | | `4` | IGPM | > Utilizado no campo `idIndexador`. Obrigatório quando `idIndice` = `2` (Pós-fixado). --- ### Índice (Tipo de Taxa) | Código | Descrição | |--------|-----------| | `1` | Pré-fixado | | `2` | Pós-fixado | > Utilizado no campo `idIndice`. Quando `Pré-fixado`, o campo `idIndexador` não é necessário. --- ### Tabela de Cálculo | Código | Descrição | |--------|-----------| | `1` | PRICE | | `2` | SAC | > Utilizado no campo `idTabelaCalculo`. --- ### Base de Cálculo | Código | Descrição | |--------|-----------| | `1` | Dias úteis — 252 dias | | `2` | Dias corridos — 360 dias | | `3` | Dias corridos — 365 dias | > Utilizado no campo `idBaseCalculo`. --- ### Periodicidade | Código | Descrição | |--------|-----------| | `1` | Mensal | | `2` | Quinzenal | | `3` | Semanal | | `4` | Anual | | `5` | Diária | | `6` | Dias úteis | > Utilizado nos campos `periodicidade` e `periodicidadeTaxa`. --- ### Tipo de Capitalização | Código | Descrição | |--------|-----------| | `1` | Diária | | `2` | Mensal | > Utilizado no campo `capitalizacao`. --- ### Valor de Partida | Código | Descrição | |--------|-----------| | `1` | Valor Líquido | | `2` | Valor Bruto | > Utilizado no campo `valorPartida`. Define se o `valorSolicitado` representa o valor líquido ou bruto da operação. --- ### Status da Nota Comercial | Código | Descrição | |--------|-----------| | `1` | Em Digitação | | `2` | Enviado para Análise | | `3` | Em Análise | | `4` | Aprovado pelo Escriturador | | `5` | Aguardando Assinaturas | | `6` | Finalizado | | `7` | Cancelado | | `8` | Rejeitado | --- ### Status da Parcela | Código | Descrição | |--------|-----------| | `1` | Em Aberto | | `2` | Pago | | `3` | Vencido | | `4` | Em Processo de Antecipação | | `5` | Vencido (Não Pago) | | `6` | Cancelado | --- ### Status de Habilitação no Escriturador | Código | Descrição | |--------|-----------| | `1` | Em Avaliação | | `2` | Reprovado | | `3` | Aprovado | > Apenas emitentes com status `Aprovado` podem emitir Notas Comerciais. --- ### Tipo de Garantia | Código | Descrição | |--------|-----------| | `1` | Cessão Fiduciária | | `2` | Alienação Fiduciária | | `3` | Hipoteca | | `4` | Fiador — Pessoa Física | | `5` | Fiador — Pessoa Jurídica | | `6` | Estoque ou Maquinário | | `7` | Outros | | `8` | Recebíveis |