POST reward_offers/list (legacy)

Available from CRM.COM R10.0.0 up to CRM.COM R14.0.0

From CRM.COM R15.0.0 and onwwards, use offers/list to get list of of offers or get applicable to retrieve offers for specific participant

This method returns information related with reward offers. Multiple reward offers are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards participant identifier

The identifier of the rewards participant who might benefit from the reward offer that will be returned as a result. The allowed rewards participant identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the rewards participant

number

(semi-optional)

String

The number of the rewards participant

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the rewards participant. Only effective access tokens can be used to identify a rewards participant. The allowed access token identifier fields are the following:

Name	Type	Description
authentication_code (semi-optional)	String	The authentication code of the access token
identifier (semi-optional)	String	The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code
pass_code (mandatory on conditions)	String	The pass code of the access token, which is applicable and mandatory if the identifier is specified
one_time_password (semi-optional)	Integer	The one-time password (OTP) of the access token Available from CRM.COM R13.0.0

accounts_receivable_identifier

(semi-optional)

Accounts Receivable identifier

The identifier of the rewards participant's accounts receivable. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the accounts receivable. Only effective access tokens can be used to identify an accounts receivable. The allowed access token identifier fields are the following

Name	Type	Description
authentication_code (semi-optional)	String	The authentication code of the access token
identifier (semi-optional)	String	The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code
pass_code (mandatory on conditions)	String	The pass code of the access token, which is applicable and mandatory if the identifier is specified
one_time_password (semi-optional)	Integer	The one-time password (OTP) of the access token Available from CRM.COM R13.0.0

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0

wallet_identifier

(semi-optional)

Wallet identifier

The identifier of the reward participant's wallet. The allowed wallet identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet

number

(semi-optional)

String

The number of the wallet

group_identifier

(optional)

Group Identifier

The identifier of the group that will provide the reward offer. The group is filtered against the reward offer's Award conditions organisational units. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

unit_identifier

(optional)

Unit identifier

The identifier of the unit that will provide the reward offer. The unit is filtered against the reward offer's Award conditions organisational units. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

reward_scheme_identifier

(optional)

Reward scheme identifier

The identifier of the reward scheme related with the reward offer that should be returned as a result. The allowed reward scheme identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the reward scheme

name

(semi-optional)

String

The name of the reward scheme

alternative_code

(semi-optional)

String

The alternative code of the reward scheme

type_identifier
(optional)

Reward offer type identifier

The identifier of the reward offer type related with the reward offer that should be returned as a result. The allowed reward offer type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the reward offer type

name

(semi-optional)

String

The name of the reward offer type

alternative_code

(semi-optional)

String

The alternative code of reward offer type

evaluation_method

(optional)

Reward offer evaluation method identifier

The identifier of the reward offer evaluation method related with the reward offer that should be returned as a result. The allowed reward offer evaluation method identifier fields are the following:BATCH_PROCESS or BATCH_PROCESS_AND_INTERACTIVELY.

award_scope

(optional)

Award Scope identifier

The identifier of the award scope related with the reward offer that should be returned as a result. The allowed award scope identifier fields are the following: APPLY_AWARD_PER_TRANSACTION_ITEM or APPLY_AWARD_PER_TRANSACTION.

Available from CRM.COM R10.0.0

spend_method

(optional)

Reward Offer spend method

The identifier of the reward offer spend method related with the reward offer that should be returned as a result. The allowed reward offer spend method identifier fields are the following: SPEND_ON_REQUEST, SPEND_INSTANTLY or SPEND_INSTANTLY_THROUGH_VOUCHER

Available from CRM.COM R10.0.0

Spend instantly on voucher method available from CRM.COM R14.2.0

award_currency

(optional)

Currency Identifier

The identifier of the currency in which the reward offer will award rewards participants. The allowed currency identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the currency

code

(semi-optional)

String

The code of the currency

Available from CRM.COM R14.2.0

purchase_product

(optional)

Product identifier

The identifier of the product which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

purchase_product_type

(optional)

Product type identifier

The identifier of the product type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product type

name

(semi-optional)

String

The name of the product type

alternative_code

(semi-optional)

String

The alternative code of a product type

purchase_product_family

(optional)

Product family identifier

The identifier of the family type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product family identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of a product family

purchase_product_brand

(optional)

Product Brand identifier

The identifier of the brand which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product brand identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product brand

name

(semi-optional)

String

The name of the product brand

alternative_code

(semi-optional)

String

The alternative code of a product brand

Available from CRM.COM R15.0.0

purchase_product_category

(optional)

Product Category identifier

The identifier of the category type which the rewards participant will have to buy in order to benefit from the reward offer that will be returned as a result. The allowed product category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of a product category

Available from CRM.COM R15.0.0

purchase_amount

(optional)

Number

The amount of the purchase that the rewards participant will have to make in order to benefit from the reward offer that will be returned as a result

number_of_purchases

(optional)

Number

The number of purchases that the rewards participant will have to make in order to benefit from the reward offer that will be returned as a result

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

As input parameters one of the following semi-optional parameters must be specified:
- rewards_participant_identifier
- accounts_receivable_identifier
- wallet_identifier
The rest of the input parameters are optional

Response Data

Name	Type	Description
id	String	The ID of the retrieved reward offer
number	String	The number of the retrieved reward offer
name	String	The name of the retrieved reward offer
alternative_code	String	The alternative code of the retrieved reward offer
description	String	The description of the retrieved reward offer
evaluation_method	String	The method that will be used to evaluate the offers which can be BATCH_PROCESS or BATCH_PROCESS_AND_INTERACTIVELY
award_scope	String	The award scope that defines if the award provided by the reward offer should be applied per transaction or per transaction item, which can be APPLY_AWARD_PER_TRANSACTION or APPLY_AWARD_PER_TRANSACTION_ITEM Available from CRM.COM R10.0.0
spend_method	String	The method that will be used to spend the offers which can be SPEND_ON_REQUEST, SPEND_INSTANTLY, SPEND_INSTANTLY_THROUGH_VOUCHER Available from CRM.COM R10.0.0 Spend instantly through voucher option available from CRM.COM R14.2.0
apply_if_best_award_is_provided	Boolean	If true then the reward offer will be applicable only if the provided award is the best award among other reward offers that might be applicable Available from CRM.COM R10.1.0
life_cycle_state	String	The life cycle state of the retrieved lead which can be EFFECTIVE or NOT EFFECTIVE
latest_effective_date	Date	The latest effective date of the retrieved reward offer
award_amount	Number	The awarded amount provided by the reward offer. An awarded amount can be specified in all reward offers classifications. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer.
award_percentage	Number	The award percentage of the financial transaction amount that triggered the award. Either an awarded amount, award percentage or award percentage on awarded purchases is returned per reward offer. An offer's awarded percentage can only be specified in the offer is classified as: UTILISE_FREE_CAPACITY, INCREASE_REVENUE_TRANSACTION_BASED, INCREASE_REVENUE_PRODUCT_BASED, REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED and REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED is available from CRM.COM R12.0.0
number_of_awarded_participants	Number	The number of the participants to be awarded within the period provided through lottery_award_period parameter. Available only if the reward offer is classified as LOTTERY Available from CRM.COM R14.2.0
award_currency	Currency Object	The currency in which the Reward Offer's award will be provided which can either be in system or the alternative currency. Available from CRM.COM R14.2.0
award_percentage_on_previous_awards	Award Percentage on Previous Awards Object	The award percentage on awards submitted within a specific period of time. Award percentage on previous awards can be specified in all reward offers classifications. Available from CRM.COM R10.1.0
reward_scheme	Reward Scheme Object	The reward scheme of the retrieved reward offer
type	Reward Offer Type Object	The type information of the retrieved reward offer
category	Reward Offer Category Object	The category information of the retrieved reward offer
reward_offer_validity	Reward Offer Validity Object	The validity settings of the retrieved reward offer
reward_award_validity	Reward Award Validity Object	The award validity settings of the retrieved reward offer's awarded amount
owned_by_group	Group object	The group that is owning the reward offer
privacy_level	Privacy level object	The privacy level of the reward offer
log_information	Log Information Object	The log information related with the retrieved reward offer
marketing_information	Reward Offer Marketing Information Object	The reward offer's marketing information Available from CRM.COM R12.2.0
voucher_type	Voucher Type Object	The type of the voucher that will be issued if the reward offer's awarded amount will be instantly spent through a voucher Available from CRM.COM R14.2.0
award_percentage_on_key_performance_indicator_values	Set of Award Percentage on Key Performance Indicator Values Objects	The award percentage that will be applied, based on the value of each specified key performance indicator, as measured through financial statement customer events. This award option is applicable only if the reward offer is classified as REWARD_FINANCIAL_STATEMENTS Available from CRM.COM R11.0.0
award_conditions_set	Set of Reward Offer Award Conditions objects	The reward offer's award conditions that should be met in order for the rewards participant to benefit from the reward offer
spend_conditions_set	Set of Reward Offer Spend Conditions objects	The reward offer's conditions based on which the rewards participant is allowed to spend the awarded amount

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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

award percentage on previous awards object response data

Name	Type	Description
percentage	Number	Defines the award percentage that should be applied on the amount of money that was awarded within a period of time
period	Time Period Object	Defines that period of time
applicable_reward_offer_types_set	Set of Reward Offer Type Objects	The reward offer types that should be related with the awards that will be taken into consideration while calculating the amount to be awarded
applicable_reward_schemes_set	Set of Reward Scheme Objects	The reward schemes that should be related with the awards that will be taken into consideration while calculating the amount to be awarded

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

reward_offer_type response data object

Name	Type	Description
id	String	The ID of the retrieved reward offer type
name	String	The Name of the retrieved reward offer type
alternative_code	String	The Alternative Code of the retrieved reward offer type
description	String	The Description of the retrieved reward offer type
classification	String	The Classification of the retrieved reward offer type. Available values are: UTILISE_FREE_CAPACITY REWARD_SIGN_UPS REWARD_REFERRALS INCREASE_REVENUE_TRANSACTION_BASED INCREASE_REVENUE_PRODUCT_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_BEHAVIOR REWARD_ON_BIRTHDAY REWARD_SUBSCRIPTION_MATURITY REWARD_PERSONAL_DATA_COMPLETENESS REWARD_ACHIEVEMENTS JUST_MONEY REWARD_FINANCIAL_ACHIEVEMENTS REWARD_ON_NAMEDAY

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
description	String	A description of the retrieved reward scheme
life_cycle_state	String	The life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE

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
description	String	A description of the retrieved reward scheme
life_cycle_state	String	The life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE

reward_offer_type response data object

Name	Type	Description
id	String	The ID of the retrieved reward offer type
name	String	The Name of the retrieved reward offer type
alternative_code	String	The Alternative Code of the retrieved reward offer type
description	String	The Description of the retrieved reward offer type
classification	String	The Classification of the retrieved reward offer type. Available values are: UTILISE_FREE_CAPACITY REWARD_SIGN_UPS REWARD_REFERRALS INCREASE_REVENUE_TRANSACTION_BASED INCREASE_REVENUE_PRODUCT_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_BEHAVIOR REWARD_ON_BIRTHDAY REWARD_SUBSCRIPTION_MATURITY REWARD_PERSONAL_DATA_COMPLETENESS REWARD_ACHIEVEMENTS JUST_MONEY REWARD_FINANCIAL_ACHIEVEMENTS REWARD_ON_NAMEDAY

