usage_service_catalog_usage_services_parameters

usage_service_catalog_usage_services parameter object data

Name

Type

Description

usage_service_identifier

(semi-optional)

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

product_family_identifier

(semi-optional)

Product Family Identifier

The identifier of the related product family of the usage service

The allowed product family identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of a product family

Available from CRM.COM R17.0.0

product_category_identifier

(semi-optional)

Product Category Identifier

The identifier of the related product category of the usage service

The allowed product category identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of a product category

Available from CRM.COM R17.0.0

start_date

(optional)

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)

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)

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)

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)

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)

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)

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

usage_service

(semi-optional)

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.

tiered_rates_set

(optional)

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

Deprecated from CRM.COM R15.0.0

Referred Parameter Objects Data

product parameter object 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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product type

name

(semi-optional)

String

The name of the product type

alternative_code

(semi-optional)

String

The alternative code of a product type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the VAT rate

name

(semi-optional)

String

The name of the VAT rate

alternative_code

(semi-optional)

String

The alternative code of the VAT rate

brand_identifier

(optional)

Product Brand Identifier

The identifier of the product brand. The allowed product brand identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product brand

name

(semi-optional)

String

The name of the product brand

alternative_code

(semi-optional)

String

The alternative code of a product brand

family_identifier

(optional)

Product Family Identifier

The identifier of the product family. The allowed product family identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of a product family

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

validity_set

(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

categories_set

(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

product_validity parameter object 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

product_categories parameter object data

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

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of a product category

usage_service_tiered_rates parameter object data

Name

Type

Description

rate

(mandatory)

Float

The rate of the usage service tiered rate

minimum_usage

(semi-optional)

Float

The minimum usage of the service that should be applied in order for the specified rate to be applicable

maximum_usage

(semi-optional)

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)

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record usage_method

name

(semi-optional)

String

The name of the usage detail record usage_method

alternative_code

(semi-optional)

String

The alternative code of the usage detail record usage_method

device_identifier

(semi-optional)

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record device

name

(semi-optional)

String

The name of the usage detail record device

alternative_code

(semi-optional)

String

The alternative code of the usage detail record device

source_category_identifier

(semi-optional)

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record source category

name

(semi-optional)

String

The name of the usage detail record source category

code

(semi-optional)

String

The code of the usage detail record source category

destination_category_identifier

(semi-optional)

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record destination category

name

(semi-optional)

String

The name of the usage detail record destination category

code

(semi-optional)

String

The code of the usage detail record destination category

usage_start_time

(semi-optional)

Hour / Minute Object

The usage start time during which the specified rate is applicable

usage_end_time

(semi-optional)

Hour / Minute Object

The usage end time during which the specified rate is applicable

Referred Parameter Objects

hour / minute parameter object data

Name

Type

Description

hour

(mandatory)

Number

The hour value

minute

(mandatory)

Number

The minute value