Aller au contenu principal

getBonusHistory

Récupère l'historique des transactions de bonus de l'utilisateur courant. 🔐 Cette méthode nécessite une autorisation.

Description​

Récupère les transactions de bonus de l'utilisateur authentifié, éventuellement filtrées par type, plage de dates, remise, module et indicateur administrateur. Renvoie un IBonusHistoryResponse, un conteneur { items, total } plutôt qu'un tableau.

L'API renvoie au plus les 30 transactions les plus récentes, de la plus récente à la plus ancienne. total est le nombre total de transactions correspondantes, il peut donc être supérieur à items.length. La méthode n'accepte pas encore offset ni limit, les transactions au-delà des 30 premières ne peuvent donc pas être récupérées ; restreignez plutôt la plage avec dateFrom/dateTo ou type.

Le type de retour a été corrigé dans la version 1.0.168

Avant la version 1.0.168, la méthode était déclarée comme renvoyant IBonusTransactionEntity[], mais le point de terminaison a toujours renvoyé un conteneur : un compte sans transactions obtient {"items":[],"total":0}. Le code écrit selon l'ancien type lisait .length sur un objet et obtenait undefined. Lisez les transactions dans result.items et le nombre dans result.total.

.getBonusHistory(

, , , , , , ,

);

Schéma des paramètres​

Schéma

type: IBonusTransactionType
Type de transaction à filtrer : ACCRUAL, USAGE, REDUCE, REVERSAL_ACCRUAL, REVERSAL_USAGE ou EXPIRATION.

dateFrom: string
Début de la plage de dates. Date-heure ISO complète (2026-01-01T00:00:00.000Z) ; une date seule renvoie 400 dateFrom must be a ISOString.

dateTo: string
Fin de la plage de dates. Date-heure ISO complète (2026-12-31T00:00:00.000Z) ; une date seule renvoie 400 dateTo must be a ISOString.

discountId: number
Renvoyer uniquement les transactions de cet ID de remise.

moduleId: number
Ne renvoyer que les transactions de ce module, par exemple 2 pour les formulaires ou 12 pour les commandes.

isAdmin: boolean
Si true, ne renvoyer que les ajustements manuels effectués par un administrateur.

offset: number
Nombre de transactions à ignorer, 0 ou plus. Par défaut : 0.
exemple : 0

limit: number
Nombre maximal de transactions à renvoyer, 1 ou plus. Par défaut : 30.
exemple : 30

Exemples​

Exemple minimal​

const response = await Discounts.getBonusHistory();

Exemple avec des paramètres facultatifs​

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

Exemple de réponse​

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

Schéma de réponse​

Schéma : IBonusHistoryResponse

items: IBonusTransactionEntity[]
Jusqu'à 30 transactions correspondantes les plus récentes, de la plus récente à la plus ancienne.

items.balanceId: number
ID du solde de bonus.

items.amount: string
Montant de la transaction. L'API le renvoie sous forme de CHAÎNE décimale, par exemple "100.00" (bien que le swagger le déclare comme un nombre) — analysez-le avant d'effectuer des calculs.

items.type: IBonusTransactionType
Type de transaction.

items.discountId: number
ID de la remise.

items.moduleId: number
ID du module à l'origine de la transaction, par exemple 2 pour les formulaires ou 12 pour les commandes.

items.entityIdentifier: string
Identifiant de l'entité source dans son module, par exemple un ID de commande ou un marqueur de formulaire.

items.comment: string
Commentaire.

items.isAdmin: boolean
Indique si un administrateur a effectué la transaction manuellement.

items.remainingAmount: string | null
Montant restant (pour l'utilisation/l'expiration FIFO). CHAÎNE décimale comme "100.00" sur les cumuls, null sur les réductions.

items.triggerType: 'EVENT' | 'SCHEDULED'
Ce qui a déclenché la transaction : "EVENT" ou "SCHEDULED".

items.expiresAt: string
Date d'expiration du bonus cumulé ; null s'il n'expire pas.

items.createdAt: string
Date de création.

total: number
Combien de transactions le filtre correspond au total.