Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The actual product that was used. The allowed product identifier fields are the following:

Only products classified as usage services can be specified in this parameter

The source system of the usage detail record. The allowed usage detail source system

The identifier of the related usage detail record source category. The allowed usage detail record source category identifier fields are the following:

Expand
titleusage_detail_record parameter object data

Name

Type

Description

product_identifier

(mandatory)

Product identifier
Include Page
product_identifierproduct_identifier

source_system_identifier

(optional)

Usage Detail Record Source System identifier
Expand
titleusage_detail_record parameter object data

The type of the usage detail record. The allowed usage detail type identifier fields are the following:

Name

Type

Description

product_identifier

(mandatory)

Product identifier

The actual product that was used. The allowed product identifier fields are the following:

Include Page
product_identifier
product_identifier

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:

Include Page
usage_detail_record_source_system_identifier
usage_detail_record_source_system_identifier

Tip

Deprecated from CRM.COM R15.0.0

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:

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)

Usage Service Catalog identifier

The identifier of the related usage service catalog. The allowed usage service catalog identifier fields are the following:

Include Page
usage_detail_record_source_systemservice_catalog_identifier
usage_detail_record_source_system_identifier

Tip

Deprecated from CRM.COM R15.0.0

type_identifier

(mandatory)

 Usage Detail Record Type identifier
Include Page
usage_detail_record_type_identifierusage_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)

Usage Service Catalog

service_catalog_identifier

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


device_identifier

(optional)

Usage Detail Record Device identifier

The identifier of the related usage service catalogdetail record device. The allowed usage service catalog detail record device identifier fields are the following:

device

Include Page
usage_servicedetail_catalogrecord_identifierusage_service_catalog_identifier

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

device_identifier
usage_detail_record_device_identifier

Tip

Deprecated from CRM.COM R15.0.0

usage_method_identifier

(optional)

Usage Detail Record Usage Method identifier

The identifier of the related usage detail record usage method. The allowed usage detail record usage method identifier fields are the following:

Include Page
usage_detail_record_usage_method_identifier
usage_detail_record_usage_method_identifier

Tip

Deprecated from CRM.COM R15.0.0

source_category_identifier

(optional)

Usage Detail Record Device Source Category identifier

The identifier of the related usage detail record devicesource category. The allowed usage detail record device source category identifier fields are the following:

Include Page
usage_detail_record_source_devicecategory_identifier
usage_detail_record_recordsource_devicecategory_identifier

Tip

Deprecated from CRM.COM R15.0.0

usagedestination_methodcategory_identifier

(optional)

Usage Detail Record Usage Method Destination Category identifier

The identifier of the related usage detail record usage methoddestination category. The allowed usage detail record usage method destination category identifier fields are the following:

Include Page
usage_detail_record_usagedestination_methodcategory_identifier
usage_detail_record_usagedestination_methodcategory_identifier

Tip

Deprecated from CRM.COM R15.0.0

sourcebilling_categoryeffective_identifierdate

(optional)

Usage Detail Record Source Category identifier
Include Page
usage_detail_record_source_category_identifierusage_detail_record_source_category_identifier
Tip

Deprecated from CRM.COM R15.0.0

destination_category_identifier

(optional)

Usage Detail Record Destination Category identifier

The identifier of the related usage detail record destination category. The allowed usage detail record destination category identifier fields are the following:

Include Pageusage_detail_record_destination_category_identifierusage_detail_record_destination_category_identifier
Tip

Deprecated from CRM.COM R15.0.0

billing_effective_date

(optional)

DateThe usage detail record billing effective date

from_date

(mandatory based on conditions)

DateThe date that the usage of the service started. Not mandatory if the usage service has a Unit of measurementDateThe usage detail record billing effective date

from_date

(mandatory based on conditions)

Date

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)

Number

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)

Number

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

tototal_dateamount

(mandatory based and applicable on conditions)

Number

The date total amount 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

usagedetail 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)

Number

The VAT amount that will be applied on the usage detail record total usage amount. This is applicable and mandatory information can be set only if the usage service is measurable, otherwise it is automatically set to 1detail record is defined as rated.

Tip

For releases prior to Available from CRM.COM R13R12.0.0 this information is always mandatory

totaltax_amount

(mandatory optional and applicable on conditions)

Number 

The total Tax amount that will be applied on 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


vatdiscount_amount

(mandatory optional and applicable on conditions)

Number

The VAT 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. In that case it is mandatory to set this information.

Tip

Available from CRM.COM R12.0.0

taxrating_amountdate

(optional mandatory and applicable on conditions)

 Date

The total Tax amount that will be 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

discount_amountrated

(optional and applicable on conditions)

NumberThe 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 catalogBoolean

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 R12R15.0.0

ratingapply_additional_datediscount

(mandatory and applicable on conditionsoptional)

DateThe date that the rating was applied on the usage detail record. This information can be set Boolean

 It defines if additional discount will be applicable on the already rated usage service. This option is applicable only if the usage detail record service is defined classified as pre-rated through the related usage service catalog. In that case it is mandatory to set this information.already rated

Tip

Available from CRM.COM R12R15.0.0

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

provisioning_distributor_identifier

(mandatory on conditions)

Provisioning Distributor Identifier

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
provisioning_distributor_identifier
provisioning_distributor_identifier

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)

Installed Item Identifier

The identifier of the installed item on which the service will be consumed. The allowed identifier fields are the following

Include Page
installed_item_identifier
installed_item_identifier

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

subscription_service

(mandatory)

Existing Subscription service Object

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 from CRM.COM R13.0.0 this information is mandatory on conditions

From CRM.COM R14.0.0 this information is always mandatory

allowedmetadata_attribute_metadatavalue_set

(optional)

Set of Allowed Metadata Object

The set of allowed metadata attributes whose values will be set upon the creation of the and values associated to the specific udr

Tip

Available from CRM.COM R15.0.0

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

Include Page
existing_subscription_service_parameter
existing_subscription_service_parameter

Include Page
allowed_metadata_attribute_value_parametersallowed_
metadata_attribute_value_parameters