Solicitar reporte general de productos
POST /api/reports/general-items/export
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Reporte línea por línea de los productos vendidos o comprados (cantidades, precios, cliente/proveedor), en PDF o Excel.
Quién puede usarlo: administradores y vendedores. Si al usuario se le asignaron módulos, necesita el módulo del reporte (Reportes, Inventario o Finanzas, según el caso), igual que en el panel web; si no, responde 403. Un vendedor solo obtiene sus propios comprobantes y movimientos (los que registró o en los que figura como vendedor): el reporte se genera con su usuario aunque envíe filtros de otros.
Formato de respuesta: estándar {success, data, message?} (registro único). Responde 202 Accepted con la fila de la bandeja (data.id, data.status = IN_PROCESS). El archivo se genera en segundo plano: consulta Estado de un reporte y descárgalo con Descargar reporte.
Cuerpo (JSON):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
format |
string | Sí | pdf o xlsx. |
type |
string | Sí | sale (ventas) o purchase (compras). |
date_start |
YYYY-MM-DD | Sí | Fecha inicial (inclusive). |
date_end |
YYYY-MM-DD | Sí | Fecha final (inclusive). Igual o posterior a date_start. |
document_type_id |
array de string | No | 01, 03, 07, 80 (nota de venta), GU75, NE76. La nota de venta (80) solo se reporta sola. Sin él: todos menos la nota de venta. |
person_id |
integer | No | Cliente (ventas) o proveedor (compras). |
item_id |
integer | No | Solo ese producto. |
brand_id / category_id |
integer | No | Solo productos de esa marca / categoría. |
web_platform_id |
integer | No | Solo productos de esa plataforma web. |
user_type |
string | Con user_id |
CREADOR (quien registró) o VENDEDOR (vendedor asignado). |
user_id |
integer | No | Usuario por el que filtrar (según user_type). |
apply_conversion_to_pen |
boolean | No | Convierte a soles los importes en dólares. |
record_chunk |
integer (100 a 5000) | No | Divide un reporte grande en archivos de N líneas y los entrega juntos en un ZIP (format de la bandeja pasa a zip). Recomendado desde unas 5 000 líneas. |
Errores:
403si el usuario no tiene el módulo del reporte.422{success: false, message: {campo: [errores]}}si falla la validación de filtros (fechas, formato, ids inexistentes...). No se crea ningún reporte.401sin token o con un token inválido.
Cuerpo
Content-Type: application/json
{
"format": "xlsx",
"type": "sale",
"date_start": "2026-11-01",
"date_end": "2026-11-30",
"document_type_id": [
"01",
"03"
],
"user_type": "VENDEDOR",
"user_id": 3
}
Respuestas
202 — En cola
{
"success": true,
"data": {
"id": 58,
"status": "IN_PROCESS",
"ready": false,
"report": "general-items",
"module": "REPORT",
"type": "Reporte general de venta/productos",
"format": "xlsx",
"file_name": null,
"user_id": 3,
"date_init": "2026-11-07 10:15:02",
"date_end": null,
"download_url": null
},
"message": "El reporte se está procesando. Consulte su estado en la bandeja de descargas."
}
422 — Filtros inválidos
{
"success": false,
"message": {
"date_end": [
"fecha final debe ser una fecha posterior o igual a fecha inicial."
]
}
}
403 — Sin el módulo del reporte
{
"success": false,
"message": "No tienes acceso al módulo de este reporte."
}
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.