Paginación
Parámetros de orden y límite, el envelope { data, next_cursor } y cómo iterar listados grandes sin sorpresas.
Los endpoints de listado (GET /api/v1/dtes, GET /api/v1/bhe) devuelven un envelope consistente con los resultados y un cursor de continuación:
Parámetros
| Query param | Default | Rango | Descripción |
|---|---|---|---|
limit | 20 | 1–100 | Cantidad máxima de resultados por página |
cursor | — | token opaco | next_cursor de la página anterior |
sort | created_at | folio · monto_total · fecha_emision · sii_status · created_at | Columna de orden |
dir | desc | asc · desc | Dirección del orden |
Valores fuera de rango no fallan: limit se ajusta al rango y un sort/dir no reconocido cae al default. Un cursor mal formado sí falla, con 422: ignorarlo devolvería la primera página otra vez y un bucle de paginación no tendría cómo notar que volvió al principio.
GET /dtes acepta además filtros de estado y fecha, ver Referencia API de DTEs.
Cursor (next_cursor)
La paginación es cursor-based (keyset). Una respuesta que no agota el listado trae el token de continuación en next_cursor; lo pasas tal cual en la siguiente request como ?cursor=<token>. Iteras mientras next_cursor no sea null.
Primera página:
Siguiente, con el token de la anterior y el mismo sort/dir:
El token es opaco: no lo construyas, no lo modifiques y no supongas nada de su contenido. Dos reglas que sí importan:
- No cambies
sortnidira mitad del recorrido. El cursor recuerda con qué orden se emitió; usarlo con otro devuelve422 dte.list.cursor_invalidoen vez de saltarse filas en silencio. - El orden es estable aunque haya empates. Dos documentos con el mismo monto o la misma fecha no se repiten ni se pierden entre páginas.
Alcance
GET /api/v1/dtes ya pagina por cursor. El resto de los listados devuelve el mismo envelope con next_cursor: null mientras se les habilita; el shape { data, next_cursor } es estable, así que el mismo bucle sirve para todos.
Próximos pasos
- Referencia API de DTEs: el detalle de cada endpoint de consulta, PDF y XML.
- Límites de tasa: cuánto puedes iterar antes de toparte con el
429. - Catálogo de errores: los códigos que pueden devolver los listados.
Última actualización