getBonusHistory

Obteniendo el historial de transacciones de bonificación del usuario actual. 🔐 Este método requiere .

Descripción

Este método recupera el historial de transacciones de bonificación para el usuario actualmente autenticado, con filtrado por tipo, rango de fechas, descuento, módulo y bandera de administrador. Devuelve una Promesa que se resuelve en un IBonusHistoryResponse — el contenedor { items, total }, no un array simple.

El tipo de retorno fue corregido en 1.0.168

Hasta 1.0.168, el método se declaraba como IBonusTransactionEntity[], mientras que el endpoint siempre ha respondido con un contenedor: una cuenta sin transacciones devuelve {"items":[],"total":0}. El código escrito desde el antiguo tipo leía .length de un objeto y obtenía undefined. Lee result.items, y result.total para el conteo.

.getBonusHistory(

, , , , ,

);

Esquema de parámetros

Esquema

type: IBonusTransactionType
Filtro de tipo de transacción

dateFrom: string
Filtro de fecha de inicio

dateTo: string
Filtro de fecha de finalización

discountId: number
Filtro de id de descuento

moduleId: number
Filtro de id de módulo

isAdmin: boolean
Filtro de administrador

Ejemplos

Ejemplo mínimo

const response = await Discounts.getBonusHistory();

Ejemplo con atributos

const response = await Discounts.getBonusHistory(
  'ACCRUAL',
  '2026-01-01T00:00:00.000Z',
  '2026-12-31T23:59:59.000Z'
);

Ejemplo de respuesta

{
  "items": [],
  "total": 0
}

Esquema de respuesta

Esquema: IBonusTransactionEntity[]

items: IBonusTransactionEntity[]
Las transacciones de la página actual.

items.balanceId: number
Id de saldo.

items.amount: number
Monto de la transacción.

items.type: IBonusTransactionType
Tipo de transacción.

items.discountId: number
Id de descuento.

items.moduleId: number
Id de módulo.

items.entityIdentifier: string
Identificador de entidad.

items.comment: string
Comentario.

items.isAdmin: boolean
Bandera de administrador.

items.remainingAmount: number
Monto restante.

items.triggerType: 'EVENT' | 'SCHEDULED'
Tipo de activación.

items.expiresAt: string
Fecha de expiración.

items.createdAt: string
Fecha de creación.

total: number
Cuántas transacciones coinciden con el filtro en total.

---