reward_offer_category data object

Name	Type	Description
id	String	The ID of the retrieved reward offer category
name	String	The Name of the retrieved reward offer category
code	String	The Code of the retrieved reward offer category
description	String	The Description of the retrieved reward offer category
parent_id	String	The id of the retrieved category's parent category

reward offer validity object response data

Name	Type	Description
validity_options	String	Defines the reward offer's validity options. The available values are VALID_FROM_LATEST_EFFECTIVE_DATE and VALID_FOR_SPECIFIC_PERIOD, VALID_DURING_BIRTHDAY_PERIOD, VALID_DURING_NAME_DAY_PERIOD, VALID_DURING_RECURRING_PERIOD The VALID_DURING_BIRTHDAY_PERIOD, VALID_DURING_NAME_DAY_PERIOD, VALID_DURING_RECURRING_PERIOD options are available from CRM.COM R11.1.0 onwards
valid_x_days_before_birthday_date	Integer	Defines the number of days before the birthday date during which the offer will become valid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD Available from CRM.COM R11.1.0
valid_x_days_after_birthday_date	Integer	Defines the number of days after the birthday date during which the offer will become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD Available from CRM.COM R11.1.0
valid_x_days_before_name_day_date	Integer	Defines the number of days before the name day date during which the offer will become valid. Applicable only when the reward offer's validity option is set to VALID_DURING_NAME_DAY_PERIOD Available from CRM.COM R11.1.0
valid_x_days_after_name_day_date	Integer	Defines the number of days after the name day date during which the offer will become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_NAME_DAY_PERIOD Available from CRM.COM R11.1.0
valid_from	Date	The date from which the reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD or VALID_DURING_NAME_DAY_PERIOD Available from CRM.COM R12.4.5
valid_to	Date	The date that the reward offer should become invalid. Applicable only when the reward offer's validity option is set to VALID_DURING_BIRTHDAY_PERIOD or VALID_DURING_NAME_DAY_PERIOD Available from CRM.COM R12.4.5
validity_periods_set	Set of Reward Offer Validity Period objects	The periods during which the retrieved reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_FOR_SPECIFIC_PERIOD.
validity_recurring_periods_set	Set of Reward Offer Validity Recurring Period objects	The recurring periods during which the retrieved reward offer will be valid. Applicable only when the reward offer's validity option is set to VALID_DURING_RECURRING_PERIOD Available from CRM.COM R11.1.0

Referred Objects Response Data

reward_offer_validity_periods response data object

Name	Type	Description
id	String	The ID of the retrieved reward offer validity period
valid_from	Date	The date from which the reward offer will be valid
valid_to	Date	The date that the reward offer should become invalid. This is optional as reward offer can be valid for ever, starting from a specific date

reward_offer_validity_recurring_periods response data object

Name	Type	Description
id	String	The ID of the retrieved reward offer validity recurring period
valid_from	Recurring Period Object	The recurring period that the reward offer should become valid.
valid_to	Recurring Period Object	The recurring period that the reward offer should become invalid.

Referred Objects Response Data

recurring period object response data

Name	Type	Description
day	Integer	The day of the recurring period which can be from 1 up to 31 (depending on the retrieved month)
month	Integer	The month of the recurring period which can be from 1 up to 12

reward award validity object response data

Name

Type

Description

validity_options

String

Defines the reward offer's awarded amount validity options. The available values are ALWAYS_VALID, VALID_FOR_SPECIFIC_PERIOD and VALID_BASED_ON_REWARD_SCHEME

VALID_BASED_ON_REWARD_SCHEME available from CRM.COM R12.2.0

award_valid_up_to_date

Date

The date until which the reward offer's awarded amount will be valid. Applicable only if the award's validity option is set to VALID_FOR_SPECIFIC_PERIOD and only as long as award_validity_period is not defined.

award_validity_period_duration

Time Period Object

Defines that the awarded amount will be valid for a specific period of time after the related award transaction's creation date. Applicable only if the award's validity option is set to VALID_FOR_SPECIFIC_PERIOD and only as long as award_valid_up_to_date is not defined.

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

privacy_level object response data

Name	Type	Description
id	String	The id of the retrieved privacy level
number	String	The number of the retrieved privacy level
name	String	The name of the retrieved privacy level
hierarchy_level	String	The hierarchy level of the retrieved privacy level

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

reward offer marketing information object response data

Name	Type	Description
long_description	String	The offer's long description
short_description	String	The offer's short description
no_awards_status_text	String	The text that should appear to inform the participant that he has not been awarded yet. Deprecated from CRM.COM R17.0.0
times_awarded_status_text	String	The text that should appear to inform the participant that the number displayed is the times he has been awarded. Deprecated from CRM.COM R17.0.0
average_weekly_awarded_amount_text	String	The text that should appear to inform the participant that the amount displayed is the average weekly awarded amount. Deprecated from CRM.COM R17.0.0
offer_image	Reward Offer Image Object	The reward large (standard) offer image
offer_small_image	Reward Offer Image Object	The reward small offer image
offer_background	Reward Offer Background Object	The reward offer background which can be an image or a color Deprecated from CRM.COM R17.0.0
offer_stamp_image	Reward Offer Stamp Image Object	The reward offer stamp image Available from CRM.COM R15.0.0 Deprecated from CRM.COM R17.0.0

Referred Objects Response Data

Reward offer Marketing Information Image Object

Name	Type	Description
file_name	String	The name of the file.
file_content_url	String	The url that can be used to access the actual content of the file.
file_mime_type	String	The mime type of the attached file
file_alt_text	String	The alternative text of the attached file, if the file is an image

Reward scheme Marketing Information Background Object

Name	Type	Description
file_name	String	The name of the file.
file_content_url	String	The url that can be used to access the actual content of the file.
file_mime_type	String	The mime type of the attached file
file_alt_text	String	The alternative text of the attached file, if the file is an image
color	String	The hexadecimal value of the color that will be used as a background

Reward offer Marketing Information Stamp Image Object

Name	Type	Description
file_name	String	The name of the file.
file_content_url	String	The url that can be used to access the actual content of the file.
file_mime_type	String	The mime type of the attached file
file_alt_text	String	The alternative text of the attached file, if the file is an image

voucher_type response data object

Name	Type	Description
Id	String	The ID of the retrieved voucher type
name	String	The Name of the retrieved voucher type
alternative_code	String	The Alternative Code of the retrieved voucher type
value_options	String	Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE From CRM.COM R13.1.0* and onwards for voucher types of classification equal to "Electronic Voucher" the supported option is VARIABLE* From CRM.COM R14.0.0 and onwards for voucher types of classification equal to "Refund Voucher" the supported option is VARIABLE
classification	String	The Classification of the retrieved voucher type Available from CRM.COM R13.1.0
description	String	The Description of the retrieved voucher type

award percentage on key performance indicator values response data

Name	Type	Description
percentage	Number	Defines the award percentage that should be applied on the value of the specified key performance indicator
key_performance_indicator	Key Performance Indicator Objects	The key performance indicator that will be awarded based on its value and the specified percentage

key performance indicator object response data

Name	Type	Description
id	String	The id of the retrieved customer event key performance indicator
name	String	The name of the retrieved customer event key performance indicator
alternative_code	String	The alternative code of the retrieved customer event key performance indicator

reward_offer_award_conditions response data object

Name	Type	Description
birthday_condition	String	Defines whether the offer will be applied on the date of the rewards participant birthday or once during the month of their birthday. Available options are ACTUAL_DAY and DURING_BIRTHDAY_MONTH. Applicable only for reward offers classified as REWARD_ON_BIRTHDAY
nameday_condition	String	Defines whether the offer will be applied on the date of the rewards participant nameday or once during the month of their nameday. Available options are ACTUAL_DAY and DURING_NAMEDAY_MONTH. Applicable only for reward offers classified as REWARD_ON_NAMEDAY
sign_up_condition	Boolean	Defines whether the offer will be applied on newly signed up reward participants only or not Applicable only for reward offers classified as REWARD_SIGN_UPS
referral_condition	Boolean	Defines whether the offer will be applied to an existing Rewards Participant who has referred other new Rewards Participants. Applicable only for reward offers classified as REWARD_REFERRALS
just_money_condition	String	It defines how many awards can be provided to each customer by this offer. The available values are ONLY_ONE and MULTIPLE. Applicable only for offers classified as JUST_MONEY.
behavior_conditions	Reward Offer Behavior Condition Object	The actions that the Rewards Participant should perform in order for the reward offer to be applied.Applicable only for reward offers classified as REWARD_BEHAVIOR
transaction_condition	Reward Offer Transaction Condition Object	The transaction range that the purchase customer event needs to be within, in order to award the offer. Applicable only for reward offers classified as INCREASE_REVENUE_TRANSACTION_BASED, REWARD_LOYALTY_TRANSACTION_AMOUNT, REWARD_LOYALTY_TRANSACTION_NUMBER, REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY, LOTTERY REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY offer type available from CRM.COM R12.0.0 LOTTERY offer type available from CRM.COM R14.2.0
lottery_conditions_creation_period	Lottery Condition Creation Period Object	Period within which the system looks back to retrieve customer events or awards (applicable for both Lottery and Transaction conditions). Available only if the reward offer is classified as LOTTERY Available from CRM.COM R14.2.0
lottery_conditions_set	Set of Reward Offer Lottery Condition Object	The awards of specific reward offers that were provided in order to award the offer. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0
subscription_maturity_condition	Reward Offer Subscription Maturity Condition Object	The subscription maturity information that should be met in order for the offer to be applied. Applicable only for reward offers classified as REWARD_SUBSCRIPTION_MATURITY
personal_data_completeness_condition	Reward Offer Personal Data Completeness Conditions Object	The personal data that the rewards participant should provide in order for the offer to be applied. Applicable only for reward offers classified as REWARD_PERSONAL_DATA_COMPLETENESS
achievement_conditions	Reward Offer Achievement Conditions Object	The reward offer achievement condition that should be met in order to apply the offer. Applicable only for offers classified as REWARD_ACHIEVEMENTS
financial_achievement_conditions	Reward Offer Financial Achievement Conditions Object	The reward offer financial achievement condition that should be met in order to apply the offer. Applicable only for offers classified as REWARD_FINANCIAL_ACHIEVEMENTS
financial_statement_conditions	Reward Offer Financial Statement Conditions Object	The reward offer financial statement condition that should be met in order to apply the offer. Applicable only for offers classified as REWARD_FINANCIAL_STATEMENTS Available from CRM.COM R11.0.0
period_conditions	Reward Offer Period Conditions	The reward offer period condition that should be met in order to apply the offer. Applicable only for offers classified as: UTILISE_FREE_CAPACITY, INCREASE_REVENUE_TRANSACTION_BASED, INCREASE_REVENUE_PRODUCT_BASED, REWARD_FINANCIAL_ACHIEVEMENTS REWARD_ACHIEVEMENTS REWARD_BEHAVIOR REWARD_FINANCIAL_STATEMENTS
time_conditions_set	Set of Reward Offer Time Condition Objects	The time conditions related with the retrieved reward offer award time condition. Applicable only for reward offers classified as: UTILISE_FREE_CAPACITY INCREASE_REVENUE_TRANSACTION_BASED INCREASE_REVENUE_PRODUCT_BASED Time Conditions set available in: INCREASE_REVENUE_TRANSACTION_BASED INCREASE_REVENUE_PRODUCT_BASED from CRM.COM R12.7.0, R13.3.0 and* R14.2.0 onwards*
product_conditions_set	Set of Reward Offer Product Condition Objects	The product conditions related with the retrieved reward offer award condition. Applicable only for reward offers classified as: UTILISE_FREE_CAPACITY INCREASE_REVENUE_PRODUCT_BASED REWARD_FINANCIAL_ACHIEVEMENTS REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED Product Conditions set available in: REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED from CRM.COM R12.0.0
payment_medium_conditions_set	Set of Payment Medium Condition Objects	A list of payment medium brands and types conditions that should be met in order to apply the offer. Applicable only for offers classified as: UTILISE_FREE_CAPACITY, INCREASE_REVENUE_TRANSACTION_BASED, INCREASE_REVENUE_PRODUCT_BASED, REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED REWARD_FINANCIAL_ACHIEVEMENTS REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available from CRM.COM R12.0.0
location_conditions_set	Set of Location Condition Objects	A list of Location conditions that should be met in order to apply the offer. Applicable only for offers classified as: UTILISE_FREE_CAPACITY, INCREASE_REVENUE_TRANSACTION_BASED, INCREASE_REVENUE_PRODUCT_BASED, REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED REWARD_FINANCIAL_ACHIEVEMENTS REWARD_ACHIEVEMENTS JUST_MONEY REWARD_FINANCIAL_STATEMENTS REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available from CRM.COM R12.0.0
segment_conditions_set	Set of Segment objects	A list of Segments which consist the reward offer's segment award conditions
organisational_unit_conditions_set	Set of Organisational Unit objects	A list of Organisational Units which consist the reward offer's segment award conditions

