Listar series
GET /api/series
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Lista las series ordenadas por establecimiento y tipo de documento.
Quién puede usarlo: solo usuarios de tipo administrador (type = admin). Con el token de un vendedor responde 403.
Paginación por cursor: envía limit (1 a 100, por defecto 15). La respuesta trae pagination.next_cursor; para la página siguiente repite la misma consulta agregando cursor=<next_cursor>. Cuando pagination.has_more es false no hay más páginas.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
establishment_id |
query | no | 1 |
Filtra por establecimiento (id numérico). |
document_type_id |
query | no | 01 |
Filtra por tipo de documento (01, 03, 80...). |
limit |
query | no | 15 |
Registros por página, de 1 a 100. Por defecto 15. |
cursor |
query | no | Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente. |
Respuestas
200 — Listado
{
"success": true,
"data": [
{
"id": 12,
"establishment_id": 1,
"document_type_id": "01",
"number": "F002",
"contingency": false,
"dedicated": false,
"in_use": false,
"series_device_group_id": null,
"group_name": null,
"category": "invoice",
"document_type_description": "Factura electrónica",
"correlative": 150
},
{
"id": 13,
"establishment_id": 1,
"document_type_id": "03",
"number": "B002",
"contingency": false,
"dedicated": false,
"in_use": false,
"series_device_group_id": null,
"group_name": null,
"category": "ticket",
"document_type_description": "Boleta de venta electrónica",
"correlative": 0
}
],
"pagination": {
"next_cursor": null,
"has_more": false
}
}
403 — Usuario no administrador
{
"success": false,
"message": "Solo un administrador puede gestionar este recurso."
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.