Pular para o conteúdo principal

Paginação

Endpoints de listagem retornam resultados paginados para manter as respostas previsíveis mesmo em contas com grande volume.

O padrão nas rotas de listagem é limite e pagina, e a resposta traz o total do filtro:

GET /v1/notas?tipo=nfe&status=autorizada&limite=50&pagina=2
{
"notas": [ "..." ],
"total": 1287,
"pagina": 2,
"limite": 50
}

Os relatórios por data usam por_pagina e pagina, e devolvem também paginas.

Os limites exatos estão na Referência

Tamanho padrão, máximo por página e nomes dos parâmetros de cada rota vivem no OpenAPI. Eles não são iguais em todas as rotas, e copiá-los aqui criaria uma segunda verdade.

Evite varrer o histórico

Listar tudo para achar um documento é o caminho mais caro

Se você tem o job_id, a referencia_externa, a chave de acesso ou os atributos da operação, use a busca direcionada.

Você temUse
job_idGET /v1/nfe/consultar/{job_id}
vários job_idPOST /v1/jobs/consultar-lote (até 200)
referencia_externaGET /v1/jobs/localizar?ref=...
chave de acessoGET /v1/notas/{chave}
só atributos de negócioGET /v1/jobs/localizar com emitente, valor, período