Solicitar reporte de ventas (comprobantes)
POST /api/reports/documents/export
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Reporte de comprobantes electrónicos (facturas, boletas, notas de crédito y débito) de un rango de fechas, 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. |
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 |
string | No | 01 factura, 03 boleta, 07 nota de crédito, 08 nota de débito. Sin él, todos. |
guides |
string | No | Número de guía de remisión asociada. |
establishment_id |
integer | No | Solo ese establecimiento. También define la cabecera del reporte (por defecto, el del usuario). |
person_id |
integer | No | Id del cliente. |
seller_id |
integer | No | Id del usuario que registró el comprobante. |
state_type_id |
string | No | Estado del comprobante (05 aceptado, 11 anulado...). Ver Catálogos → Estados. |
purchase_order |
string | No | Número de orden de compra. |
web_platform_id |
integer | No | Solo comprobantes con productos de esa plataforma web. |
include_categories |
boolean | No | Solo Excel: agrega el resumen por categorías. |
apply_conversion_to_pen |
boolean | No | Convierte a soles los importes en dólares. |
columns |
array de string | No | Columnas opcionales del Excel/PDF (envía las que quieras ver; sin columns salen las del panel web): user_seller, doc_affect, quote, case, items, currency_type_id, purchase_order, total_exonerated, total_unaffected, total_free, total_taxed, total_igv, total_isc, total, guides, options, web_platforms, total_charge, district, department, province, client_direction, ruc, note_sale, date_note, payment_form, payment_method, plate, agent, reference_data. |
Errores:
422sicolumnstrae una columna que no existe.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",
"date_start": "2026-11-01",
"date_end": "2026-11-30",
"document_type_id": "01",
"establishment_id": 1,
"include_categories": false,
"columns": [
"user_seller",
"items",
"currency_type_id",
"total_taxed",
"total_igv",
"total"
]
}
Respuestas
202 — En cola
{
"success": true,
"data": {
"id": 58,
"status": "IN_PROCESS",
"ready": false,
"report": "documents",
"module": "REPORT",
"type": "Reporte Documentos - Ventas",
"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.