reward_offer_award_conditions_short

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