Reportes

Reporte de utilidad (ventas con costos)

Genera un reporte detallado de ventas por producto incluyendo costos promedios para calcular utilidad. Combina información de ventas con costos de inventario para análisis de rentabilidad.

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:

  • Misma estructura que el reporte de ventas por producto
  • Incluye costo promedio (avgCost) por producto para calcular margen
  • Permite calcular utilidad bruta = totalBruto - (avgCost × quantity)
  • Agrupación opcional por producto para análisis consolidado
  • Soporte para usuarios con múltiples negocios

Casos de uso:

  • Análisis de rentabilidad por producto
  • Identificación de productos con mayor y menor margen
  • Toma de decisiones sobre precios y mix de productos
  • Reportes financieros para gerencia

Ejemplos de uso:

1. Utilidad del mes agrupada por producto

GET /reports/reportUtility?dateInitISO=2025-08-01T00:00:00.000Z&dateEndISO=2025-08-31T23:59:59.999Z&groupResult=true
Authorization: Bearer tu_token_aqui

2. Utilidad detallada por producto

GET /reports/reportUtility?dateInitISO=2025-08-01T00:00:00.000Z&dateEndISO=2025-08-31T23:59:59.999Z
Authorization: Bearer tu_token_aqui
get/reports/reportUtility

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/reports/reportUtility
  • Auth
    HTTP bearer

Query parameters

dateInitISOstring date-time required

Fecha inicial del período del reporte (formato ISO)

dateEndISOstring date-time required

Fecha final del período del reporte (formato ISO)

groupResultboolean

Agrupar resultados por producto para vista consolidada de utilidad

status'Pagada'

Filtrar por estado de factura

allBusinessboolean

Incluir todos los negocios del usuario

Response

Reporte de utilidad generado exitosamente

Example response

{
  "reportByProduct": [
    {
      "_id": {
        "name": "Hamburguesa Clásica",
        "categoryName": "Hamburguesas",
        "avgCost": 8000
      },
      "totalBruto": 30000,
      "totalTaxes": 4750,
      "total": 34750,
      "quantity": 2,
      "avgCost": 16000
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.