Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...


Name

Type

Description

id

String

The ID of the retrieved reward award transaction

number

String

The number of the retrieved reward award transaction

life_cycle_stateStringThe life cycle state of the retrieved reward  award transaction. The available values are POSTED and CANCELLED
amountNumberThe amount of the retrieved reward award transaction in system currency
alternative_amountNumber

The amount of the retrieved reward award transaction in the alternative currency.

Tip

Available from CRM.COM R14.2.0


expiration_dateDateThe expiration date of the retrieved reward award transaction
contribution_percentageNumber

The rewards participating merchant's contribution percentage for the retrieved reward award transaction

Tip

Available from CRM.COM R10.1.0


spend_methodString

Defines how the awarded amount can be spent

Supported values

  • SPEND_ONE_REQUEST
  • SPEND_AUTOMATICALLY
  • SPEND_INSTANTLY
  • SPEND_INSTANTLY_THROUGH_VOUCHER
Tip

Available from CRM.COM R17.9.0


accounts_receivableAccounts Receivable Object

The accounts receivable who was awarded by the retrieved reward award transaction

Tip

Available from CRM.COM R17.0.0


rewards_participantRewards Participant
object
Object

The rewards participant who was awarded by the retrieved reward award transaction

Tip

Deprecated from CRM.COM R17.0.0


reward_offerReward
Offer object
Offer ObjectThe reward offer based on which the reward award transaction was created
wallet_transactionWallet
Transaction object
Transaction ObjectThe credit wallet transaction that was generated by the award reward transaction
award_expiration_transactionAward
Expiration object
Expiration ObjectThe award expiration transaction which was generated because of the award transaction's expiration

log_information

Log Information object

The log information related with the retrieved job

currencyCurrency ObjectThe currency in which the rewards participant will be awarded through this award transaction
voucherVoucher Object

The voucher that was issued when an awarded amount was spent

Tip

Available from CRM.COM R14.2.0

alternative


log_information

Log Information Object

The log information related with the retrieved job

initiated_currencyCurrency Object

The

alternative

currency

in

based on which the

rewards participant will be awarded through this award transaction

award transaction was initiated in which can either be the wallet currency or the wallet's alternative currency

Tip

Available from CRM.COM R14.2.0


currency_rate_periodCurrency Rate Period Object

The currency rate period of the award transaction

Tip

Available from CRM.COM R10.0.0


customer_events_setSet of Customer Events ObjectsA list of customer events based on which the reward award transaction was generated.

Anchor
reward award transaction referred objects
reward award transaction referred objects
Referred Objects Response Data

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
rewards_participant_short
rewards_participant_short

...

Include Page
award_expiration_reward_transaction_short
award_expiration_reward_transaction_short

Include Page
voucher_short
voucher_short

Include Page
log_information_short
log_information_short

...