- Created by George Rossides (Unlicensed), last modified by Georgia Kountouri on May 21, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 6 Next »
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved billing term scheme product |
| billing_type | String | The billing type of the retrieved billing term scheme product, which can be PREBILL or POSTBILL for Normal Billing Term Schemes or POSTRATE or PRERATE for Prepaid Billing Term Schemes. Billing type FREE is available for both Normal and Prepaid billing term schemes PRERATE and POSTRATE billing types available from CRM.COM R9.0.0 FREE billing type available from CRM.COM R14.2.0 |
| period_billed_in_advance | Integer | Defines the period for which the billing tern scheme product will be pre-rated. Applicable only for billing term schemes with billing tye Prepaid and only for products whose billing type is set to PRERATE. Available from CRM.COM R9.0.0 Deprecated from CRM.COM R14.0.0 |
| period_billed_in_advance_uot | String | The unit of time that measures the specified period billed in advance. The supported values are DAYS, WEEKS or MONTHS. Applicable only if period billed in advance is specified for a Prepaid billing term scheme product which is also classified as to be Pre-Rated. Available from CRM.COM R9.0.0 Deprecated from CRM.COM R14.0.0 |
| product | Product object | The actual billing term scheme product |
| periods_billed_in_advance | Periods Billed in Advance Set | Defines the allowed periods for which the specified service can be billed in advance. Applicable only for prepaid pre-rated services. Available from CRM.COM R14.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 |
|---|---|---|
period_billed_in_advance | Integer | Defines the period for which the billing tern scheme product will be pre-rated. Applicable only for billing term schemes with billing tye Prepaid and only for products whose billing type is set to PRERATE. |
period_billed_in_advance_uot | String | The unit of time that measures the specified period billed in advance. The supported values are DAYS, WEEKS or MONTHS. Applicable only if period billed in advance is specified for a Prepaid billing term scheme product which is also classified as to be Pre-Rated. |
| default | Boolean | Defines which period to bill in advance is the default one for the specified service |
- No labels