Consultar las ventas agrupadas por categorías
Genera un reporte agregado de ventas organizadas por categorías de productos en un período específico.
Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}
Suscripción Premium requerida: Este endpoint requiere una suscripción premium activa.
Características del reporte:
- Agrupa ventas por categorías de productos
- Calcula totales brutos, descuentos e impuestos por categoría
- Incluye desglose detallado de impuestos por tipo
- Solo incluye facturas en estado "Pagada"
- Excluye facturas eliminadas
- Resultados ordenados alfabéticamente por nombre de categoría
Métricas incluidas:
- Total bruto por categoría
- Total de descuentos aplicados
- Total de impuestos por tipo
- Total neto final
- Desglose detallado de cada impuesto
Casos de uso:
- Análisis de performance por categoría de producto
- Identificación de categorías más rentables
- Reportes de impuestos por categoría
- Análisis de tendencias de venta por tipo de producto
- Toma de decisiones sobre mix de productos
Ejemplos de uso:
1. Reporte básico de categorías con parámetros requeridos
Ejemplo mínimo funcional con solo los parámetros obligatorios:
GET /reports/reportSalesByCategory?dateInitISO=2025-08-01T00:00:00.000Z&dateEndISO=2025-08-31T23:59:59.999Z
Authorization: Bearer tu_token_aqui
2. Reporte de categorías del mes actual
Analizar performance de categorías en el mes de agosto:
GET /reports/reportSalesByCategory?dateInitISO=2025-08-01T00:00:00.000Z&dateEndISO=2025-08-31T23:59:59.999Z
Authorization: Bearer tu_token_aqui
3. Reporte de categorías de la última semana
Análisis semanal de performance por categoría:
GET /reports/reportSalesByCategory?dateInitISO=2025-07-30T00:00:00.000Z&dateEndISO=2025-08-06T23:59:59.999Z
Authorization: Bearer tu_token_aqui
4. Reporte de categorías del día actual
Análisis diario de ventas por categoría:
GET /reports/reportSalesByCategory?dateInitISO=2025-08-06T00:00:00.000Z&dateEndISO=2025-08-06T23:59:59.999Z
Authorization: Bearer tu_token_aqui
5. Análisis trimestral por categorías
Reporte consolidado de tres meses para análisis de tendencias:
GET /reports/reportSalesByCategory?dateInitISO=2025-05-01T00:00:00.000Z&dateEndISO=2025-08-06T23:59:59.999Z
Authorization: Bearer tu_token_aqui
6. Reporte de categorías para período específico de negocio
Análisis de fin de semana (viernes a domingo) para categorías de productos:
GET /reports/reportSalesByCategory?dateInitISO=2025-08-02T00:00:00.000Z&dateEndISO=2025-08-04T23:59:59.999Z
Authorization: Bearer tu_token_aqui
Request
- Base URLhttps://api.pirpos.com
- URLhttps://api.pirpos.com/reports/reportSalesByCategory
- AuthHTTP bearer
Query parameters
Fecha inicial del período del reporte (formato ISO)
Fecha final del período del reporte (formato ISO)
Response
Reporte de ventas por categorías generado exitosamente
Example response
{
"reportByCategory": [
{
"_id": {
"_id": "507f1f77bcf86cd799439021",
"name": "Hamburguesas"
},
"totalBruto": 450000,
"totalDiscount": 45000,
"totalTaxes": 68400,
"totalBaseTax": 360000,
"total": 473400,
"taxes": [
{
"tax": "507f1f77bcf86cd799439025",
"taxName": "IVA 19%",
"totalTax": 68400
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.