Referred Objects Response Data

reward_offer_behavior_condition object response data

Name	Type	Description
award_facebook_likes	Boolean	Defines whether rewards participants will be awarded if they like a specific Facebook page.
facebook_page_like	String	The Facebook page that the Rewards Participant should like in order for the offer to be applied. Applicable only if award_facebook_likes is set to true.
award_website_visit	Boolean	Defines whether rewards participants will be awarded if they have visited a specific web site
website_url	String	The Website URL that the Rewards Participant should visit in order for the offer to be applied. Applicable only if award_website_visit is set to true.

reward_offer_transaction_condition object response data

Name	Type	Description
transaction_amount_from	Number	The minimum required transaction amount in order for the offer to be applied. Applicable only for reward offers classified as: INCREASE_REVENUE_TRANSACTION_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED
transaction_amount_to	Number	The maximum required transaction amount in order for the offer to be applied. This value is optional. Applicable only for reward offers classified as: INCREASE_REVENUE_TRANSACTION_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED transaction_amount_to deprecated in CRM.COM R12.2.0 for REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED reward offers
transaction_number_from	Number	The minimum required number of transactions in order for the offer to be applied. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_NUMBER_BASED and REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available form CRM.COM R12.0.0
transaction_number_to	Number	The maximum required number of transactions in order for the offer to be applied. This value is optional. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_NUMBER_BASED Deprecated in CRM.COM R12.2.0
lottery_transaction_conditions_set	Set of Reward Offer Lottery Transaction Conditions Object	A set of the transaction conditions. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0
transaction_period_range_period	Time Period object	The time period that the events will have to be performed within, in order to award the offer. Applicable only for reward offers classified as REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED or REWARD_LOYALTY_TRANSACTION_NUMBER_BASED or REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED. REWARD_LOYALTY_TRANSACTION_ITEM_QUANTITY_BASED available form CRM.COM R12.0.0

Referred Objects Response Data

reward_offer_lottery__transaction_conditions object response data

Name	Type	Description
minimum_number_customer_events	Number	The minimum number of customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0
maximum_number_customer_events	Number	The maximum number of customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0
customer_event_type	String	The type of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY. The supported values are: PURCHASED, REFERRAL, WEB, SOCIAL_MEDIA, ACHIEVEMENT, SPEND_REQUEST, FINANCIAL_ACHIEVEMENT, FINANCIAL_STATEMENT Available from CRM.COM R14.2.0
minimum_total_amount	Number	The minimum total amount of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or SPEND_REQUEST Available from CRM.COM R14.2.0
maximum_total_amount	Number	The minimum total amount of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or SPEND_REQUEST Available from CRM.COM R14.2.0
payment_medium_brand	Payment Medium Brand object	The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or FINANCIAL_ACHIEVEMENT Available from CRM.COM R14.2.0
payment_medium_type	Payment Medium Type object	The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY and the customer_event_type is set to PURCHASED or FINANCIAL_ACHIEVEMENT Available from CRM.COM R14.2.0
customer_event_classification	Customer Event Type object	The classification of the customer events that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY Available from CRM.COM R14.2.0

Referred Objects Response Data

payment_medium_brand object response data

Name	Type	Description
id	String	The id of the retrieved payment medium brand
name	String	The name of the retrieved payment medium brand
alternative_code	String	The alternative code of the retrieved payment medium brand
description	String	The description of the retrieved payment medium brand

payment_medium_type object response data

Name	Type	Description
id	String	The id of the retrieved payment medium type
name	String	The name of the retrieved payment medium type
alternative_code	String	The alternative code of the retrieved payment medium type
description	String	The description of the retrieved payment medium type

customer event classification object response data

Name	Type	Description
id	String	The id of the retrieved customer event classification
name	String	The name of the retrieved customer event classification
alternative_code	String	The alternative code of the retrieved customer event classification

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

lottery_condition_creation_period object response data

Name

Type

Description

award_period_value

Number

The period value

award_period_uot

String

The period unit of time. The supported values are the following:

DAYS, WEEKS, MONTHS

reward_offer_lottery_conditions object response data

Name

Type

Description

minimum_number_awards

Number

The minimum number of awards of the specified rewards offer that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY

Available from CRM.COM R14.2.0

maximum_number_awards

Number

The maximum number of awards of the specified rewards offer that should be performed within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY

Available from CRM.COM R14.2.0

r eward_offer

Reward Offer object

The reward offer that should have awarded the customer within a period of time in order to be awarded. Applicable only for reward offers classified as LOTTERY

Available from CRM.COM R14.2.0

Referred Objects Response Data

reward offer object response data

Name	Type	Description
id	String	The ID of the retrieved reward offer
number	String	The number of the retrieved reward offer
name	String	The name of the retrieved reward offer
alternative_code	String	The alternative code of the retrieved reward offer
description	String	A description of the retrieved reward offer
life_cycle_state	String	The life cycle state of the reward offer which can be EFFECTIVE or NOT_EFFECTIVE
marketing_information_short_description	String	The offer's short description Available from CRM.COM R12.2.0
reward_scheme	Reward Scheme Object	The reward scheme that the reward offer belongs to Available from CRM.COM R11.0.0

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
description	String	A description of the retrieved reward scheme
life_cycle_state	String	The life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE

reward_offer_subscription_maturity_condition object response data

Name	Type	Description
uninterrupted_subscription_period	Time Period Object	The uninterrupted subscription period of time that a Rewards Participant needs to have, in order to award the offer
maximum_interruption_period	Time Period Object	A maximum interruption threshold, always measured in days

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

reward_offer_data_completeness_condition object response data

Name	Type	Description
award_date_of_birth_completeness	Boolean	The offer is applied if the rewards participant completes the date of birth.
award_name_day_completeness	Boolean	The offer is applied if the rewards participant completes the nameday
data_completeness_period	Personal Data Completeness Period object	Defines the period in date range during which the personal data completeness customer event must be performed in order for the rewards participant to be awarded
address_completeness_set	Award Address Completeness Set of objects	A list of address types and the address information that should be completed by the rewards participant in order for the offer to be applied
phone_completeness_set	Award Phone Completeness Set of objects	A list of phone types and the address information that should be completed by the rewards participant in order for the offer to be applied
email_completeness_set	Award Email Completeness Set of objects	A list of email types and the address information that should be completed by the rewards participant in order for the offer to be applied

Referred Objects Response Data

reward_offer_period_completeness_condition object response data

Name	Type	Description
complete_data_from	Date	The date from which the rewards participant should complete the personal data in order for the offer to be applied
complete_data_to	Date	The date until which the rewards participant should complete the personal data in order for the offer to be applied

reward_offer_address_completeness_condition object response data

Name	Type	Description
address_type	String	The type of the address that the rewards participant should provide which can either be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
address_fields_set	Address Field Set of Objects	A list address fields that should be provided by the rewards participant.

Referred Objects Response Data

address_completeness_values_conditions object response data

Name

Type

Description

address_field

String

The address field which should be specified by the rewards participant. The supported values are the following:

COUNTRY, STREET NAME, STREET NUMBER, FLOOR, AREA, DISTRICT, CARE OF, PO BOX, PO BOX POSTAL CODE, POSTAL CODE, APARTMENT NUMBER, TOWN, MUNICIPALITY

From R14.2.0 the following values are also available: ADDRESS_LINE_1, ADDRESS_LINE_2, STATE_PROVINCE_COUNTY

reward_offer_phone_completeness_condition object response data

Name	Type	Description
phone_type	String	The type of the phone that the rewards participant should provide which can either be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
phone_fields_set	Phone Fields Set of Objects	A list phone fields that should be provided by the rewards participant.

Referred Objects Response Data

phone_completeness_values_conditions object response data

Name

Type

Description

phone_field

String

The phone field which should be specified by the rewards participant. The supported values are the following:

COUNTRY, AREA CODE, NUMBER, NOTES

reward_offer_email_completeness_condition object response data

Name	Type	Description
email_type	String	The type of the email that the rewards participant should provide which can either be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
email_address	Boolean	Defines that the email address should be specified by the rewards participant in order for this condition to be met

reward award period condition object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

DAYS, WEEKS, MONTHS, YEARS

reward_offer_day_time_condition object response data

Name	Type	Description
days_condition_set	Days Condition set of objects	A set of days on which the customer event should be performed in order to be awarded.
hours_condition_set	Hours Condition set of objects	A set of hour ranges during which the customer event should be performed in order to be awarded

Referred Objects Response Data

reward_offer_date_condition object response data

Name

Type

Description

day_of_week

String

The day of week condition related with the retrieved reward offer time condition. The supported values are the following:

MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

reward_offer_time_condition object response data

Name	Type	Description
from	Number	The start of the time period condition related with the retrieved reward offer time condition
to	Number	The end of the time period condition related with the retrieved reward offer time condition
from_hour_minutes	String	The starting hour from which the customer event should be performed in order to be awarded in HH::MM format which also includes minutes Available form CRM.COM R12.3.0
to-hour_minutes	String	The hour up until which the customer event should be performed in order to be awarded in HH::MM format which also includes minutes Available form CRM.COM R12.3.0

reward_offer_product_condition object response data

