Reportes

Consultar las ventas por facturas

Consulta un reporte detallado de ventas basado en las facturas generadas 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:

  • Lista todas las facturas en estado "Pagada"
  • Soporta filtrado por fechas, métodos de pago, clientes, etc.
  • Incluye información detallada de productos, impuestos y descuentos
  • Datos de entrega a domicilio y repartidores
  • Información de facturación electrónica (DIAN)
  • Integración con sistemas contables (Siigo, Loggro)

Uso típico para reportes:

  • Análisis de ventas diarias, semanales o mensuales
  • Seguimiento de performance por método de pago
  • Análisis de entrega a domicilio vs mesa
  • Reportes para contabilidad y auditoría
  • Control de facturación electrónica
  •   ## Ejemplos de uso:
    

1. Reporte de ventas del día actual

Consultar todas las ventas (facturas pagadas) del día actual:

GET /reports/reportSalesInvoices?dateInit=2025-08-06T00:00:00.000Z&dateEnd=2025-08-06T23:59:59.999Z&status=Pagada
Authorization: Bearer tu_token_aqui

2. Reporte básico con parámetros mínimos requeridos

Ejemplo mínimo funcional para Consultar facturas pagadas del último mes:

GET /reports/reportSalesInvoices?status=Pagada
Authorization: Bearer tu_token_aqui

3. Reporte con paginación limitada

Consultar las primeras 50 facturas de la semana actual con paginación:

GET /reports/reportSalesInvoices?limit=50&page=0&dateInit=2025-08-01T00:00:00.000Z&dateEnd=2025-08-07T23:59:59.999Z
Authorization: Bearer tu_token_aqui

4. Reporte de ventas por método de pago

Analizar ventas por método de pago específico en el último mes:

GET /reports/reportSalesInvoices?paymentMethodName=Efectivo&dateInit=2025-07-06T00:00:00.000Z&dateEnd=2025-08-06T23:59:59.999Z
Authorization: Bearer tu_token_aqui

5. Reporte de ventas a domicilio

Analizar performance de entrega a domicilio en la última semana:

GET /reports/reportSalesInvoices?onlyDelivery=true&dateInit=2025-07-30T00:00:00.000Z&dateEnd=2025-08-06T23:59:59.999Z&limit=200
Authorization: Bearer tu_token_aqui

6. Reporte de facturación electrónica

Revisar estado de facturas electrónicas para contabilidad:

GET /reports/reportSalesInvoices?type=FacturaElectronica&statusFE=00&dateInit=2025-08-01T00:00:00.000Z&dateEnd=2025-08-06T23:59:59.999Z
Authorization: Bearer tu_token_aqui

7. Reporte de ventas por cajero

Evaluar performance de ventas por cajero específico:

GET /reports/reportSalesInvoices?cashierId=507f1f77bcf86cd799439015&dateInit=2025-08-01T00:00:00.000Z&dateEnd=2025-08-06T23:59:59.999Z
Authorization: Bearer tu_token_aqui
get/reports/reportSalesInvoices

Request

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

Query parameters

paginationboolean

Activar paginación de resultados

limitinteger

Número máximo de facturas por página para reportes

pageinteger

Número de página (inicia en 0)

dateInitstring date-time

Fecha inicial para el reporte de ventas

dateEndstring date-time

Fecha final para el reporte de ventas

status'Pagada'

Estado de las facturas (típicamente solo 'Pagada' para reportes)

paymentMethodNamestring

Filtrar ventas por método de pago específico

clientIdstring

Filtrar ventas por cliente específico

tableIdstring

Filtrar ventas por mesa específica

cashierIdstring

Filtrar ventas por cajero específico

deliveryProvider'RAPPI' | 'UBER_EATS' | 'DIDI_FOOD' | 'INTERNAL'

Filtrar ventas por proveedor de entrega

onlyDeliveryboolean

Mostrar solo ventas con entrega a domicilio

cashboxstring

Filtrar por caja registradora específica

type'Normal' | 'FacturaElectronica'

Tipo de factura para el reporte

typeSort'asc' | 'desc'

Orden de clasificación por fecha (desc para reportes recientes primero)

Response

Reporte de ventas generado exitosamente

_idstring

ID único de la factura

businessIdstring

ID del negocio al que pertenece la factura

numberstring

Número de la factura

invoicePrefixstring

Prefijo de la factura

seqnumber

Número secuencial de la factura

totalnumber

Total de la factura

totalPaidnumber

Total pagado

status'Pendiente' | 'Pagada' | 'Anulada'

Estado de la factura

type'Normal' | 'FacturaElectronica'

Tipo de factura

deliveryCostnumber

Costo de entrega

createdOnstring date-time

Fecha de creación

modifiedOnstring date-time

Fecha de última modificación

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "businessId": "507f1f77bcf86cd799439012",
    "business": {
      "name": "Restaurante El Buen Sabor",
      "nit": "123456789-1",
      "address": "Calle 123 #45-67"
    },
    "number": "FAC-001",
    "invoicePrefix": "FAC",
    "seq": 1,
    "products": [
      {
        "name": "Hamburguesa Clásica",
        "quantity": 2,
        "price": 15000
      }
    ],
    "total": 35000,
    "totalPaid": 35000,
    "status": "Pagada",
    "type": "Normal",
    "table": {
      "name": "Mesa 5"
    },
    "client": {
      "name": "Juan Pérez",
      "phone": "+57 300 123 4567"
    },
    "cashier": {
      "name": "María González"
    },
    "paid": {
      "paymentMethodValue": {
        "paymentMethod": "Efectivo"
      }
    },
    "eInvoice": {
      "DIAN": {
        "dianState": "00"
      }
    },
    "externalIntegration": {
      "siigo": {
        "statusCode": 200
      },
      "loggro": {
        "statusCode": 200
      }
    },
    "createdOn": "2025-08-05T10:30:00.000Z",
    "modifiedOn": "2025-08-05T10:30:00.000Z"
  }
]

Changes

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