API Technical Docs

Mantente al día con las innovaciones tecnológicas que están transformando el mercado.

Reportes operativos

Estado documental: Contrato propuesto. Los tiempos, frecuencias y formatos definitivos dependen de la implementación y de la configuración contratada.

Objetivo operativo

La operación de YUPY debe permitir que la empresa conozca:

qué se cobró
qué se confirmó
qué sigue esperando
qué tiene diferencia
qué llegó tarde
qué es ambiguo
qué requiere evidencia
qué debe devolverse
quién debe actuar

Bandeja de pendientes

La empresa debe disponer de una vista central con:

  • código de transacción;
  • ID externo;
  • tipo de caso;
  • estado;
  • monto esperado;
  • monto detectado;
  • diferencia;
  • usuario;
  • turno;
  • dispositivo;
  • canal;
  • fecha;
  • antigüedad;
  • evidencia;
  • acción requerida;
  • responsable;
  • última actualización.

Tipos principales

late_payment
amount_difference
underpayment
overpayment
ambiguous_payment
evidence_review
cancelled_order_with_payment
refund_required
delivery_failure
unresolved_payment
operational_error

Flujo del caso

Caso creado
    ↓
Alerta enviada
    ↓
Responsable asignado
    ↓
Caso revisado
    ↓
Evidencia solicitada o recibida
    ↓
Resolución registrada
    ↓
Auditoría y reporte

Asignación

Un pendiente puede asignarse a:

  • vendedor;
  • supervisor;
  • responsable del dispositivo;
  • administrador;
  • equipo operativo;
  • otro responsable configurado.

Alertas inmediatas

La empresa configura:

  • eventos que generan alertas;
  • destinatarios;
  • canal;
  • horario;
  • escalamiento;
  • frecuencia;
  • recordatorios;
  • nivel de prioridad.

Canales:

WhatsApp
correo electrónico
chat operativo
consola
webhook

Eventos que pueden alertar

  • pago confirmado;
  • pago tardío;
  • diferencia;
  • ambigüedad;
  • constancia recibida;
  • revisión requerida;
  • cancelación;
  • pago posterior a cancelación;
  • entrega fallida;
  • turno próximo a vencer;
  • turno cerrado;
  • devolución pendiente;
  • reporte listo;
  • webhook fallido.

Escalamiento

Caso creado
→ vendedor

Sin atención dentro del periodo configurado
→ supervisor

Caso crítico o vencido
→ administrador

Los tiempos exactos son configurables y no forman parte de una promesa universal.

Operación del vendedor

El vendedor puede acceder únicamente a la información necesaria para su turno, según permisos:

  • operaciones;
  • estados;
  • diferencias;
  • casos vinculados;
  • evidencia;
  • alertas;
  • cierre;
  • resumen operativo.

No obtiene automáticamente acceso a reportes generales ni administración.

Cierre de turno

El cierre puede producir un resumen con:

  • operaciones creadas;
  • pagos conciliados;
  • pendientes;
  • diferencias;
  • casos tardíos;
  • casos que requieren seguimiento.
Turno cerrado
≠ conciliación detenida
≠ pendientes eliminados
≠ ingresos ignorados

Reportes inmediatos

La empresa puede consultar:

overview
transactions
reconciliation
pending-cases
late-payments
amount-differences
underpayments
overpayments
ambiguous-payments
cancelled-with-payment
evidence
ocr
refunds
shifts
users
devices
payment-options
checkout-sessions
deliveries
webhook-deliveries
api-usage
duplicate-detections
confirmation-times
claims
audit-log
source-health

source-health presenta una vista resumida del estado de las fuentes necesarias para operar, sin exponer credenciales, consultas privadas ni infraestructura interna.

Filtros

from
to
timezone
status
financial_status
operational_status
payment_method
channel
user_id
shift_id
device_id
external_transaction_id
min_amount
max_amount
page
page_size
sort

Los filtros disponibles dependen de cada reporte.

Exportaciones grandes

Los reportes pequeños pueden responder inmediatamente. Las exportaciones grandes se gestionan como trabajos:

reporte solicitado
→ queued
→ processing
→ ready
→ descarga temporal

Formatos posibles:

CSV
XLSX
JSON
PDF, cuando corresponda

Los formatos definitivos dependen de la implementación.

Reportes programados

La empresa puede configurar:

  • tipo de reporte;
  • frecuencia;
  • periodo;
  • zona horaria;
  • destinatarios;
  • canal;
  • formato;
  • filtros;
  • horario.
{
  "report_type": "late_payments",
  "frequency": "daily",
  "timezone": "America/Lima",
  "recipients": [
    {
      "channel": "email",
      "address": "operaciones@empresa.com"
    }
  ]
}

Webhook de reporte listo

Este ejemplo utiliza el mismo sobre canónico de eventos:

{
  "event_id": "evt_01JREP",
  "event_type": "report.ready",
  "event_version": "1.0",
  "created_at": "2026-07-20T17:00:00-05:00",
  "data": {
    "job_id": "rpt_01JXYZ",
    "report_type": "late_payments",
    "format": "csv",
    "status": "ready"
  }
}

Auditoría operativa

Se registra:

  • creación;
  • asignación;
  • alerta;
  • reconocimiento;
  • nota;
  • evidencia;
  • resolución;
  • cambio de responsable;
  • exportación;
  • descarga;
  • cierre;
  • error;
  • reintento.

Criterios de aceptación

  1. Existe bandeja de pendientes.
  2. Cada caso tiene responsable y antigüedad.
  3. Las alertas son configurables.
  4. WhatsApp y correo pueden utilizarse.
  5. El vendedor solo ve información operativa autorizada.
  6. El cierre no detiene conciliaciones.
  7. Existen reportes inmediatos y exportaciones.
  8. Los reportes grandes son asíncronos.
  9. Pueden programarse entregas.
  10. Las acciones operativas quedan auditadas.