Skip to end of banner
Go to start of banner

rewards_participant_awarded_amount_complete

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Name

Type

Description

total_awarded_amountNumberThe total amount that was awarded to the specific rewards participant
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

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

 rewards participant scheme object response data

Name

Type

Description

id

String

The ID of the retrieved rewards participant participating reward scheme

sign_up_onDateThe date that the rewards participant signed up for that specific reward scheme
sign_off_onDate

Available from CRM.COM R9.0.0

The date that the rewards participant signed off from that specific reward scheme

reference_codeSting

The unique reference code that was used while signing up to that specific reward scheme. This is available only if it is required by the specific reward scheme

Available from CRM.COM R12.7.0

sign_up_by_unitUnit object

The unit that signed up the rewards participant to that specific reward scheme

Deprecated from CRM.COM R18.0.0

sign_up_by_business_unitBusiness Unit object

The business unit that signed up the rewards participant to that specific reward scheme

Available from CRM.COM R18.0.0

schemeReward Scheme ObjectThe reward scheme that the rewards participant has joint

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 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

  • No labels