You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 12
Next »
| Name | Type | Description |
|---|
| id | String | The ID of the retrieved usage service catalog usage service |
| base_rate | Float | The base rate of the retrieved usage service catalog usage service |
| start_date | String | The date and time during which the provisioning of the usage service catalog usage service will start |
| end_date | String | The date and time during which the provisioning of the usage service catalog usage service will end |
| provisioning_id | String | The ID used to provision the specified usage service. This information is applicable only if the related usage service is classified as a provisioning service |
| pre_rated | Boolean | It defines if the retrieved usage service catalog usage service is a pre-rated service or not. It the value is true then it means that the service is pre-rated. It the value is false then it means that the service is post-rated Note that if the service is pre-rated then the base rate and tier rates are not applicable |
| apply_additional_discount | Boolean | It defines if additional discount will be applicable on the pre-rated usage service. This option is applicable only if the usage service is classified as pre-rated |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| usage_service | Product Object | The related usage service. |
| log_information | Log Information Object | The log information of the retrieved usage service catalog usage service |
| tiered_rates_set | Set of Usage Service Tiered Rates Objects | The tiered rates related with the retrieved usage service catalog usage service, which are different than the specified base rate, and are applied upon meeting a set of conditions |
| additional_currency_rates | Set of Additional Currency Rate Objects | A list of base rates in various currencies for the same product within the specified usage service catalog |
| additional_currency_tiered_rates | Set of Additional Currency Tiered Rate Objects | A list of tiered rates in various currencies for the same product within the specified usage service catalog
|
Referred Objects Response Data
product object response data
| | |
|---|
| 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 |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| 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 |
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
|
| 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
- 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 |
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 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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 |
usage_service_tier_rates object data response
| Name | Type | Description |
|---|
| id | String | The id of the retrieved usage service tiered rate |
| rate | Float | The rate of the retrieved usage service tiered rate |
| minimum_usage | Float | The minimum usage of the service that should be applied in order for the specified rate to be applicable |
| maximum_usage | Float | The maximum usage of the service that should be applied in order for the specified rate to be applicable |
| usage_start_time | Hour / Minute Object | The usage start time during which the specified rate is applicable |
| usage_end_time | Hour / Minute Object | The usage end time during which the specified rate is applicable |
| usage_method | Usage Detail Record Usage Method Object | The usage method that should be used in order for the specified rate to be applicable |
| device | Usage Detail Record Device Object | The device that should be used in order for the specified rate to be applicable |
| source_category | Usage Detail Record Source Category Object | The source category that should be used in order for the specified rate to be applicable |
| destination_category | Usage Detail Record Destination Category Object | The destination category that should be used in order for the specified rate to be applicable |
Referred Objects Response Data
usage_detail_record_usage_method object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record usage method |
| name | String | The Name of the retrieved usage detail record usage method |
| alternative_code | String | The Alternative Code of the retrieved usage detail record usage method |
| description | String | The Description of the retrieved usage detail record usage method |
usage_detail_record_device object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record device |
| name | String | The Name of the retrieved usage detail record device |
| alternative_code | String | The Alternative Code of the retrieved usage detail record device |
| description | String | The Description of the retrieved usage detail record device |
usage_detail_record_source_category response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record source category |
| name | String | The Name of the retrieved usage detail record source category |
| code | String | The code of the retrieved usage detail record source category |
| description | String | The description of the retrieved usage detail record source category |
usage_detail_record_destination_category response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record destination category |
| name | String | The Name of the retrieved usage detail record destination category |
| code | String | The code of the retrieved usage detail record destination category |
| description | String | The description of the retrieved usage detail record destination category |
hour / minute object response data
Name | Type | Description |
|---|
| hour | Number | The hour value |
| minute | Number | The minute value |
additional currency rates object response data
| | |
|---|
| base_amount | Number | The base amount of the additional currency |
| currency | Currency Object | The Currency in which the base amount is specified |
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 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
additional currency rates object response data
| | |
|---|
| tiered_amount | Number | The tiered amount of the additional currency |
| currency | Currency Object | The Currency in which the tiered amount is specified |
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 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |