Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Description | product_identifier (mandatory) | Product identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Include Page | product_identifier | product_identifier | source_system_identifier (optional) | Usage Detail Record Source System identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Include Page | usage_detail_record_source_system_identifier | usage_detail_record_source_system_identifier | type_identifier (mandatory) | Usage Detail Record Type identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Include Page | usage_detail_record_type_identifier | usage_detail_record_type_identifier |
| Tip |
|---|
Starting from CRM.COM R13.0.0 this information will be deprecated. The type will be set automatically based on the product type of the usage service specified |
usage_service_catalog_identifier
(mandatory on conditions)
| title | usage_detail_record parameter object data |
|---|
Name | Type | Description | |||||||||||||||||
product_identifier (mandatory) | Product identifier | The actual product that was used. The allowed product identifier fields are the following:
This information is mandatory unless the specified product belongs to only one usage service catalog. In that case the usage service catalog is set automatically.
| device_identifier (optional) | Usage Detail Record Device identifier | The identifier of the related usage detail record device. The allowed usage detail record device
Only products classified as usage services can be specified in this parameter | ||||||||||||||
source_system_identifier (optional) | Usage Detail Record Source System identifier | The source system of the usage detail record. The allowed usage detail source system identifier fields are the following:
| |||||||||||||||||
type_identifier (mandatory) | Usage Detail Record Type identifier | The type of the usage detail record. The allowed usage detail type identifier fields are the following:
| |||||||||||||||||
usage_service_catalog_identifier (optionalmandatory on conditions) | Usage Detail Record Usage Method Service Catalog identifier | The identifier of the related usage detail record usage methodservice catalog. The allowed usage detail record usage method service catalog identifier fields are the following: The identifier of the related usage detail record source category. The allowed usage detail record source category identifier fields are the following: Include Page | | usage_detail_record_source_category_identifier | usage_detail_record_source_category_identifier |
| Include Page | |||
|---|---|---|---|
|
source_category_identifier
(optional)
|
This information is mandatory unless the specified product belongs to only one usage service catalog. In that case the usage service catalog is set automatically.
| Tip |
|---|
From CRM.COM R13.1.0, this information is optional even if the specified product belongs to more than one usage service catalogs but only as long as these catalogs have distinct conditions From CRM.COM R14.0.0, if the requested usage service is included in the agreed pricing agreement (usage service catalog) of an Accounts Receivable, then the specified usage service catalog should be the agreed one. If not specified, then the agreed catalog will be used by default. This applies for adding usage services for Accounts Receivables that are members of an Account Group. If no such pricing agreement exists, the process will remain as is |
The total Tax amount that will be applied on the usage detail record. This information can be set only if the usage detail record is defined as pre-rated through the related usage service catalog. In that case it is mandatory to set this information.
| Tip |
|---|
Available from CRM.COM R12.0.0 |
discount_amount
(optional and applicable on conditions)
The discount amount that will be applied on the usage detail record. This information can be set only if the usage detail record is defined as pre-rated through the related usage service catalog
| Tip |
|---|
Available from CRM.COM R12.0.0 |
rating_date
(mandatory and applicable on conditions)
The date that the rating was applied on the usage detail record. This information can be set only if the usage detail record is defined as pre-rated through the related usage service catalog. In that case it is mandatory to set this information.
| Tip |
|---|
Available from CRM.COM R12.0.0 |
udf_string_1
(optional)
User Defined Field of type String
udf_string_2
(optional)
User Defined Field of type String
udf_string_3
(optional)
User Defined Field of type String
udf_string_4
(optional)
User Defined Field of type String
udf_string_5
(optional)
User Defined Field of type String
udf_string_6
(optional)
User Defined Field of type String
udf_string_7
(optional)
User Defined Field of type String
udf_string_8
(optional)
User Defined Field of type String
udf_string_9
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_string_10
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_string_11
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_string_12
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
device_identifier
(optional)
The identifier of the related usage detail record destination categorydevice. The allowed usage detail record destination category device identifier fields are the following:
udf_string_13
| Include Page | |||
|---|---|---|---|
|
billing_effective_date
(optional)
from_date
(mandatory based on conditions)
The date that the usage of the service started. Not mandatory if the usage service has a Unit of measurement
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 this information is always mandatory |
to_date
(mandatory based on conditions)
The date that the usage of the service stopped. Not mandatory if the usage service has a Unit of measurement
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 this information is always mandatory |
usage_amount
(mandatory on conditions)
The usage detail record total usage amount. This is applicable and mandatory only if the usage service is measurable, otherwise it is automatically set to 1
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 this information is always mandatory |
total_amount
(mandatory and applicable on conditions)
The total amount that the usage detail record will be rated for. This information can be set only if the usage detail record is defined as pre-rated through the related usage service catalog. In that case it is mandatory to set this information.
| Tip |
|---|
Available from CRM.COM R12.0.0 |
vat_amount
(mandatory and applicable on conditions)
The VAT amount that will be applied on the usage detail record. This information can be set only if the usage detail record is defined as pre-rated through the related usage service catalog. In that case it is mandatory to set this information.
| Tip |
|---|
Available from CRM.COM R12.0.0 |
tax_amount
(optional and applicable on conditions)
|
| Tip |
|---|
Deprecated from CRM.COM R15.0.0 |
usage_method_identifier
(optional)
The identifier of the related usage detail record usage method. The allowed usage detail record usage method identifier fields are the following:
| Include Page | ||||
|---|---|---|---|---|
|
| Tip |
|---|
Deprecated from CRM.COM R15.0.0 |
source_category_identifier
(optional)
The identifier of the related usage detail record source category. The allowed usage detail record source category identifier fields are the following:
| Include Page | ||||
|---|---|---|---|---|
|
| Tip |
|---|
Deprecated from CRM.COM R15.0.0 |
destination_category_identifier
(optional)
The identifier of the related usage detail record destination category. The allowed usage detail record destination category identifier fields are the following:
| Include Page | ||||
|---|---|---|---|---|
|
| Tip |
|---|
Deprecated from CRM.COM R15.0.0 |
billing_effective_date
(optional)
from_date
(mandatory based on conditions)
The date that the usage of the service started. Not mandatory if the usage service has a Unit of measurement
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 this information is always mandatory |
to_date
(mandatory based on conditions)
The date that the usage of the service stopped. Not mandatory if the usage service has a Unit of measurement
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 this information is always mandatory |
usage_amount
(mandatory on conditions)
The usage detail record total usage amount. This is applicable and mandatory only if the usage service is measurable, otherwise it is automatically set to 1
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 this information is always mandatory |
total_amount
(mandatory and applicable on conditions)
The total amount that the usage detail record will be rated for. This information can be set only if the usage detail record is defined as rated. In that case it is mandatory to set this information.
| Tip |
|---|
Available from CRM.COM R12.0.0 |
vat_amount
(mandatory and applicable on conditions)
The VAT amount that will be applied on the usage detail record. This information can be set only if the usage detail record is defined as rated.
| Tip |
|---|
Available from CRM.COM R12.0.0 |
tax_amount
(optional and applicable on conditions)
The total Tax amount that will be applied on the usage detail record. This information can be set only if the usage detail record is defined as rated.
| Tip |
|---|
Available from CRM.COM R12.0.0 |
discount_amount
(optional and applicable on conditions)
The discount amount that will be applied on the usage detail record. This information can be set only if the usage detail record is defined as rated
| Tip |
|---|
Available from CRM.COM R12.0.0 |
rating_date
(mandatory and applicable on conditions)
The date that the rating was applied on the usage detail record. This information can be set only if the usage detail record is defined as rated. In that case it is mandatory to set this information.
| Tip |
|---|
Available from CRM.COM R12.0.0 |
rated
(optional)
It defines if the usage service is already rated through a 3rd party system or not. It the value is true then it means that the service is already rated. It the value is false then it means that the service will be rated by CRM.COM
| Tip |
|---|
Available from CRM.COM R15.0.0 |
apply_additional_discount
(optional)
It defines if additional discount will be applicable on the already rated usage service. This option is applicable only if the usage service is classified as already rated
| Tip |
|---|
Available from CRM.COM R15.0.0 |
udf_string_1
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_string_142
(optional)
User Defined Field of type String
udf_string_153
(optional)
User Defined Field of type String
tipAvailable from CRM.COM R14.2.0
udf_string_164
(optional)
User Defined Field of type String
tipAvailable from CRM.COM R14.2.0
udf_floatstring_15
(optional)Float
User Defined Field of type FloatString
udf_floatstring_26
(optional)Float
User Defined Field of type FloatString
udf_floatstring_37
(optional)Float
User Defined Field of type FloatString
udf_floatstring_48
(optional)Float
User Defined Field of type FloatString
udf_float_51
(optional)
Float
User Defined Field of type Float
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_float_62
(optional)
Float
User Defined Field of type Float
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_float_73
(optional)
Float
User Defined Field of type Float
udf_float_84
(optional)
Float
User Defined Field of type Float
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
provisioning_distributor_identifier
(mandatory on conditions)
The identifier of the provisioning distributor that will be used to distribute the product. The allowed provisioning distributor identifier fields are the following:
| Include Page | ||||
|---|---|---|---|---|
|
This information is mandatory unless the specified subscription service is distributed to only one provisioning distributor. In that case the provisioning distributor is set automatically.
| Tip |
|---|
Deprecated from CRM.COM R15.0.0 |
installed_item_identifier
(mandatory on conditions)
The identifier of the installed item on which the service will be consumed. The allowed identifier fields are the following
| Include Page | ||||
|---|---|---|---|---|
|
This parameter is mandatory if the related Usage Service Catalog requires an Installed Item to be specified when adding a Usage Service
| Tip |
|---|
Available from CRM.COM R14.0.0 |
(mandatory)
An existing subscription service, classified as termed service that will be related with the usage detail record
This information is mandatory if the usage service's related usage service catalog set the "Termed Service Requirements" to any of the following:
- Requires an effective termed service OR
- Requires a termed service (effective or not effective)
If it is mandatory to specify this information then if only one termed service can be used to allow the addition of usage detail record then this information will be set automatically
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 this information is always mandatory and always mandatory and from CRM.COM R13.0.0 this information is mandatory on conditions From CRM.COM R14.0.0 this information is always mandatory |
(optional)
The set of metadata attributes and values associated to the specific udr
| Tip |
|---|
Available from CRM.COM R13R15.0.0 this information is mandatory on conditionsFrom CRM.COM R14.0.0 this information is always mandatory |
You can only add existing metadata attributes which are already provided through the UDR Type
Anchor subscription_usage_data_record_object parameters subscription_usage_data_record_object parameters
Referred Parameter Objects Data
| subscription_usage_data_record_object parameters | |
| subscription_usage_data_record_object parameters |
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|