usage_service_catalog_usage_services_update_parameters
George Rossides (Unlicensed)
Joseph Ioannou (Unlicensed)
Georgia Kountouri
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| action (mandatory) | String | Defines if a new or existing information will be updated.The supported values are the following: ADD, UPDATE, REMOVE | ||||||||||||
usage_service_catalog_identifier (mandatory and applicable only on update or remove) | Usage Service Catalog Usage Service Identifier | The usage service catalog usage service entry that will be updated or removed. This is applicable only if the specified action is set to update or remove. The allowed usage service catalog usage service identifier fields are the following:
| ||||||||||||
usage_service_identifier (semi-optional on add, not applicable on update or remove) | Usage Service Identifier | The identifier of the related usage service. This is applicable only when adding existing products in a usage service catalog. Only products classified as usage services can be added in a usage service catalog. This information is mandatory unless a usage service (object) is specified. The allowed usage service identifier fields are the following:
Note that this information is applicable only if the specified action is set to add | ||||||||||||
product_family_identifier (semi-optional on add, not applicable on update or remove) | Product Family Identifier | The identifier of the related product family of the usage service The allowed product family identifier fields are the following
Available from CRM.COM R17.0.0 | ||||||||||||
product_category_identifier (semi-optional on add, not applicable on update or remove) | Product Category Identifier | The identifier of the related product category of the usage service The allowed product category identifier fields are the following
Available from CRM.COM R17.0.0 | ||||||||||||
start_date (optional on add, optional on update, not applicable on remove) | String | The date and time during which the provisioning of the usage service catalog usage service will start Deprecated from CRM.COM R17.0.0 | ||||||||||||
end_date (optional on add, optional on update, not applicable on remove) | String | The date and time during which the provisioning of the usage service catalog usage service will end Deprecated from CRM.COM R17.0.0 | ||||||||||||
base_rate (mandatory on conditions and applicable only on add or update, not applicable on remove) | Float | The base rate of the usage service catalog usage service. This information is mandatory unless a default rate, related with the type of the specified usage service, was defined in the active usage service catalog definitions. Deprecated from CRM.COM R15.0.0 | ||||||||||||
provisioning_id (mandatory and applicable on conditions on add, optional on update, not applicable on remove) | String | The ID used to provision the specified usage service. This information is applicable and mandatory only if the related usage service is classified as a provisioning service Deprecated from CRM.COM R15.0.0 | ||||||||||||
pre_rated (optional on add and update, not applicable on remove) | Boolean | It defines if the 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 nor mandatory Available from CRM.COM R12.0.0 Deprecated from CRM.COM R15.0.0 | ||||||||||||
apply_additional_discount (optional on add and update, not applicable on remove) | 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 Available from CRM.COM R13.0.0 Deprecated from CRM.COM R15.0.0 | ||||||||||||
udf_string_1 (optional on add, optional on update, not applicable on remove) | String | User Defined Field of type String | ||||||||||||
udf_string_2 (optional on add, optional on update, not applicable on remove) | String | User Defined Field of type String | ||||||||||||
udf_string_3 (optional on add, optional on update, not applicable on remove) | String | User Defined Field of type String | ||||||||||||
udf_string_4 (optional on add, optional on update, not applicable on remove) | String | User Defined Field of type String | ||||||||||||
udf_string_5 (optional on add, optional on update, not applicable on remove) | String | User Defined Field of type String | ||||||||||||
udf_string_6 (optional on add, optional on update, not applicable on remove) | String | User Defined Field of type String | ||||||||||||
udf_string_7 (optional on add, optional on update, not applicable on remove) | String | User Defined Field of type String | ||||||||||||
udf_string_8 (optional on add, optional on update, not applicable on remove) | String | User Defined Field of type String | ||||||||||||
udf_float_1 (optional on add, optional on update, not applicable on remove) | Float | User Defined Field of type Float | ||||||||||||
udf_float_2 (optional on add, optional on update, not applicable on remove) | Float | User Defined Field of type Float | ||||||||||||
udf_float_3 (optional on add, optional on update, not applicable on remove) | Float | User Defined Field of type Float | ||||||||||||
udf_float_4 (optional on add, optional on update, not applicable on remove) | Float | User Defined Field of type Float | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_2 (optional on add, optional on update, not applicable on remove) | Date | User Defined Field of type Date | ||||||||||||
udf_date_3 (optional on add, optional on update, not applicable on remove) | Date | User Defined Field of type Date | ||||||||||||
udf_date_4 (optional on add, optional on update, not applicable on remove) | Date | User Defined Field of type Date | ||||||||||||
(semi-optional on add, not applicable on update and remove) | Product Object | The related usage service. This is applicable only when adding new products in a usage service catalog. Only products classified as usage services can be added in a usage service catalog. This information is mandatory unless a usage service identifier is specified. Note that this information is applicable only if the specified action is set to add | ||||||||||||
(optional on add, optional on update, not applicable on remove) | Set of Usage Service Tiered Rates Objects | The tiered rates related with the usage service catalog usage service, which are different than the specified base rate, and are applied upon meeting a set of conditions
If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
Deprecated from CRM.COM R15.0.0 |
Referred Parameter Objects Data
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
code (mandatory) | String | The code of the product | ||||||||||||
alternative_code (mandatory) | String | The alternative code of the product. If not specified then it is generated automatically based on the specified product code | ||||||||||||
type_identifier (mandatory) | Product Type Identifier | The identifier of the product type. The allowed product type identifier fields are the following:
For releases prior CRM.COM R14.0.0, the name of this parameter is type From CRM.COM R14.0.0 and onwards, the name of this parameter is type_identifier | ||||||||||||
vat_rate_identifier (mandatory) | VAT Rate Identifier | The identifier of the VAT rate that will be applicable on the product. The allowed VAT rate identifier fields are the following:
| ||||||||||||
brand_identifier (optional) | Product Brand Identifier | The identifier of the product brand. The allowed product brand identifier fields are the following:
| ||||||||||||
family_identifier (optional) | Product Family Identifier | The identifier of the product family. The allowed product family identifier fields are the following:
For releases prior CRM.COM R14.0.0, the name of this parameter is family From CRM.COM R14.0.0 and onwards, the name of this parameter is family_identifier | ||||||||||||
description (mandatory) | String | The description of the product | ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||
(optional) | Set of Product Validity Objects | The time periods during which the product will be available to be used. If not specified then the product will be always be available | ||||||||||||
(optional) | Set of Product Category Objects | The categories related with the product. More than one categories can be specified. Each category can be specified just once. |
Referred Parameter Objects Data
| Name | Type | Description |
|---|---|---|
valid_from (mandatory) | Date | The date that the product will become valid |
valid_to (optional) | Date | The date that the product will become invalid. This is optional as a product can be valid for ever, starting from a specific date |
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category_identifier (mandatory) | Product Category Identifier | The identifier of the product category. The allowed product categories identifier fields are the following:
|
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| action (mandatory) | String | Defines if a new or existing information will be updated.The supported values are the following: ADD, UPDATE, REMOVE | ||||||||||||
tier_rate_identifier (mandatory and applicable only on update or remove) | Usage Service Tier Rate Identifier | The identifier of the tier rate that will be updated or removed. This is applicable only if the specified action is set to UPDATE or REMOVE. The allowed usage service tier rate identifier fields are the following:
| ||||||||||||
rate (mandatory on add, optional on update, not applicable on remove) | Float | The rate of the usage service tiered rate | ||||||||||||
minimum_usage (semi-optional on add, optional on update, not applicable on remove) | Float | The minimum usage of the service that should be applied in order for the specified rate to be applicable | ||||||||||||
maximum_usage (semi-optional on add, optional on update, not applicable on remove) | Float | The maximum usage of the service that should be applied in order for the specified rate to be applicable | ||||||||||||
usage_method_identifier (semi-optional on add, optional on update, not applicable on remove) | Usage Detail Record Usage Method Identifier | The usage method that should be used in order for the specified rate to be applicable. The allowed usage method identifier fields are the following:
| ||||||||||||
device_identifier (semi-optional on add, optional on update, not applicable on remove) | Usage Detail Record Device Identifier | The device that should be used in order for the specified rate to be applicable. The allowed device identifier fields are the following:
| ||||||||||||
source_category_identifier (semi-optional on add, optional on update, not applicable on remove) | Usage Detail Record Source Category Identifier | The source category that should be used in order for the specified rate to be applicable. The allowed source category identifier fields are the following:
| ||||||||||||
destination_category_identifier (semi-optional on add, optional on update, not applicable on remove) | Usage Detail Record Destination Category Identifier | The destination category that should be used in order for the specified rate to be applicable. The allowed destination category identifier fields are the following:
| ||||||||||||
(semi-optional on add, optional on update, not applicable on remove) | Hour / Minute Object | The usage start time during which the specified rate is applicable | ||||||||||||
(semi-optional on add, optional on update, not applicable on remove) | Hour / Minute Object | The usage end time during which the specified rate is applicable |
Referred Parameter Objects
Name | Type | Description |
|---|---|---|
hour (mandatory) | Number | The hour value |
minute (mandatory) | Number | The minute value |