Name	Type	Description
all_products_should_exist	Boolean	Defines whether the product condition is met if all or at least one of the specified products or products of the specified product types or families are included in purchase customer events. Applicable only for reward offers classified as: REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED Available from CRM.COM R12.0.0
product	Product object	The product related with the retrieved reward offer condition
product_type	Product Type object	The product type related with the retrieved reward offer condition
product_family	Product Family object	The product family related with the retrieved reward offer condition. Product family condition is applicable for reward offers classified as: INCREASE_REVENUE_PRODUCT_BASED, UTILISE_FREE_CAPACITY REWARD_FINANCIAL_ACHIEVEMENTS REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED
product_brand	Product Brand object	The product brand related with the retrieved reward offer condition. Product brand condition is applicable for reward offers classified as: INCREASE_REVENUE_PRODUCT_BASED, UTILISE_FREE_CAPACITY REWARD_FINANCIAL_ACHIEVEMENTS REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED Available from CRM.COM R15.0.0
product_category	Product Category object	The product category related with the retrieved reward offer condition. Product category condition is applicable for reward offers classified as: INCREASE_REVENUE_PRODUCT_BASED, UTILISE_FREE_CAPACITY REWARD_FINANCIAL_ACHIEVEMENTS REWARD_LOYALTY_TRANSACTION_NUMBER_BASED REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED REWARD_LOYALTY_TRANSACTION_QUANTITY_ITEM_BASED Available from CRM.COM R15.0.0
purchase_event_amount_condition	Purchase Event Condition object	The amount range that the related product or product type purchase customer event needs to be related with, in order to award the offer. Applicable in conditions related to reward offer which are classified as INCREASE_REVENUE_PRODUCT_BASED

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

product_brand object data response

Name	Type	Description
Id	String	The ID of the retrieved product brand
name	String	The Name of the retrieved product brand
alternative_code	String	The Alternative Code of the retrieved product brand
description	String	The Description of the retrieved product brand

product_category response data object

Name	Type	Description
Id	String	The ID of the retrieved product category
name	String	The Name of the retrieved product category
code	String	The code of the retrieved product category
description	String	The Description of the retrieved product category

purchase_event_condition object data response

Name	Type	Description
amount_from	Number	The minimum purchase event amount that is required in order for the reward offer condition to be met
amount_to	Number	The maximum purchase event amount that is required in order for the reward offer condition to be met. This amount is optional

reward_offer_achievement_condition object response data

Name	Type	Description
all_achievements_should_exist	Boolean	Defines whether the achievement condition is met if all of the specified achievement events should exist or at least one.
number_of_awards	String	It defines how many awards can be provided to each customer by this offer. The available values are MULTIPLE, ONLY_ONE and ONLY_ONE_PER_PERIOD Available from CRM.COM R11.0.0
number_of_awards_period	Period Object	Defines the period during which a customer will be awarded by the offer only once among all of the achievement events. Applicable only if the number of awards is set to ONLY_ONE_PER_PERIOD Available from CRM.COM R11.0.0
achievement_classifications_set	Set of Customer Event Classification objects	The customer event classification related with the retrieved reward offer condition. Only classifications for ACHIEVEMENTS are included.

Referred Objects Response Data

reward award period condition object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

DAYS, WEEKS, MONTHS, YEARS

customer event classification object response data

Name	Type	Description
id	String	The id of the retrieved customer event classification
name	String	The name of the retrieved customer event classification
alternative_code	String	The alternative code of the retrieved customer event classification

reward_offer_financial_achievement_condition object response data

Name	Type	Description
all_achievements_should_exist	Boolean	Defines whether the financial achievement condition is met if all of the specified financial achievement event classifications should exist or at least one.
number_of_awards	String	It defines how many awards can be provided to each customer by this offer. The available values are MULTIPLE, ONLY_ONE and ONLY_ONE_PER_PERIOD Available from CRM.COM R11.0.0
number_of_awards_period	Period Object	Defines the period during which a customer will be awarded by the offer only once among all of the financial achievement events. Applicable only if the number of awards is set to ONLY_ONE_PER_PERIOD Available from CRM.COM R11.0.0
financial_achievement_amount_range	Financial Achievement Amount Range Object	The minimum and maximum amount that a financial achievement customer event should have in order for this condition to be met. Available from CRM.COM R11.0.0
financial_achievement_classifications_set	Set of Customer Event Classification objects	The customer event classification related with the retrieved reward offer condition. Only classifications for FINANCIAL_ACHIEVEMENTS are included.

Referred Objects Response Data

reward award period condition object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

DAYS, WEEKS, MONTHS, YEARS

amount range object response data

Name	Type	Description
from_value	Number	The minimum required amount
to_value	Number	The maximum required amount

customer event classification object response data

Name	Type	Description
id	String	The id of the retrieved customer event classification
name	String	The name of the retrieved customer event classification
alternative_code	String	The alternative code of the retrieved customer event classification

reward_offer_financial_statement_condition object response data

Name	Type	Description
number_of_awards	String	It defines how many awards can be provided to each customer by this offer. The available values are MULTIPLE, ONLY_ONE and ONLY_ONE_PER_PERIOD
number_of_awards_period	Period Object	Defines the period during which a customer will be awarded by the offer only once among all of the financial achievement events. Applicable only if the number of awards is set to ONLY_ONE_PER_PERIOD
financial_statement_classifications_set	Set of Customer Event Classification objects	The customer event classification related with the retrieved reward offer condition. Only classifications for FINANCIAL_STATEMENTS are included.
key_performance_indicator_conditions_set	Set of Key Performance Indicator Condition Objects	The key performance indicator conditions related with the retrieved reward offer condition

Referred Objects Response Data

reward award period condition object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

DAYS, WEEKS, MONTHS, YEARS

customer event classification object response data

Name	Type	Description
id	String	The id of the retrieved customer event classification
name	String	The name of the retrieved customer event classification
alternative_code	String	The alternative code of the retrieved customer event classification

key performance indicator condition object response data

Name	Type	Description
from_value	Number	The minimum required value
to_value	Number	The maximum required value
key_performance_indicator	Key Performance Indicator Object	The key performance indicator evaluated by the condition
product	Product Object	The product which is measured by the evaluated key performance indicator

Referred Objects Response Data

key performance indicator object response data

Name	Type	Description
id	String	The id of the retrieved customer event key performance indicator
name	String	The name of the retrieved customer event key performance indicator
alternative_code	String	The alternative code of the retrieved customer event key performance indicator

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

reward_offer_payment_medium_condition object response data

Name	Type	Description
payment_medium_brand_condition_set	Payment Medium Brand Condition set of objects	A set of payment medium brands with which the customer event should be performed in order to be awarded.
payment_medium_type_condition_set	Payment Medium Type Condition set of objects	A set of payment medium types which the customer event should be performed in order to be awarded.

Referred Objects Response Data

payment_medium_brand object response data

Name	Type	Description
id	String	The id of the retrieved payment medium brand
name	String	The name of the retrieved payment medium brand
alternative_code	String	The alternative code of the retrieved payment medium brand
description	String	The description of the retrieved payment medium brand

payment_medium_type object response data

Name	Type	Description
id	String	The id of the retrieved payment medium type
name	String	The name of the retrieved payment medium type
alternative_code	String	The alternative code of the retrieved payment medium type
description	String	The description of the retrieved payment medium type

reward_offer_location_condition object response data

Name	Type	Description
area	String	The area in which the rewards participant lives in order to be awarded
city	String	The town/city in which the rewards participant lives in order to be awarded
district	String	The district in which the rewards participant lives in order to be awarded

reward_offer_segmentation_condition object response data

Name	Type	Description
option	String	Defines whether the condition's segment will be used to include or exclude the Rewards Participants that are allowed to be awarded. Available options are INCLUDE and EXCLUDE
segment	Segment object	The segment included in the reward offer's segments condition

Referred Objects Response Data

segment object response data

Name	Type	Description
id	String	The ID of the retrieved segment
number	String	The number of the retrieved segment
name	String	The name of the retrieved segment
alternative_code	String	The alternative code of the retrieved segment
description	String	The description of the retrieved segment

reward_offer_organisational_unit_condition object response data

Name	Type	Description
business_unit	Business Unit Object	The business unit included in the reward offer's organisational unit condition Available from CRM.COM R18.0.0
unit	Unit object	The unit included in the reward offer's organisational unit condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit)
group	Group object	The group included in the reward offer's organisational unit condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

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

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

reward_offer_spend_conditions response data object

Name	Type	Description
allowed_spend_period_after_award	Time Period object	The period during which the awarded amount can be spend since the award was offered.
time_conditions_set	Set of Reward Offer Time Condition Objects	The days and time conditions related with the retrieved reward offer spend time condition which define on which days and hours range the awarded amount can be spent.
product_conditions_set	Set of Reward Offer Product Condition Objects	The product conditions related with the retrieved reward offer spend condition.
organisational_unit_conditions_set	Set of Organisational Unit objects	A list of Organisational Units which consist the reward offer's segment spend conditions

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

reward_offer_day_time_condition object response data

Name	Type	Description
days_condition_set	Days Condition set of objects	A set of days on which the customer event should be performed in order to be awarded.
hours_condition_set	Hours Condition set of objects	A set of hour ranges during which the customer event should be performed in order to be awarded

Referred Objects Response Data

reward_offer_date_condition object response data

Name

Type

Description

day_of_week

String

The day of week condition related with the retrieved reward offer time condition. The supported values are the following:

MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

reward_offer_time_condition object response data

Name	Type	Description
from	Number	The start of the time period condition related with the retrieved reward offer time condition
to	Number	The end of the time period condition related with the retrieved reward offer time condition
from_hour_minutes	String	The starting hour from which the customer event should be performed in order to be awarded in HH::MM format which also includes minutes Available form CRM.COM R12.3.0
to-hour_minutes	String	The hour up until which the customer event should be performed in order to be awarded in HH::MM format which also includes minutes Available form CRM.COM R12.3.0

reward_offer_product_spend_condition object response data

Name	Type	Description
product	Product object	The product related with the retrieved reward offer spend condition
product_type	Product Type object	The product type related with the retrieved reward offer spend condition
product_family	Product Family object	The product family related with the retrieved reward offer spend condition
product_brand	Product Brand object	The product brand related with the retrieved reward offer spend condition. Available from CRM.COM R15.0.0
product_category	Product Category object	The product category related with the retrieved reward offer spend condition. Available from CRM.COM R15.0.0

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

product_brand object data response

Name	Type	Description
Id	String	The ID of the retrieved product brand
name	String	The Name of the retrieved product brand
alternative_code	String	The Alternative Code of the retrieved product brand
description	String	The Description of the retrieved product brand

product_category response data object

Name	Type	Description
Id	String	The ID of the retrieved product category
name	String	The Name of the retrieved product category
code	String	The code of the retrieved product category
description	String	The Description of the retrieved product category

reward_offer_organisational_unit_condition object response data

Name	Type	Description
business_unit	Business Unit Object	The business unit included in the reward offer's organisational unit condition Available from CRM.COM R18.0.0
unit	Unit object	The unit included in the reward offer's organisational unit condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit)
group	Group object	The group included in the reward offer's organisational unit condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

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

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

Examples

Example 1

HTTP Method: POST

Request:

http://cyn1lnx004:9080/crmapi/rest/v2/reward_offers/list

Body

{
"token":"163317CACB7441CD88CB01C5427DF6E7",
"accounts_receivable_identifier":{"name":"ACR000879"},
"unit_identifier":{"name":"Test"},
"purchase_product":{"code":"TPG Bundle 3"},
"purchase_product_type":{"name":"Accessories"},
"purchase_product_family":{"name":"Analogue"}
}

Response

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "number": "81",
      "name": "Utilise ET",
      "privacy_level": null,
      "log_information": {
        "updated_date": "2016-05-26T09:23:05",
        "created_date": "2016-05-26T09:15:09",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "owned_by_group": {
        "community_name": "Internal Community",
        "id": "84F33366CB592BAAE7E2044D93611C6A",
        "name": "Main Group",
        "description": "Main Group",
        "alternative_code": "MG1"
      },
      "life_cycle_state": "EFFECTIVE",
      "reward_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "id": "EA5CCE98F857F3A928E3AA6891323088",
        "name": "Sales Scheme",
        "description": "Sales Scheme - TC10",
        "alternative_code": "SS"
      },
      "type": {
        "classification": "UTILISE_FREE_CAPACITY",
        "id": "4ADADCD342A55A483E324F63DE4D54E5",
        "name": "Utilise Free Capacity",
        "description": "Utilise Free Capacity",
        "alternative_code": "UFC"
      },
      "id": "3064E7C123B64B47B10E8D4802EA10AA",
      "spend_conditions_set": {
        "allowed_spend_period_after_award": {
          "time_period_value": null,
          "time_period_uot": null
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        }
      },
      "description": null,
      "award_percentage": null,
      "award_conditions_set": {
        "product_conditions_set": {
          "product_set": [
            {
              "product_family": {
                "id": "63D78575AE1C47513C19765F9AAF857A",
                "name": "Analogue",
                "description": null,
                "code": null
              },
              "product_type": null,
              "product": null
            }
          ]
        },
        "organisational_unit_conditions_set": [],
        "time_conditions_set": {
          "days_condition_set": [
            [
              {
                "day_of_week": "TUESDAY"
              },
              {
                "day_of_week": "WEDNESDAY"
              },
              {
                "day_of_week": "THURSDAY"
              },
              {
                "day_of_week": "FRIDAY"
              }
            ]
          ],
          "hours_condition_set": [
            {
              "from": null,
              "to": 23
            }
          ]
        }
      },
      "category": null,
      "latest_effective_date": "2016-05-26 09:16:10.0",
      "alternative_code": "UE"
    }
  ]
}

Example 2

HTTP Method: POST

Request:

{{server}}/crmapi/rest/v2/reward_offers/list

Body:

{
    "token":"{{token}}",
    "rewards_participant_identifier":{"number":"RP0000000019"},
    "unit_identifier":{"name":"Admin Unit"},
    "spend_method":"SPEND_INSTANTLY",
    "award_scope":"APPLY_AWARD_PER_TRANSACTION_ITEM"  
}

Response:

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "spend_method": "SPEND_INSTANTLY",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "number": "52",
      "name": "PK_Reward Offer_1",
      "privacy_level": null,
      "log_information": {
        "updated_date": "2016-07-14T08:49:18",
        "created_date": "2016-07-11T13:31:04",
        "created_by_unit": {
          "community_name": "Community",
          "id": "1",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "admin unit",
          "alternative_code": "adminunit"
        },
        "updated_by_unit": {
          "community_name": "Community",
          "id": "1",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "admin unit",
          "alternative_code": "adminunit"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com"
        }
      },
      "owned_by_group": {
        "community_name": "Community",
        "id": "1",
        "name": "Main Group",
        "description": "Main Group",
        "alternative_code": "MG"
      },
      "award_scope": "APPLY_AWARD_PER_TRANSACTION_ITEM",
      "life_cycle_state": "EFFECTIVE",
      "reward_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "name": "Marketing Scheme",
        "description": null,
        "alternative_code": "MS"
      },
      "type": {
        "classification": "UTILISE_FREE_CAPACITY",
        "id": "DE7AF5BB04EF442DA745C0CC5346C13D",
        "name": "Utilise Free Capacity",
        "description": null,
        "alternative_code": "UFC"
      },
      "id": "6644452351BB482483F4A375575D5F73",
      "award_percentage": 10,
      "description": null,
      "spend_conditions_set": {
        "allowed_spend_period_after_award": {
          "time_period_value": null,
          "time_period_uot": null
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        }
      },
      "award_conditions_set": {
        "product_conditions_set": {
          "product_set": [
            {
              "product_family": null,
              "product_type": {
                "service_type": null,
                "physical_good_type": "TRACEABLE",
                "used_for_provisioning": false,
                "classification": "PHYSICALGOODS",
                "composition_method": "FLAT",
                "id": "434A205A97FD44A2824CFD2B872D8340",
                "name": "PK_Product Type_2",
                "description": null,
                "alternative_code": "PT_1"
              },
              "product": null
            },
            {
              "product_family": null,
              "product_type": {
                "service_type": null,
                "physical_good_type": "TRACEABLE",
                "used_for_provisioning": false,
                "classification": "PHYSICALGOODS",
                "composition_method": "FLAT",
                "id": "B2AEEFA234BF4B0FBB8423EC9550B418",
                "name": "PK_Product Type",
                "description": null,
                "alternative_code": "PT"
              },
              "product": null
            }
          ]
        },
        "organisational_unit_conditions_set": [],
        "time_conditions_set": {
          "days_condition_set": [
            [
              {
                "day_of_week": "MONDAY"
              },
              {
                "day_of_week": "TUESDAY"
              },
              {
                "day_of_week": "WEDNESDAY"
              },
              {
                "day_of_week": "THURSDAY"
              },
              {
                "day_of_week": "FRIDAY"
              },
              {
                "day_of_week": "SATURDAY"
              },
              {
                "day_of_week": "SUNDAY"
              }
            ]
          ],
          "hours_condition_set": []
        }
      },
      "latest_effective_date": "2016-07-14 08:49:18.0",
      "category": null,
      "alternative_code": "PO_1"
    },
    {
      "spend_method": "SPEND_INSTANTLY",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "number": "67",
      "name": "PK_Reward Offer_3",
      "privacy_level": null,
      "log_information": {
        "updated_date": "2016-07-14T08:49:39",
        "created_date": "2016-07-12T09:40:52",
        "created_by_unit": {
          "community_name": "Community",
          "id": "1",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "admin unit",
          "alternative_code": "adminunit"
        },
        "updated_by_unit": {
          "community_name": "Community",
          "id": "1",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "admin unit",
          "alternative_code": "adminunit"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com"
        }
      },
      "owned_by_group": {
        "community_name": "Community",
        "id": "1",
        "name": "Main Group",
        "description": "Main Group",
        "alternative_code": "MG"
      },
      "award_scope": "APPLY_AWARD_PER_TRANSACTION_ITEM",
      "life_cycle_state": "EFFECTIVE",
      "reward_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "name": "Marketing Scheme",
        "description": null,
        "alternative_code": "MS"
      },
      "type": {
        "classification": "UTILISE_FREE_CAPACITY",
        "id": "DE7AF5BB04EF442DA745C0CC5346C13D",
        "name": "Utilise Free Capacity",
        "description": null,
        "alternative_code": "UFC"
      },
      "id": "017CBB2945D24D5A8B591D926246A104",
      "award_percentage": null,
      "description": null,
      "spend_conditions_set": {
        "allowed_spend_period_after_award": {
          "time_period_value": null,
          "time_period_uot": null
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        }
      },
      "award_conditions_set": {
        "product_conditions_set": {
          "product_set": [
            {
              "product_family": null,
              "product_type": {
                "service_type": null,
                "physical_good_type": "TRACEABLE",
                "used_for_provisioning": false,
                "classification": "PHYSICALGOODS",
                "composition_method": "FLAT",
                "id": "434A205A97FD44A2824CFD2B872D8340",
                "name": "PK_Product Type_2",
                "description": null,
                "alternative_code": "PT_1"
              },
              "product": null
            },
            {
              "product_family": null,
              "product_type": {
                "service_type": null,
                "physical_good_type": "TRACEABLE",
                "used_for_provisioning": false,
                "classification": "PHYSICALGOODS",
                "composition_method": "FLAT",
                "id": "B2AEEFA234BF4B0FBB8423EC9550B418",
                "name": "PK_Product Type",
                "description": null,
                "alternative_code": "PT"
              },
              "product": null
            }
          ]
        },
        "organisational_unit_conditions_set": [],
        "time_conditions_set": {
          "days_condition_set": [
            [
              {
                "day_of_week": "MONDAY"
              },
              {
                "day_of_week": "TUESDAY"
              },
              {
                "day_of_week": "WEDNESDAY"
              },
              {
                "day_of_week": "THURSDAY"
              },
              {
                "day_of_week": "FRIDAY"
              },
              {
                "day_of_week": "SATURDAY"
              },
              {
                "day_of_week": "SUNDAY"
              }
            ]
          ],
          "hours_condition_set": []
        }
      },
      "latest_effective_date": "2016-07-14 08:49:39.0",
      "category": null,
      "alternative_code": "PO_3"
    }
  ]
}

Example 2

HTTP Method: GET

Request:

http://cyn1lnx004:8080/crmapi/rest/v2/reward_offers/list

Body:

{
	"token":"{{token}}",
	"accounts_receivable_identifier":{"number":"ACR0000000285"},
	"unit_identifier":{"name":"Admin Unit"}
}

