Versions Compared

Key

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

Available from CRM.COM R8.0.0

Excerpt

This method returns the rates of a specific usage service or any usage service which is included in a specific usage service catalog and are allowed to be used by subscribers, during the specified date. Multiple usage services rates are returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

valid_as_of_date

(mandatoryoptional)

Date

If specified then only usage services included in usage service catalogs which are valid on that date will be retrieved. If not specified then the current date is considered as the valid as of date.

Tip

In releases previous to CRM.COM R14.2.0 this information is mandatory

usage_service_identifier

(semi-optional)

Usage Service Identifier

If specified then only usage services rates related with the specified usage service will be retrieved. The allowed usage service identifier fields are the following:

Include Page
V4:product_identifier
V4:product_identifier

usage_service_catalog_identifier

(semi-optional)

Usage Service Catalog Identifier

If specified then only usage services included in that usage service catalogs will be retrieved. The allowed usage service catalog identifier fields are the following:

Include Page
V4:usage_service_catalog_identifier
V4:usage_service_catalog_identifier

provisioning_provider_identifier

(optional)

Provisioning Provider Identifier

If specified then only usage services included in usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:

Include Page
V4:provisioning_provider_identifier
V4:provisioning_provider_identifier

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

If specified then the only usage services included in usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

subscription_identifier

(optional)

Subscription Identifier

If specified then the only usage services included in usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

termed_service_identifier

(optional)

Product Identifier

If specified then the only usage services included in usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:

Include Page
V4:product_identifier
V4:product_identifier

group_identifier

(optional)

Group Identifier

The identifier of the group that will be using the usage services. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be using the usage services. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...