--- title: 4.6. Listar Lotes (Paginado) url: https://docs.vehub.com.br/API/Integra%C3%A7%C3%A3o%20FIDC/4.%20Consultas/4.6.%20Listar%20Lotes%20%28Paginado%29/ --- | Método | URL | |--------|-----| | ![GET](https://img.shields.io/badge/GET-blue) | `https://BASE_URL/public/v1/recebiveis/lotes` | Lista lotes de forma **paginada**, com filtros opcionais por cedente, ocorrência, status e intervalo de data. O retorno usa o envelope padrão de paginação (`RetornoPaginado`) e cada item em `registros[]` segue o **mesmo modelo** (`DetalhesLoteDto`) da consulta [Consultar Lote](4.1.%20Consultar%20Lote.md). > A ordenação padrão é por data (mais recente primeiro): considera a data de aquisição quando preenchida, senão a data de registro. Os resultados respeitam o RLS e ficam restritos ao grupo econômico do token informado no header `GrupoEconomico`. ## Query Params Todos os parâmetros são **opcionais**. A paginação possui valores padrão. | Parâmetro | Tipo | Descrição | |-----------|------|-----------| | `idEmpresa` | Número (long) | Filtra por cedente (identificador da empresa). | | `ocorrencia` | Número | Valor numérico do enum de ocorrência (igualdade exata). Ver [Ocorrência de Lote](../6.%20Enumerações/6.1.%20Enumerações%20Públicas.md#ocorrencia-de-lote). | | `status` | Texto (CSV) | Filtro `IN` — lista de valores separados por vírgula (ex.: `?status=9,10`). Valores numéricos do enum de status. Ver [Status de Lote](../6.%20Enumerações/6.1.%20Enumerações%20Públicas.md#status-de-lote). | | `dataInicio` | Texto (date) | Início do intervalo de data (inclusivo). Formato `YYYY-MM-DD`. Aplicado sobre o *coalesce* entre data de aquisição e data de registro (usa a data de aquisição quando preenchida; senão a data de registro). | | `dataFim` | Texto (date) | Fim do intervalo de data (inclusivo). Formato `YYYY-MM-DD`. Mesma regra de *coalesce* de `dataInicio`. | | `indicePagina` | Número (int) | Página (base 1). Padrão `1`. | | `tamanhoDaPagina` | Número (int) | Tamanho da página. Padrão `20`. Máximo `9000`. | > Query parameters são **case-insensitive** (`indicePagina` ou `IndicePagina` funcionam). ## Request ```` text title="Exemplo de querystring" GET https://BASE_URL/public/v1/recebiveis/lotes?idEmpresa=4&status=4,9&dataInicio=2024-11-01&dataFim=2024-12-31&indicePagina=1&tamanhoDaPagina=20 ```` ## Response A resposta retorna o envelope `RetornoPaginado`. Cada item de `registros[]` tem o **mesmo formato** do retorno da consulta por id — ver [Consultar Lote](4.1.%20Consultar%20Lote.md) para o detalhamento completo dos campos do lote. ```` json title="Response Body — 200 OK" { "registros": [ { "id": 987, "idLote": 987, "idOcorrencia": 1, "ocorrencia": "Cessão", "idEmpresa": 4, "empresa": "Empresa Exemplo LTDA", "percentualDesagio": 2.5, "valorNominalTotal": 44632.5, "valorAquisicaoTotal": 39866.62, "valorDescontoTotal": 4765.88, "valorPagoTotal": 0, "quantidadeTitulos": 5, "quantidadeLiquidacoes": 0, "idStatus": 4, "status": "Aguardando Envio", "erros": [] } ], "paginacao": { "paginaAtual": 1, "paginaTotal": 1, "paginaQuantidadeRegistro": 20, "quantidadeRegistros": 1, "temPaginaAnterior": false, "temProximaPagina": false }, "mensagem": null } ```` # Modelo de dados ## Envelope de paginação | Campo | Tipo | Descrição | |-------|------|-----------| | `registros` | Lista | Itens da página. Cada item é um `DetalhesLoteDto` — ver [Consultar Lote](4.1.%20Consultar%20Lote.md#modelo-de-dados). | | `paginacao` | Objeto | Metadados de paginação. Ver abaixo. | | `mensagem` | Texto | Mensagem opcional acompanhando o retorno. `null` quando não há mensagem. | ### Paginação | Campo | Tipo | Descrição | |-------|------|-----------| | `paginaAtual` | Número | Página atual (base 1). | | `paginaTotal` | Número | Quantidade total de páginas. | | `paginaQuantidadeRegistro` | Número | Tamanho da página aplicado. | | `quantidadeRegistros` | Número | Quantidade total de registros encontrados. | | `temPaginaAnterior` | Booleano | Indica se existe página anterior. | | `temProximaPagina` | Booleano | Indica se existe próxima página. | ## Registro — `DetalhesLoteDto` Cada item de `registros[]` é o mesmo modelo retornado pela consulta por id. Consulte [Consultar Lote](4.1.%20Consultar%20Lote.md#modelo-de-dados) para a descrição de cada campo (`id`, `idLote`, `idOcorrencia`, `ocorrencia`, `idEmpresa`, `empresa`, `percentualDesagio`, `valorNominalTotal`, `valorAquisicaoTotal`, `valorDescontoTotal`, `valorPagoTotal`, `quantidadeTitulos`, `quantidadeLiquidacoes`, `idStatus`, `status`, `erros`), bem como as tabelas de [Ocorrências](4.1.%20Consultar%20Lote.md#ocorrencias) e [Status](4.1.%20Consultar%20Lote.md#status).