Response:

 {
  "data": [
    {
      "award_conditions_set": {
        "segment_conditions_set": [
          {
            "segment": {
              "number": "2",
              "alternative_code": "EP",
              "name": "Effective rewards participants",
              "description": null,
              "id": "9BCA8988077543B8B1A30D10DEE14440"
            },
            "option": "EXCLUDE"
          }
        ],
        "organisational_unit_conditions_set": [
          {
            "unit": null,
            "group": {
              "alternative_code": "EG",
              "community_name": "Community",
              "name": "External Group",
              "description": null,
              "id": "641C9485A25246B6B7FE20804E5A81A1"
            }
          }
        ],
        "nameday_condition": "DURING_NAMEDAY_MONTH"
      },
      "alternative_code": "ERN",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-14T08:09:44",
        "updated_date": "2016-07-14T09:33:10",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RON",
        "name": "Reward On Nameday",
        "description": null,
        "id": "8702D2C8C1A04BC283126F944AF29D37",
        "classification": "REWARD_ON_NAMEDAY"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-07-14 08:10:24.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "87",
      "award_amount": 2.89,
      "name": "ET Reward Nameday",
      "id": "8B37E0EAF84C4FC7B8745318F0F6840E",
      "category": null
    },
    {
      "award_conditions_set": {
        "behavior_conditions": {
          "facebook_page_like": "www.crm.com",
          "award_facebook_likes": 1,
          "award_website_visit": 0
        },
        "period_conditions": {
          "time_period_uot": null,
          "time_period_value": null
        },
        "segment_conditions_set": [
          {
            "segment": {
              "number": "2",
              "alternative_code": "EP",
              "name": "Effective rewards participants",
              "description": null,
              "id": "9BCA8988077543B8B1A30D10DEE14440"
            },
            "option": "INCLUDE"
          }
        ],
        "organisational_unit_conditions_set": [
          {
            "unit": null,
            "group": {
              "alternative_code": "MG",
              "community_name": "Community",
              "name": "Main Group",
              "description": "Main Group",
              "id": "1"
            }
          }
        ]
      },
      "alternative_code": "RWV2",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-02-10T14:29:40",
        "updated_date": "2016-03-23T10:49:43",
        "updated_by_user": {
          "person_name": "emichailidou",
          "id": "9A2CF58F91D94B8B981C33275BA20880",
          "email": "crm.com.tst@gmail.com",
          "username": "emichailidou"
        },
        "created_by_user": {
          "person_name": "emichailidou",
          "id": "9A2CF58F91D94B8B981C33275BA20880",
          "email": "crm.com.tst@gmail.com",
          "username": "emichailidou"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "SSS",
        "name": "Sales Scheme",
        "description": "desc",
        "id": "3592610A4F01454E97AF71C9E47646FB",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RB",
        "name": "Reward Behavior",
        "description": null,
        "id": "F945D878D86B489B9EC3F2A500E9775F",
        "classification": "REWARD_BEHAVIOR"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-03-23 10:48:19.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "9",
      "award_amount": 2,
      "name": "Reward Website Visits 2euros",
      "id": "060E54C6ECDC432D93233FEB3751D700",
      "category": null
    },
    {
      "award_conditions_set": {
        "location_conditions_set": null,
        "just_money_condition": "MULTIPLE",
        "segment_conditions_set": [
          {
            "segment": {
              "number": "2",
              "alternative_code": "EP",
              "name": "Effective rewards participants",
              "description": null,
              "id": "9BCA8988077543B8B1A30D10DEE14440"
            },
            "option": "INCLUDE"
          }
        ],
        "organisational_unit_conditions_set": [
          {
            "unit": null,
            "group": {
              "alternative_code": "MG",
              "community_name": "Community",
              "name": "Main Group",
              "description": "Main Group",
              "id": "1"
            }
          }
        ]
      },
      "alternative_code": "1EA",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-24T08:50:01",
        "updated_date": "2016-03-24T08:57:43",
        "updated_by_user": {
          "person_name": "pdemou",
          "id": "6403BD50DF4A4EA59C406FF686FEAB54",
          "email": "crm.com.tst@gmail.com",
          "username": "pdemou"
        },
        "created_by_user": {
          "person_name": "pdemou",
          "id": "6403BD50DF4A4EA59C406FF686FEAB54",
          "email": "crm.com.tst@gmail.com",
          "username": "pdemou"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "JM",
        "name": "Just Money",
        "description": null,
        "id": "7D67E2BCB70D430B99DB12A42B9EC6E4",
        "classification": "JUST_MONEY"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-03-24 08:57:43.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "22",
      "award_amount": 10,
      "name": "10 Euro award",
      "id": "3DE813A206804C1FA1B923750378CA91",
      "category": null
    },
    {
      "award_conditions_set": {
        "location_conditions_set": {
          "location_set": [
            {
              "area": "",
              "city": "Limassol",
              "district": ""
            }
          ]
        },
        "just_money_condition": "ONLY_ONE",
        "segment_conditions_set": [
          {
            "segment": {
              "number": "20",
              "alternative_code": "RPMT1MA",
              "name": "Rewards Participants more than 1 month activated",
              "description": null,
              "id": "BDEBA651620047E782F99E4ABF544CF4"
            },
            "option": "EXCLUDE"
          }
        ],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "EJM",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T07:56:33",
        "updated_date": "2016-07-14T09:48:19",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "JM",
        "name": "Just Money",
        "description": null,
        "id": "7D67E2BCB70D430B99DB12A42B9EC6E4",
        "classification": "JUST_MONEY"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-07-14 09:48:19.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "58",
      "award_amount": 65,
      "name": "ET Just Money",
      "id": "E8E5733EA0F34804BEE8B823D6C61611",
      "category": null
    },
    {
      "award_conditions_set": {
        "birthday_condition": "ON_BIRTHDAY",
        "segment_conditions_set": [
          {
            "segment": {
              "number": "2",
              "alternative_code": "EP",
              "name": "Effective rewards participants",
              "description": null,
              "id": "9BCA8988077543B8B1A30D10DEE14440"
            },
            "option": "INCLUDE"
          }
        ],
        "organisational_unit_conditions_set": [
          {
            "unit": null,
            "group": {
              "alternative_code": "MG",
              "community_name": "Community",
              "name": "Main Group",
              "description": "Main Group",
              "id": "1"
            }
          }
        ]
      },
      "alternative_code": "5EOB",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-24T09:42:58",
        "updated_date": "2016-03-24T09:48:41",
        "updated_by_user": {
          "person_name": "pdemou",
          "id": "6403BD50DF4A4EA59C406FF686FEAB54",
          "email": "crm.com.tst@gmail.com",
          "username": "pdemou"
        },
        "created_by_user": {
          "person_name": "pdemou",
          "id": "6403BD50DF4A4EA59C406FF686FEAB54",
          "email": "crm.com.tst@gmail.com",
          "username": "pdemou"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "ROB",
        "name": "Reward on Birthday",
        "description": null,
        "id": "771F28B7D0F54EDB8004D6FB302C621B",
        "classification": "REWARD_ON_BIRTHDAY"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-03-24 09:48:41.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "26",
      "award_amount": 5,
      "name": "5 euro on Birthday",
      "id": "5DE44D90F5BC4F5889B6A5C2623F6F35",
      "category": null
    },
    {
      "award_conditions_set": {
        "sign_up_condition": 1,
        "segment_conditions_set": [
          {
            "segment": {
              "number": "2",
              "alternative_code": "EP",
              "name": "Effective rewards participants",
              "description": null,
              "id": "9BCA8988077543B8B1A30D10DEE14440"
            },
            "option": "INCLUDE"
          }
        ],
        "organisational_unit_conditions_set": [
          {
            "unit": null,
            "group": {
              "alternative_code": "MG",
              "community_name": "Community",
              "name": "Main Group",
              "description": "Main Group",
              "id": "1"
            }
          }
        ]
      },
      "alternative_code": "5EFNC",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-24T09:48:49",
        "updated_date": "2016-03-24T09:51:30",
        "updated_by_user": {
          "person_name": "pdemou",
          "id": "6403BD50DF4A4EA59C406FF686FEAB54",
          "email": "crm.com.tst@gmail.com",
          "username": "pdemou"
        },
        "created_by_user": {
          "person_name": "pdemou",
          "id": "6403BD50DF4A4EA59C406FF686FEAB54",
          "email": "crm.com.tst@gmail.com",
          "username": "pdemou"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RS",
        "name": "Reward Signups",
        "description": null,
        "id": "21B8D71630BD4FE6B504E63B7167549E",
        "classification": "REWARD_SIGN_UPS"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-03-24 09:51:30.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "27",
      "award_amount": 5,
      "name": "5 Euros for New Customers",
      "id": "F7B4A9BE955244CC879ACE09641ACF79",
      "category": null
    },
    {
      "award_conditions_set": {
        "transaction_condition": {
          "transaction_amount_to": null,
          "transaction_period_range_period": {
            "time_period_uot": null,
            "time_period_value": null
          },
          "transaction_amount_from": 2
        },
        "location_conditions_set": {
          "location_set": [
            {
              "area": "Strovolos",
              "city": "Limassol",
              "district": ""
            }
          ]
        },
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "ERLTAB",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T07:46:15",
        "updated_date": "2016-07-14T10:26:04",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "award_percentage": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RE",
        "name": "RLTA ET",
        "description": null,
        "id": "4E52DE1E29E24BD4B3A3C547B82B0975",
        "classification": "REWARD_LOYALTY_TRANSACTION_AMOUNT_BASED"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-07-14 09:47:27.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "55",
      "name": "ET  Reward Loyalty Transaction Amount Based",
      "id": "5F9F3B3FBF2C45DCB33A5719FB859A42",
      "category": null
    },
    {
      "award_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            [
              {
                "day_of_week": "MONDAY"
              },
              {
                "day_of_week": "TUESDAY"
              },
              {
                "day_of_week": "WEDNESDAY"
              },
              {
                "day_of_week": "THURSDAY"
              },
              {
                "day_of_week": "FRIDAY"
              },
              {
                "day_of_week": "SATURDAY"
              },
              {
                "day_of_week": "SUNDAY"
              }
            ]
          ],
          "hours_condition_set": []
        },
        "transaction_condition": {},
        "location_conditions_set": null,
        "period_conditions": {
          "time_period_uot": null,
          "time_period_value": null
        },
        "product_conditions_set": {
          "product_set": [
            {
              "product_family": null,
              "product": {
                "code": "Gold",
                "product_type": {
                  "service_type": "TERMED",
                  "used_for_provisioning": true,
                  "alternative_code": "Main Packages",
                  "composition_method": "FLAT",
                  "name": "Main Packages",
                  "description": null,
                  "id": "E186E293AAAB49EE86A729540A4287FE",
                  "classification": "SERVICES",
                  "physical_good_type": null
                },
                "alternative_code": "G",
                "description": null,
                "id": "D1EB074DFD904E54A0C67CAB9DC7E010"
              },
              "product_type": null
            }
          ]
        },
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "owapmc",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T11:19:00",
        "updated_date": "2016-07-12T11:22:30",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "award_percentage": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "UFC",
        "name": "Utilise Free Capacity",
        "description": null,
        "id": "DE7AF5BB04EF442DA745C0CC5346C13D",
        "classification": "UTILISE_FREE_CAPACITY"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-12 11:20:24.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "73",
      "name": "offer without any payment medium criteria",
      "id": "20C9C4E4F864491699344F1C0BDBF6B2",
      "category": null
    },
    {
      "award_conditions_set": {
        "transaction_condition": {
          "transaction_period_range_period": {
            "time_period_uot": null,
            "time_period_value": null
          },
          "transaction_number_from": 1,
          "transaction_number_to": null
        },
        "location_conditions_set": {
          "location_set": [
            {
              "area": "",
              "city": "Limassol",
              "district": ""
            },
            {
              "area": "Strovolos",
              "city": "Limassol",
              "district": ""
            },
            {
              "area": "Strovolos",
              "city": "Limassol",
              "district": "Livadia"
            },
            {
              "area": "Strovolos",
              "city": "",
              "district": ""
            }
          ]
        },
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "ERLNB",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T09:55:07",
        "updated_date": "2016-07-14T11:35:13",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RE_1",
        "name": "RLTN ET",
        "description": null,
        "id": "4C23652F5E4B4F1286F3A1A33F20B45D",
        "classification": "REWARD_LOYALTY_TRANSACTION_NUMBER_BASED"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-07-14 09:49:09.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "70",
      "award_amount": 2.3,
      "name": "ET Reward Loyalty Number Based",
      "id": "423CC69A0B6D45619FE370AF18CEAF0C",
      "category": null
    },
    {
      "award_conditions_set": {
        "subscription_maturity_condition": {
          "maximum_interruption_period": {
            "time_period_uot": "DAYS",
            "time_period_value": 0
          },
          "uninterrupted_subscription_period": {
            "time_period_uot": "MONTHS",
            "time_period_value": 0
          }
        },
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "rmos",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-06-24T06:31:44",
        "updated_date": "2016-06-30T09:46:30",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "SSS",
        "name": "Sales Scheme",
        "description": "desc",
        "id": "3592610A4F01454E97AF71C9E47646FB",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": "test reward spend transactions",
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RSM",
        "name": "Reward Subscription Maturity",
        "description": null,
        "id": "F08640E2E4664C66879DB12B673B1E5E",
        "classification": "REWARD_SUBSCRIPTION_MATURITY"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-06-24 06:49:21.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "29",
      "award_amount": 2,
      "name": "reward maturity offer sevia",
      "id": "A861F7DE2F8047438E12E00FC9497D07",
      "category": null
    },
    {
      "award_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            [
              {
                "day_of_week": "MONDAY"
              },
              {
                "day_of_week": "TUESDAY"
              },
              {
                "day_of_week": "WEDNESDAY"
              },
              {
                "day_of_week": "THURSDAY"
              },
              {
                "day_of_week": "FRIDAY"
              },
              {
                "day_of_week": "SATURDAY"
              },
              {
                "day_of_week": "SUNDAY"
              }
            ]
          ],
          "hours_condition_set": []
        },
        "transaction_condition": {},
        "location_conditions_set": null,
        "period_conditions": {
          "time_period_uot": null,
          "time_period_value": null
        },
        "product_conditions_set": {
          "product_set": [
            {
              "product_family": null,
              "product": null,
              "product_type": {
                "service_type": null,
                "used_for_provisioning": false,
                "alternative_code": "PT_1",
                "composition_method": "FLAT",
                "name": "PK_Product Type_2",
                "description": null,
                "id": "434A205A97FD44A2824CFD2B872D8340",
                "classification": "PHYSICALGOODS",
                "physical_good_type": "TRACEABLE"
              }
            },
            {
              "product_family": null,
              "product": null,
              "product_type": {
                "service_type": null,
                "used_for_provisioning": false,
                "alternative_code": "PT",
                "composition_method": "FLAT",
                "name": "PK_Product Type",
                "description": null,
                "id": "B2AEEFA234BF4B0FBB8423EC9550B418",
                "classification": "PHYSICALGOODS",
                "physical_good_type": "TRACEABLE"
              }
            }
          ]
        },
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "PO_1",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-11T13:31:04",
        "updated_date": "2016-07-14T08:49:18",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "award_percentage": 10,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "UFC",
        "name": "Utilise Free Capacity",
        "description": null,
        "id": "DE7AF5BB04EF442DA745C0CC5346C13D",
        "classification": "UTILISE_FREE_CAPACITY"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-14 08:49:18.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "52",
      "name": "PK_Reward Offer_1",
      "id": "6644452351BB482483F4A375575D5F73",
      "category": null
    },
    {
      "award_conditions_set": {
        "transaction_condition": {
          "transaction_period_range_period": {
            "time_period_uot": "WEEKS",
            "time_period_value": 1
          },
          "transaction_number_from": 5,
          "transaction_number_to": 20
        },
        "location_conditions_set": null,
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "tpmlbn",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-06-29T07:09:03",
        "updated_date": "2016-06-29T07:34:28",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RLTNB",
        "name": "Reward Loyalty, Transaction Number Based",
        "description": null,
        "id": "40B41F61958744949EEB5D2A288B4965",
        "classification": "REWARD_LOYALTY_TRANSACTION_NUMBER_BASED"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-06-29 07:10:40.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "35",
      "award_amount": 5,
      "name": "test payment medium loyalty based number",
      "id": "8895A94B54FB4EDE9216EF8B3E7FB9F3",
      "category": null
    },
    {
      "award_conditions_set": {
        "location_conditions_set": null,
        "period_conditions": {
          "time_period_uot": null,
          "time_period_value": null
        },
        "achievement_conditions_set": {
          "classification": [
            {
              "alternative_code": "CF1",
              "name": "Customer Feedback 1",
              "id": "5E4CA041768646BCA9AD587A81985BB7"
            },
            {
              "alternative_code": "CF3",
              "name": "Customer Feedback 3",
              "id": "2D3EDC7CA2F4494BB8313D9F14120AD8"
            },
            {
              "alternative_code": "CF2",
              "name": "Customer Feedback 2",
              "id": "E27D1F25A1AC4409947F1FF2DDB8CBF5"
            }
          ]
        },
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "cras",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-06-30T07:59:11",
        "updated_date": "2016-07-04T15:32:41",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "SSS",
        "name": "Sales Scheme",
        "description": "desc",
        "id": "3592610A4F01454E97AF71C9E47646FB",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": "screens testing",
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RA",
        "name": "Reward Achievements",
        "description": null,
        "id": "A38DFB8AA07141379707FDC5392E245A",
        "classification": "REWARD_ACHIEVEMENTS"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-07-01 09:35:02.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "39",
      "award_amount": 5,
      "name": "check reward achievments sevia",
      "id": "63A882A6BC3C4B84BF6A7722FA1445C7",
      "category": null
    },
    {
      "award_conditions_set": {},
      "alternative_code": "favac",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-04T10:29:25",
        "updated_date": "2016-07-04T11:26:19",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": "test all classifications of fin",
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "FA",
        "name": "Financial Achievments",
        "description": null,
        "id": "1F91CA50C16B494A86901861A4681127",
        "classification": "REWARD_FINANCIAL_ACHIEVEMENTS"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-04 10:31:24.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "45",
      "award_amount": 25,
      "name": "financial achievment valid all classifications",
      "id": "F31BB448D2C2462EA09F96F00C38A02E",
      "category": null
    },
    {
      "award_conditions_set": {},
      "alternative_code": "ovc",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-05T06:56:43",
        "updated_date": "2016-07-05T06:58:41",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "FA",
        "name": "Financial Achievments",
        "description": null,
        "id": "1F91CA50C16B494A86901861A4681127",
        "classification": "REWARD_FINANCIAL_ACHIEVEMENTS"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-05 06:58:41.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "46",
      "award_amount": 12,
      "name": "offer that validates criteria",
      "id": "C309CC842D274BB3BFF7C320005453B4",
      "category": null
    },
    {
      "award_conditions_set": {
        "behavior_conditions": {
          "facebook_page_like": "www.facebook.com/crm",
          "award_facebook_likes": 1,
          "award_website_visit": 0
        },
        "period_conditions": {
          "time_period_uot": null,
          "time_period_value": null
        },
        "segment_conditions_set": [
          {
            "segment": {
              "number": "2",
              "alternative_code": "EP",
              "name": "Effective rewards participants",
              "description": null,
              "id": "9BCA8988077543B8B1A30D10DEE14440"
            },
            "option": "INCLUDE"
          }
        ],
        "organisational_unit_conditions_set": [
          {
            "unit": null,
            "group": {
              "alternative_code": "MG",
              "community_name": "Community",
              "name": "Main Group",
              "description": "Main Group",
              "id": "1"
            }
          }
        ]
      },
      "alternative_code": "RFL",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-23T14:49:21",
        "updated_date": "2016-03-23T14:50:30",
        "updated_by_user": {
          "person_name": "pdemou",
          "id": "6403BD50DF4A4EA59C406FF686FEAB54",
          "email": "crm.com.tst@gmail.com",
          "username": "pdemou"
        },
        "created_by_user": {
          "person_name": "pdemou",
          "id": "6403BD50DF4A4EA59C406FF686FEAB54",
          "email": "crm.com.tst@gmail.com",
          "username": "pdemou"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RB",
        "name": "Reward Behavior",
        "description": null,
        "id": "F945D878D86B489B9EC3F2A500E9775F",
        "classification": "REWARD_BEHAVIOR"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-03-23 14:50:30.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "16",
      "award_amount": 2,
      "name": "Reward Facebook Like",
      "id": "FCD7DE87377844F4A01BEE03DA51FC92",
      "category": null
    },
    {
      "award_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            [
              {
                "day_of_week": "MONDAY"
              },
              {
                "day_of_week": "TUESDAY"
              },
              {
                "day_of_week": "WEDNESDAY"
              },
              {
                "day_of_week": "THURSDAY"
              },
              {
                "day_of_week": "FRIDAY"
              },
              {
                "day_of_week": "SATURDAY"
              },
              {
                "day_of_week": "SUNDAY"
              }
            ]
          ],
          "hours_condition_set": []
        },
        "transaction_condition": {},
        "location_conditions_set": null,
        "period_conditions": {
          "time_period_uot": null,
          "time_period_value": null
        },
        "product_conditions_set": {
          "product_set": [
            {
              "product_family": null,
              "product": null,
              "product_type": {
                "service_type": null,
                "used_for_provisioning": false,
                "alternative_code": "PT_1",
                "composition_method": "FLAT",
                "name": "PK_Product Type_2",
                "description": null,
                "id": "434A205A97FD44A2824CFD2B872D8340",
                "classification": "PHYSICALGOODS",
                "physical_good_type": "TRACEABLE"
              }
            },
            {
              "product_family": null,
              "product": null,
              "product_type": {
                "service_type": null,
                "used_for_provisioning": false,
                "alternative_code": "PT",
                "composition_method": "FLAT",
                "name": "PK_Product Type",
                "description": null,
                "id": "B2AEEFA234BF4B0FBB8423EC9550B418",
                "classification": "PHYSICALGOODS",
                "physical_good_type": "TRACEABLE"
              }
            }
          ]
        },
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "PO_3",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T09:40:52",
        "updated_date": "2016-07-14T08:49:39",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "award_percentage": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "UFC",
        "name": "Utilise Free Capacity",
        "description": null,
        "id": "DE7AF5BB04EF442DA745C0CC5346C13D",
        "classification": "UTILISE_FREE_CAPACITY"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-14 08:49:39.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "67",
      "name": "PK_Reward Offer_3",
      "id": "017CBB2945D24D5A8B591D926246A104",
      "category": null
    },
    {
      "award_conditions_set": {
        "segment_conditions_set": [
          {
            "segment": {
              "number": "37",
              "alternative_code": "rats",
              "name": "reward award transaction sevia",
              "description": null,
              "id": "F692BC8A0C7A4895AF8011B9D59936A3"
            },
            "option": "INCLUDE"
          },
          {
            "segment": {
              "number": "38",
              "alternative_code": "rsts",
              "name": "reward spend transaction sevia",
              "description": "test reward maturity offers",
              "id": "49156EEEFC514D629063CA13EA384016"
            },
            "option": "INCLUDE"
          }
        ],
        "organisational_unit_conditions_set": [],
        "personal_data_completeness_condition": {
          "phone_completeness_set": [],
          "data_completeness_period": {
            "complete_data_from": null,
            "complete_data_to": null
          },
          "address_completeness_set": [],
          "email_completeness_set": [],
          "award_date_of_birth_completeness": 1
        }
      },
      "alternative_code": "cs",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-06-24T08:31:00",
        "updated_date": "2016-06-24T10:12:01",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RDC",
        "name": "Reward Data Completeness",
        "description": null,
        "id": "BC71FA164082431D84D012E74905CC74",
        "classification": "REWARD_PERSONAL_DATA_COMPLETENESS"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-06-24 08:32:02.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "30",
      "award_amount": 2,
      "name": "completnsess sevia",
      "id": "05E4FA7EA2DD42C4A4DCEE3EDF34441D",
      "category": null
    },
    {
      "award_conditions_set": {},
      "alternative_code": "ERFA",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T07:58:00",
        "updated_date": "2016-07-14T09:49:03",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "FA",
        "name": "Financial Achievments",
        "description": null,
        "id": "1F91CA50C16B494A86901861A4681127",
        "classification": "REWARD_FINANCIAL_ACHIEVEMENTS"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-07-14 09:48:35.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "59",
      "award_amount": 3.5,
      "name": "ET Reward Financial Achievement",
      "id": "22A77647D60A4720BDDE06E3AABFA9FF",
      "category": null
    },
    {
      "award_conditions_set": {
        "transaction_condition": {
          "transaction_amount_to": 50,
          "transaction_amount_from": 5
        },
        "location_conditions_set": null,
        "period_conditions": {
          "time_period_uot": null,
          "time_period_value": null
        },
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "S5",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T15:11:36",
        "updated_date": "2016-07-13T13:59:58",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "award_percentage": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "IRTB",
        "name": "Increase Revenue, Transaction Based",
        "description": null,
        "id": "78C608798CA847869FCFB0FF4999E546",
        "classification": "INCREASE_REVENUE_TRANSACTION_BASED"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-13 13:59:58.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "84",
      "name": "SB3_Offer 5",
      "id": "3EEB11E629A441C08A3A4E6EB504BDFE",
      "category": null
    },
    {
      "award_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            [
              {
                "day_of_week": "THURSDAY"
              }
            ]
          ],
          "hours_condition_set": []
        },
        "transaction_condition": {},
        "location_conditions_set": {
          "location_set": [
            {
              "area": "Lakatamia",
              "city": "Nicosia",
              "district": "Lefkosias"
            },
            {
              "area": "Aglantzia",
              "city": "Nicosia",
              "district": ""
            },
            {
              "area": "",
              "city": "Limassol",
              "district": ""
            }
          ]
        },
        "period_conditions": {
          "time_period_uot": "WEEKS",
          "time_period_value": 1
        },
        "product_conditions_set": {
          "product_set": []
        },
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "UWNC",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-11T09:21:14",
        "updated_date": "2016-07-14T11:50:27",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "award_percentage": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "UFCE",
        "name": "Utilise Free Capacity ET",
        "description": null,
        "id": "4B9AD34AA9334F3DB9F6668D1B0E0DB2",
        "classification": "UTILISE_FREE_CAPACITY"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-14 09:46:20.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "48",
      "name": "ET Utilise Free Capacity",
      "id": "EDC5AF03BD394966B326EE63985928B0",
      "category": null
    },
    {
      "award_conditions_set": {
        "transaction_condition": {
          "transaction_amount_to": null,
          "transaction_amount_from": 0.5
        },
        "location_conditions_set": {
          "location_set": [
            {
              "area": "Strovolos",
              "city": "",
              "district": ""
            }
          ]
        },
        "period_conditions": {
          "time_period_uot": "WEEKS",
          "time_period_value": 1
        },
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "EIRTB",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-11T14:01:43",
        "updated_date": "2016-07-14T09:46:54",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "award_percentage": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "IRTE",
        "name": "Incr. Rev Trans ET",
        "description": null,
        "id": "02208950880541DBBC655E6006A6DCAD",
        "classification": "INCREASE_REVENUE_TRANSACTION_BASED"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-14 09:46:54.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "53",
      "name": "ET Increase Revenue Transaction Based ",
      "id": "FB88EBA17B714789BB566CE8E1480D1B",
      "category": null
    },
    {
      "award_conditions_set": {
        "location_conditions_set": {
          "location_set": [
            {
              "area": "",
              "city": "Limassol",
              "district": ""
            }
          ]
        },
        "period_conditions": {
          "time_period_uot": "YEARS",
          "time_period_value": 1
        },
        "product_conditions_set": [
          {
            "product_family": null,
            "product": {
              "code": "Bronze",
              "product_type": {
                "service_type": "TERMED",
                "used_for_provisioning": true,
                "alternative_code": "Main Packages",
                "composition_method": "FLAT",
                "name": "Main Packages",
                "description": null,
                "id": "E186E293AAAB49EE86A729540A4287FE",
                "classification": "SERVICES",
                "physical_good_type": null
              },
              "alternative_code": "B",
              "description": null,
              "id": "F50CC52934BD4F119B6E18E215A4FC55"
            },
            "product_type": null,
            "purchase_event_amount_condition": {
              "amount_from": 1.5,
              "amount_to": null
            }
          },
          {
            "product_family": null,
            "product": {
              "code": "Expense 1",
              "product_type": {
                "service_type": "EXPENSE",
                "used_for_provisioning": false,
                "alternative_code": "006",
                "composition_method": "FLAT",
                "name": "Fees",
                "description": "Fees One Time Services",
                "id": "6",
                "classification": "SERVICES",
                "physical_good_type": null
              },
              "alternative_code": "E1",
              "description": null,
              "id": "A9917A7895044BEF9499DD6958539D33"
            },
            "product_type": null,
            "purchase_event_amount_condition": {
              "amount_from": null,
              "amount_to": 2
            }
          }
        ],
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "EIRPB",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-11T14:21:25",
        "updated_date": "2016-07-14T09:47:00",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "award_percentage": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "IRPE",
        "name": "Inc. Rev Product ET",
        "description": null,
        "id": "C466037AA96249078BA306E0BC00D2DB",
        "classification": "INCREASE_REVENUE_PRODUCT_BASED"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-14 09:47:00.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "54",
      "name": "ET Increase Revenue Product Based",
      "id": "F8AC0EF7DC034D82946480DB0E6FBE5D",
      "category": null
    },
    {
      "award_conditions_set": {
        "location_conditions_set": {
          "location_set": [
            {
              "area": "",
              "city": "",
              "district": "Livadia"
            },
            {
              "area": "Strovolos",
              "city": "Limassol",
              "district": ""
            },
            {
              "area": "Strovolos",
              "city": "",
              "district": "Livadia"
            }
          ]
        },
        "period_conditions": {
          "time_period_uot": "MONTHS",
          "time_period_value": 6
        },
        "achievement_conditions_set": {
          "classification": [
            {
              "alternative_code": "CF2",
              "name": "Customer Feedback 2",
              "id": "E27D1F25A1AC4409947F1FF2DDB8CBF5"
            }
          ]
        },
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "ERA",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T07:54:45",
        "updated_date": "2016-07-14T12:05:10",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RAE",
        "name": "Reward Achievement ET",
        "description": null,
        "id": "97773F29D5B34912ACD4A4D04D468CF8",
        "classification": "REWARD_ACHIEVEMENTS"
      },
      "evaluation_method": "BATCH_PROCESS",
      "latest_effective_date": "2016-07-14 09:47:51.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "57",
      "award_amount": 5.6,
      "name": "ET Reward Achievement",
      "id": "13D82246806B42039111A911B3A2BDE3",
      "category": null
    },
    {
      "award_conditions_set": {
        "behavior_conditions": {
          "facebook_page_like": "www.facebook.com/polina",
          "award_facebook_likes": 1,
          "award_website_visit": 0
        },
        "period_conditions": {
          "time_period_uot": "MONTHS",
          "time_period_value": 1
        },
        "segment_conditions_set": [],
        "organisational_unit_conditions_set": []
      },
      "alternative_code": "ERB",
      "reward_offer_validity": {
        "validity_options": "VALID_FROM_LATEST_EFFECTIVE_DATE"
      },
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-07-12T07:51:26",
        "updated_date": "2016-07-13T15:13:27",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "privacy_level": null,
      "reward_scheme": {
        "alternative_code": "MS",
        "name": "Marketing Scheme",
        "description": null,
        "id": "6CAAD517743C4C179251282A5B2B58A6",
        "life_cycle_state": "EFFECTIVE"
      },
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "life_cycle_state": "EFFECTIVE",
      "spend_conditions_set": {
        "time_conditions_set": {
          "days_condition_set": [
            []
          ],
          "hours_condition_set": []
        },
        "product_conditions_set": [],
        "organisational_unit_conditions_set": [],
        "allowed_spend_period_after_award": {
          "time_period_uot": null,
          "time_period_value": null
        }
      },
      "type": {
        "alternative_code": "RE_2",
        "name": "RB ET",
        "description": null,
        "id": "3430C4A0167D44EDA7808DB2A85A2603",
        "classification": "REWARD_BEHAVIOR"
      },
      "evaluation_method": "BATCH_PROCESS_AND_INTERACTIVELY",
      "latest_effective_date": "2016-07-13 15:13:27.0",
      "reward_award_validity": {
        "validity_options": "ALWAYS_VALID"
      },
      "number": "56",
      "award_amount": 3.25,
      "name": "ET Reward Behavior",
      "id": "62093E7885EE42088CA25F1E7BB3B685",
      "category": null
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Example 3

HTTP Method: POST

Request:

http://cyn1lnx004:9080/crmapi/rest/v2/reward_offers/list

Body:

{
"token":"163317CACB7441CD88CB01C5427DF6E7",
"rewards_participant_identifier":{"number":"RP0000000306"},
"type_identifier":{"name":"Reward on Birthday"}
}

Response:

{
    "data": [
        {
            "award_conditions_set": {
                "birthday_condition": "DURING_BIRTHDAY_MONTH",
                "segment_conditions_set": [
                    {
                        "segment": {
                            "number": "2",
                            "alternative_code": "EP",
                            "name": "Effective rewards participants",
                            "description": null,
                            "id": "9BCA8988077543B8B1A30D10DEE14440"
                        },
                        "option": "INCLUDE"
                    }
                ],
                "organisational_unit_conditions_set": [
                    {
                        "unit": null,
                        "group": {
                            "alternative_code": "MG",
                            "name": "Main Group",
                            "description": "Main Group",
                            "id": "1"
                        }
                    }
                ]
            },
            "alternative_code": "5EOB",
            "reward_offer_validity": {
                "validity_options": "VALID_DURING_BIRTHDAY_PERIOD",
                "valid_to": "9/2/2018",
                "valid_x_days_before_birthday_date": 3,
                "valid_from": "3/2/2018",
                "valid_x_days_after_birthday_date": 3
            },
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2016-03-24T09:42:58",
                "updated_date": "2018-02-06T10:58:02",
                "updated_by_user": {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": null,
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "pdemou",
                    "id": "6403BD50DF4A4EA59C406FF686FEAB54",
                    "email": "p_demou@crm.com",
                    "username": "pdemou"
                }
            },
            "reward_scheme": {
                "alternative_code": "MS",
                "name": "Marketing Scheme",
                "description": null,
                "id": "6CAAD517743C4C179251282A5B2B58A6",
                "life_cycle_state": "EFFECTIVE"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "description": null,
            "apply_if_best_award_is_provided": false,
            "spend_method": null,
            "life_cycle_state": "EFFECTIVE",
            "spend_conditions_set": {
                "time_conditions_set": {
                    "days_condition_set": [
                        []
                    ],
                    "hours_condition_set": []
                },
                "product_conditions_set": [],
                "organisational_unit_conditions_set": [],
                "allowed_spend_period_after_award": {
                    "time_period_uot": null,
                    "time_period_value": null
                }
            },
            "type": {
                "alternative_code": "ROB",
                "name": "Reward on Birthday",
                "description": null,
                "id": "771F28B7D0F54EDB8004D6FB302C621B",
                "classification": "REWARD_ON_BIRTHDAY"
            },
            "evaluation_method": "BATCH_PROCESS",
            "latest_effective_date": "2016-08-03T13:27:01",
            "reward_award_validity": {
                "validity_options": "ALWAYS_VALID"
            },
            "number": "26",
            "award_amount": 5,
            "name": "5 euro on Birthday",
            "id": "5DE44D90F5BC4F5889B6A5C2623F6F35",
            "award_scope": null,
            "category": null,
            "marketing_information": {
                "short_description": null,
                "times_awarded_status_text": null,
                "average_weekly_awarded_amount_text": null,
                "long_description": null,
                "no_awards_status_text": null,
                "offer_image": {
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                },
                "offer_background": {
                    "color": null,
                    "file_name": null,
                    "file_alt_text": null,
                    "file_content_url": null,
                    "file_mime_type": null
                }
            }
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}