Saltar al contenido
Facturador

Generar reporte de caja

GET /api/cash-reports/{cash_report_type}/{cash_id}

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Genera un reporte de una caja (turno): cierre con arqueo, libro de caja, resumen de operaciones, créditos y cobranzas o productos vendidos. Todos salen del mismo libro de caja, así que sus cifras coinciden entre sí.

Quién puede usarlo: un administrador, siempre y de cualquier caja. Un vendedor solo si la opción available_cash_report_seller está activa (Editar opciones de caja) y solo de sus propias cajas; en otro caso responde 403.

Formato de respuesta: archivo (PDF, XML, ZIP, Excel o texto), no JSON. PDF (application/pdf) o Excel (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet). Nombre: Caja_<tipo>_<usuario>_<AAAAMMDD>_<HHmm>.

Parámetros de la ruta:

Campo Tipo Obligatorio Descripción / valores permitidos
cash_report_type string Sí cash_close, cash_movements, cash_operations, cash_credit o cash_products. También acepta los nombres anteriores (cash_summary, cash_simple, summary_daily_operations, general_with_payments, income_egress, payments_associated, income_summary, products, products_garage, cash).
cash_id integer Sí Id de la caja (lo guardan Aperturar caja y Consultar caja abierta del usuario).

Parámetros de la URL (query):

Campo Tipo Obligatorio Descripción / valores permitidos
format string No pdf (por defecto) o excel. Debe estar en formats del reporte.
paper string No Solo PDF: a4 (por defecto), ticket80 o ticket58. Debe estar en papers del reporte.
action string No preview (por defecto, Content-Disposition: inline) o download (attachment).
sections string No Secciones a imprimir separadas por coma (p. ej. methods,movements), de las que ofrece el reporte en el catálogo. Las bloqueadas (locked) van siempre. Sin el parámetro: las que vienen por defecto.
direction string No income = solo ingresos; egress = solo egresos.
group_by string No none, method (medio de pago) o document_type (tipo de comprobante). Por defecto según order_cash_income.
summary, garage, only_cash, separate_directions, by_currency, sort_desc, credit_list, only_pending, all_methods, include_voided_products 0 / 1 No Opciones de cada reporte (ver options en el catálogo): versión resumida (ticket), galones, solo efectivo, separar ingresos y egresos, una tabla por moneda, orden descendente, detalle de créditos, solo saldos pendientes, incluir medios sin movimiento, incluir comprobantes anulados.

Reglas:

  • Un reporte oculto por el administrador (disabled_cash_reports) igual se puede generar por su tipo.
  • Se puede generar con la caja abierta (cifras al momento) o cerrada.

Errores:

  • 403 si no puedes generar reportes de caja o la caja es de otro vendedor.
  • 404 si la caja o el tipo de reporte no existen.
  • 422 si el formato o el papel no están disponibles para ese reporte (p. ej. cash_operations solo se imprime en A4).
  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
cash_report_type ruta sí cash_close
cash_id ruta sí 1
format query sí pdf pdf o excel.
paper query no ticket80 a4, ticket80 o ticket58.
action query no preview preview o download.
sections query no methods,movements Secciones separadas por coma.
only_cash query no 1 Solo movimientos en efectivo.

Respuestas

200 — PDF

%PDF-1.7
%âãÏÓ
... (contenido binario del PDF) ...
%%EOF

200 — Excel

PK ... (contenido binario del libro Excel) ...

403 — Caja de otro vendedor

{
  "success": false,
  "message": "No tienes permiso para acceder a este registro."
}

404 — Reporte no disponible

{
  "success": false,
  "message": "Reporte no disponible"
}

422 — Papel no disponible

{
  "success": false,
  "message": "Papel no disponible para 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.