Skip to content
Last updated

Los reportes del cliente permiten consultar información agregada sobre el uso de facturación de tu cuenta en QRwey!. Estos endpoints son útiles para analizar patrones de consumo, identificar RFCs recurrentes y evaluar la tarifa más conveniente.

Top RFCs por transacciones

Obtiene los RFCs con mayor número de transacciones realizadas en tu cuenta.

Endpoint

GET /v1/qrs/customers/reports/top-rfc

Host (DEV):

https://api-dev.qrwey.com

Host (PROD):

https://api.qrwey.com

Headers requeridos

Authorization: Bearer {{access_token}}

Query params

ParámetroDescripción
limitNúmero máximo de resultados (default: 10)

Ejemplo de request (DEV)

curl -X GET "https://api-dev.qrwey.com/v1/qrs/customers/reports/top-rfc?limit=5" \
  -H "Authorization: Bearer {{access_token}}"

Respuesta

{
  "topRfc": [
    {
      "taxId": "EKU9003173C9",
      "invoiceCount": 142
    },
    {
      "taxId": "FUNK671228PH6",
      "invoiceCount": 87
    }
  ]
}

Campos de TopRfcResponse

CampoDescripción
topRfcLista de RFCs ordenados por número de facturas
topRfc[].taxIdRFC del receptor
topRfc[].invoiceCountNúmero total de facturas emitidas

Historial de consumo de facturas

Obtiene el historial paginado de consumo de facturas de tu cuenta.

Endpoint

GET /v1/qrs/customers/reports/invoice-usage

Headers requeridos

Authorization: Bearer {{access_token}}

Query params

ParámetroDescripción
pageNúmero de página (default: 0)
sizeElementos por página (default: 20)
sortCampo y dirección de ordenamiento (ej. createdAt,desc)

Ejemplo de request (DEV)

curl -X GET "https://api-dev.qrwey.com/v1/qrs/customers/reports/invoice-usage?page=0&size=10" \
  -H "Authorization: Bearer {{access_token}}"

Respuesta

{
  "content": [
    {
      "customerInvoiceUsageId": "ciu_4aca0361cfcd41c097663db44008fbb9",
      "customerId": "cus_8b3f0a61cfcd41c097663db44008fcc1",
      "month": "MARCH",
      "year": 2026,
      "budgetPlanName": "Plan Pro",
      "appliedBudgetPlan": { },
      "budgetBaseCost": 990.00,
      "budgetInvoices": 500,
      "generatedInvoices": 245,
      "rfcFullCount": 12,
      "rfcFullCost": 240.00,
      "rfcLightCount": 5,
      "rfcLightCost": 50.00,
      "extraCfdiCount": 0,
      "extraCfdiCost": 0.00,
      "totalCost": 1280.00
    }
  ],
  "totalElements": 12,
  "totalPages": 2,
  "number": 0,
  "size": 10
}

Campos de CustomerInvoiceUsageResponse

CampoDescripción
customerInvoiceUsageIdIdentificador único del registro de consumo
customerIdIdentificador del cliente
monthMes del periodo de consumo (ej. JANUARY, FEBRUARY, etc.)
yearAnio del periodo de consumo
budgetPlanNameNombre del plan de facturación aplicado
appliedBudgetPlanDetalle del plan de facturación aplicado en el periodo
budgetBaseCostCosto base del plan contratado
budgetInvoicesNúmero de facturas incluidas en el plan
generatedInvoicesNúmero de facturas generadas en el periodo
rfcFullCountNúmero de RFCs con validación completa (CSF)
rfcFullCostCosto total por validaciones completas de RFC
rfcLightCountNúmero de RFCs con validación ligera
rfcLightCostCosto total por validaciones ligeras de RFC
extraCfdiCountNúmero de CFDIs adicionales (fuera del plan)
extraCfdiCostCosto total por CFDIs adicionales
totalCostCosto total del periodo

Tarifa óptima

Calcula la tarifa más conveniente para tu cuenta basándose en el histórico de consumo.

Endpoint

GET /v1/qrs/customers/reports/optimal-tariff

Headers requeridos

Authorization: Bearer {{access_token}}

Ejemplo de request (DEV)

curl -X GET "https://api-dev.qrwey.com/v1/qrs/customers/reports/optimal-tariff" \
  -H "Authorization: Bearer {{access_token}}"

Respuesta

{
  "budgetPlanId": "bp_4aca0361cfcd41c097663db44008fbb9",
  "name": "Plan Pro",
  "baseCost": 990.00,
  "fullRfcCount": 12,
  "fullRfcCost": 240.00,
  "lightRfcCount": 5,
  "lightRfcCost": 50.00,
  "extraStampsCount": 0,
  "extraStampsCost": 0.00,
  "totalCost": 1280.00,
  "invoiceCount": 245,
  "uniqueCost": 5.22
}

Campos de OptimalTariffResponse

CampoDescripción
budgetPlanIdIdentificador del plan de facturación óptimo
nameNombre del plan recomendado
baseCostCosto base del plan
fullRfcCountNúmero estimado de validaciones completas de RFC
fullRfcCostCosto estimado por validaciones completas
lightRfcCountNúmero estimado de validaciones ligeras de RFC
lightRfcCostCosto estimado por validaciones ligeras
extraStampsCountNúmero estimado de timbrados adicionales
extraStampsCostCosto estimado por timbrados adicionales
totalCostCosto total estimado con el plan óptimo
invoiceCountNúmero de facturas consideradas en el cálculo
uniqueCostCosto unitario por factura con el plan óptimo

Errores comunes

CódigoMotivo
401Token inválido o expirado
403No tienes permisos para consultar reportes

Consulta: Manejo de errores

Buenas prácticas

  • Consulta el reporte de top RFCs para identificar clientes recurrentes y ofrecer mejor servicio
  • Revisa periódicamente el historial de consumo para detectar tendencias
  • Evalúa la tarifa óptima regularmente para asegurarte de estar en el plan más conveniente

¿Qué sigue?