wallet_allotment_short

 wallet_allotment object response data

Name

Type

Description

idStringThe ID of the retrieved wallet allotment
group_condition_idString

The ID of the group condition related with the retrieved wallet allotment

Available from CRM.COM R8.0.0

amountNumberThe amount that was allotted by the retrieved wallet allotment in wallet currency
alternative_amountNumber

The amount that was allotted by the retrieved wallet allotment in wallet alternative currency

Available from CRM.COM R14.2.0


validity_dateDateThe date that the retrieved wallet allotment becomes valid for consumption
wallet_balance_dateDate

The date on which this wallet allotment was included in a Wallet Balance Period

Available from CRM.COM R12.0.0

wallet_balance_periodWallet Balance Period Object

The Wallet Balance Period within which this allotment falls within

Available from CRM.COM R12.0.0

time_conditions_setSet of Allotment Time Condition ObjectsThe time conditions related with the retrieved wallet allotment
product_conditions_setSet of Allotment Product Condition ObjectsThe product conditions related with the retrieved wallet allotment
unit_conditions_setSet of Allotment Unit Condition ObjectsThe unit conditions related with the retrieved wallet allotment
date_conditions_setSet of Allotment Date Condition ObjectsThe date conditions related with the retrieved wallet allotment

Referred Objects Response Data

 wallet balance period object response data

Name

Type

Description

number

String

The Wallet Balance Period's number

name

String

The Wallet Balance Period's name

from_dateDateThe Wallet Balance Period's from date
to_dateDateThe Wallet Balance Period's to date
life_cycle_stateStingThe Wallet Balance Period's life cycle state. Available values are OPEN and CLOSED
closed_dateDateThe Wallet Balance Period's closed date. Available only for Wallet Balance Periods in Closed life cycle state

 allotment_time_condition object response data

Name

Type

Description

id

String

The ID of the retrieved allotment condition

fromNumberThe start of the time period condition related with the retrieved allotment condition
toNumberThe end of the time period condition related with the retrieved allotment condition

 allotment_product_condition object response data

Name

Type

Description

id

String

The ID of the retrieved allotment condition

productProduct objectThe product related with the retrieved allotment condition
product_typeProduct Type objectThe product type related with the retrieved allotment condition
product_familyProduct Family object

The product family related with the retrieved allotment condition

Available from CRM.COM Rx.0.0


product_brandProduct Brand object

The product brand related with the retrieved allotment condition

Available from CRM.COM R15.0.0

product_categoryProduct Category object

The product category related with the retrieved allotment condition

Available from CRM.COM R15.0.0

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 product_family object data response
NameType Description
IdStringThe ID of the retrieved product family
nameStringThe Name of the retrieved product family
codeStringThe code of the retrieved product family
descriptionStringThe Description of the retrieved product family

 product_brand object data response
NameType Description
IdStringThe ID of the retrieved product brand
nameStringThe Name of the retrieved product brand
alternative_codeStringThe Alternative Code of the retrieved product brand
descriptionStringThe Description of the retrieved product brand

 product_category response data object
NameType Description
IdStringThe ID of the retrieved product category
nameStringThe Name of the retrieved product category
codeStringThe code of the retrieved product category
descriptionStringThe Description of the retrieved product category

 allotment_unit_condition object response data

Name

Type

Description

id

String

The ID of the retrieved allotment condition

business_unitBusiness Unit Object

The business unit related with the retrieved allotment condition

Available from CRM.COM R18.0.0

unitUnit object

The unit related with the retrieved allotment condition

Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

groupGroup object

The group related with the retrieved allotment 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_codeString

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

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 allotment_date_condition object response data

Name

Type

Description

id

String

The ID of the retrieved allotment condition

day_of_weekNumber

The day of week condition related with the retrieved allotment condition. The supported values are the following:

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