getBonusHistory

Récupération de l'historique des transactions de bonus de l'utilisateur actuel. 🔐 Cette méthode nécessite l'autorisation.

Description

Cette méthode récupère l'historique des transactions de bonus pour l'utilisateur actuellement authentifié avec un filtrage par type, plage de dates, remise, module et indicateur d'administrateur. Elle renvoie une promesse qui se résout en un tableau d'objets IBonusTransactionEntity.

Remises.getBonusHistory(

type, dateFrom, dateTo, discountId, moduleId, isAdmin

);

Parameters schema

Schéma

type: IBonusTransactionType
Filtre par type de transaction

dateFrom: string
Filtre par date de début

dateTo: string
Filtre par date de fin

discountId: number
Filtre par identifiant de remise

moduleId: number
Filtre par identifiant de module

isAdmin: boolean
Filtre par administrateur

Examples

Minimal example

const response = await Discounts.getBonusHistory();

Example with attributes

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

Example response

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

Response schema

Schéma : IBonusTransactionEntity[]

balanceId: number
Identifiant de solde.

amount: number
Montant de la transaction.

type: IBonusTransactionType
Type de transaction.

discountId: number
Identifiant de remise.

moduleId: number
Identifiant de module.

entityIdentifier: string
Identifiant de l'entité.

comment: string
Commentaire.

isAdmin: boolean
Indicateur d'administrateur.

remainingAmount: number
Montant restant.

triggerType: 'EVENT' | 'SCHEDULED'
Type de déclenchement.

expiresAt: string
Date d'expiration.

createdAt: string
Date de création.

---