getBonusHistory

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

Descripción

Este método recupera el historial de transacciones de bonificación para el usuario autenticado actualmente, con filtrado por tipo, rango de fechas, descuento, módulo y bandera de administrador. Devuelve una Promesa que se resuelve en un array de objetos IBonusTransactionEntity.

Descuentos.getBonusHistory(

type, dateFrom, dateTo, discountId, moduleId, isAdmin

);

Esquema de parámetros

Esquema

type: IBonusTransactionType
Filtro por tipo de transacción

dateFrom: string
Filtro por fecha de inicio

dateTo: string
Filtro por fecha de finalización

discountId: number
Filtro por id de descuento

moduleId: number
Filtro por id de módulo

isAdmin: boolean
Filtro por 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[]

balanceId: number
Id de saldo.

amount: number
Monto de la transacción.

type: IBonusTransactionType
Tipo de transacción.

discountId: number
Id de descuento.

moduleId: number
Id de módulo.

entityIdentifier: string
Identificador de entidad.

comment: string
Comentario.

isAdmin: boolean
Bandera de administrador.

remainingAmount: number
Monto restante.

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

expiresAt: string
Fecha de expiración.

createdAt: string
Fecha de creación.

---