- Created by George Rossides, last modified on Nov 25, 2016
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved wallet |
| balance | Number | The balance of the retrieved wallet |
| currency | Currency Object | The wallet's currency |
| allotment_group_conditions_set | Set of Wallet Allotment Group Condition Objects | Information related with the amount allotted by the wallet grouped by the conditions related with the each allotted amount |
Referred Objects 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 |
Name | Type | Description |
| id | String | The ID of the retrieved wallet allotment group condition |
| number_of_conditions | Number | The total number of conditions related with the retrieved wallet allotment group condition |
| total_amount | Number | The total amount in wallet currency, that is allotted by the retrieved wallet allotment group condition |
| total_alternative_amount | Number | The total amount in wallet alternative currency, that is allotted by the retrieved wallet allotment group condition Available from CRM.COM R14.2.0 |
| allotment_group_opening_balance | Number | The opening balance of this wallet allotment group of conditions - in wallet currency - as this was calculated in the latest wallet balance period. Available from CRM.COM R12.0.0 |
| allotment_group_opening_alternative_balance | Number | The opening balance of this wallet allotment group of conditions - in wallet alternative currency - as this was calculated in the latest wallet balance period Available from CRM.COM R14.2.0 |
| opening_balance_date | Date | The date on which the allotment group of conditions balance was calculated Available from CRM.COM R12.1.0 |
| wallet_balance_period | Wallet Balance Period Object | The Wallet balance period within which this wallet allotment group condition falls within Available from CRM.COM R12.1.0 |
| time_conditions_set | Set of Allotment Time Condition Objects | The time conditions related with the retrieved wallet allotment group condition |
| product_conditions_set | Set of Allotment Product Condition Objects | The product conditions related with the retrieved wallet allotment group condition |
| unit_conditions_set | Set of Allotment Unit Condition Objects | The unit conditions related with the retrieved wallet allotment group condition |
| date_conditions_set | Set of Allotment Date Condition Objects | The date conditions related with the retrieved wallet allotment group condition |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
number | String | The Wallet Balance Period's number |
name | String | The Wallet Balance Period's name |
| from_date | Date | The Wallet Balance Period's from date |
| to_date | Date | The Wallet Balance Period's to date |
| life_cycle_state | Sting | The Wallet Balance Period's life cycle state. Available values are OPEN and CLOSED |
| closed_date | Date | The Wallet Balance Period's closed date. Available only for Wallet Balance Periods in Closed life cycle state |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved allotment condition |
| from | Number | The start of the time period condition related with the retrieved allotment condition |
| to | Number | The end of the time period condition related with the retrieved allotment condition |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved allotment condition |
| product | Product object | The product related with the retrieved allotment condition |
| product_type | Product Type object | The product type related with the retrieved allotment condition |
| product_family | Product Family object | The product family related with the retrieved allotment condition Available from CRM.COM Rx.0.0 |
| product_brand | Product Brand object | The product brand related with the retrieved allotment condition Available from CRM.COM R15.0.0 |
| product_category | Product Category object | The product category related with the retrieved allotment condition Available from CRM.COM R15.0.0 |
Referred Objects 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
| 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
| 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
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 |
| 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
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 |
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:
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
|
| uot | String | The 'UOT' applicable for the rate
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
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 |
| 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
| 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
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 |
| 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
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 |
| 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 |
| 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 |
| 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 |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved allotment condition |
| business_unit | Business Unit Object | The business unit related with the retrieved allotment condition Available from CRM.COM R18.0.0 |
| unit | Unit object | The unit related with the retrieved allotment condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit) |
| group | Group object | The group related with the retrieved allotment condition Deprecated from CRM.COM R18.0.0 (replaced with business_unit) |
Referred Objects 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 |
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 |
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 |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved allotment condition |
| day_of_week | Number | The day of week condition related with the retrieved allotment condition. The supported values are the following: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
- No labels