rewards_participant_awarded_amount_complete

Name

Type

Description

total_awarded_amountNumberThe total amount that was awarded to the specific rewards participant in rewards participant's currency
total_awarded_alternative_amountNumber

The total amount that was awarded to the specific rewards participant in rewards participant's alternative currency, if any.

Available form CRM.COM R14.2.0

from_dateDateThe date that the first award was applied
to_dateDateThe date that the last award was applied
currencyCurrency object

The reward participant's currency

alternative_currencyCurrency Object

The reward participant's alternative currency

Available form CRM.COM R14.2.0


reward_scheme_awards_setSet of Reward Scheme Awards ObjectsA list of awards provided by reward schemes that the rewards participant participated to

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 reward scheme awards object response data

Name

Type

Description

total_awarded_amount

Number

The total amount that was awarded by the specific scheme

 

schemeReward Scheme ObjectThe reward scheme that provided the award

Referred Objects Response Data

 reward scheme object response data

Name

Type

Description

id

String

The ID of the retrieved reward scheme

name

String

The name of the retrieved reward scheme

alternative_code

String

The alternative code of the retrieved reward scheme

descriptionStringA description of the retrieved reward scheme
life_cycle_stateStringThe life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE