--- title: 5.8. Listar Notas Comerciais url: https://docs.vehub.com.br/API/Nota%20Comercial/5.%20Nota%20Comercial/5.8.%20Listar%20Notas%20Comerciais/ --- # 5.8. Listar Notas Comerciais ## 🔗 Endpoint | Método | URL | |--------|-----| | ![GET](https://img.shields.io/badge/GET-green) | `/public/v1/nota-comercial` | --- ## 🧾 Descrição Retorna a lista paginada de Notas Comerciais do grupo econômico. Permite filtrar por emitente, financiador e status. --- ## 📋 Query Parameters | Parâmetro | Tipo | Obrigatório | Descrição | |-----------|------|-------------|-----------| | pagina | integer | Não | Número da página (padrão: `1`) | | quantidade | integer | Não | Registros por página (padrão: `10`, máx: `100`) | | idEmitente | integer | Não | Filtrar por emitente | | idFinanciador | integer | Não | Filtrar por financiador | | idStatus | integer | Não | Filtrar por status (ver Enumerações) | | busca | string | Não | Filtrar por razão social do emitente ou número de emissão | --- ## 🧪 Exemplo de cURL ```bash curl -X GET "https://api.vehub.com.br/public/v1/nota-comercial?pagina=1&quantidade=10&idStatus=6" \ -H "Authorization: Bearer {seu_token}" \ -H "GrupoEconomico: {seu_grupo_economico}" ``` --- ## 📥 Responses ### ✅ 200 OK ```json { "registros": [ { "id": 100, "numeroEmissao": 3, "financiador": "Financiadora Alpha S.A.", "emitente": "Empresa Emissora LTDA", "dataEmissao": "2025-10-01", "valorBruto": 515000.00, "percentualPago": 25.00, "idStatus": 6, "descricaoStatus": "Finalizado", "parcelas": [ { "id": 201, "numero": 1, "dataVencimento": "2025-11-01", "saldoDevedor": 500000.00, "amortizacao": 38503.62, "juros": 6250.00, "valor": 44753.62, "status": 2 } ] } ], "paginacao": { "paginaAtual": 1, "paginaTotal": 5, "paginaQuantidadeRegistro": 10, "quantidadeRegistros": 47, "temProximaPagina": true, "temPaginaAnterior": false } } ``` #### Detalhamento dos Campos — `registros[]` | Campo | Tipo | Descrição | |-------|------|-----------| | id | integer | Identificador único da NC | | numeroEmissao | integer | Número sequencial da emissão | | financiador | string | Nome do financiador | | emitente | string | Nome do emitente | | dataEmissao | string | Data de emissão (YYYY-MM-DD) | | valorBruto | number | Valor bruto da operação | | percentualPago | number | Percentual já liquidado (%) | | idStatus | integer | Código do status atual | | descricaoStatus | string | Descrição do status | | parcelas | array | Resumo das parcelas da NC | #### Detalhamento dos Campos — `parcelas[]` | Campo | Tipo | Descrição | |-------|------|-----------| | id | integer | Identificador único da parcela | | numero | integer | Número sequencial da parcela | | dataVencimento | string | Data de vencimento (YYYY-MM-DD) | | saldoDevedor | number | Saldo devedor no início do período | | amortizacao | number | Valor de amortização do principal | | juros | number | Valor de juros do período | | valor | number | Valor total da parcela | | status | integer | Status da parcela (ver Enumerações — Status da Parcela) |