Pular para o conteúdo principal

getBonusHistory

Obtendo o histórico de transações de bônus do usuário atual. 🔐 Este método requer autorização.

Descrição​

Este método recupera o histórico de transações de bônus para o usuário autenticado atualmente, com filtragem por tipo, intervalo de datas, desconto, módulo e flag de admin. Ele retorna uma Promise que resolve para um array de objetos IBonusTransactionEntity.

Descontos.getBonusHistory(

type, dateFrom, dateTo, discountId, moduleId, isAdmin

);

Esquema de parâmetros​

Esquema

type: IBonusTransactionType
Filtro de tipo de transação

dateFrom: string
Filtro de data de início

dateTo: string
Filtro de data de término

discountId: number
Filtro de id de desconto

moduleId: number
Filtro de id de módulo

isAdmin: boolean
Filtro de admin

Exemplos​

Exemplo mínimo​

const response = await Discounts.getBonusHistory();

Exemplo com atributos​

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

Exemplo de resposta​

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

Esquema de resposta​

Esquema: IBonusTransactionEntity[]

balanceId: number
Id do saldo.

amount: number
Valor da transação.

type: IBonusTransactionType
Tipo de transação.

discountId: number
Id do desconto.

moduleId: number
Id do módulo.

entityIdentifier: string
Identificador da entidade.

comment: string
Comentário.

isAdmin: boolean
Flag de admin.

remainingAmount: number
Valor restante.

triggerType: 'EVENT' | 'SCHEDULED'
Tipo de gatilho.

expiresAt: string
Data de expiração.

createdAt: string
Data de criação.