Page Comparison

Tip
Available from CRM.COM R15.0.0

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscription Identifier

The identifier of the subscription for which rates should be returned as a result. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

job_identifier

(semi-optional)

Job Identifier

The identifier of the job for which rates should be returned as a result. The allowed job identifier fields are the following:

Include Page

	V4:job_identifier
	V4:job_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable for which a sale is made against and for which rates should be returned as a result. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

product_identifier

(semi-optional)

Product Identifier

The identifier of the product whose price plan rates should be returned as a result. The allowed product identifier fields are the following:

Include Page

	V4:product_identifier
	V4:product_identifier

Tip

If a single product is defined then only rates for the specific product will be retrieved.

Up to CRM.COM R17.0.0

In this case if there is different pricing per quantity (i.e. traceable physical goods in jobs or sales) it is not possible to return. In order to be able to return the exact pricing which considers tiered rates then no product must be defined.
- In case the product is a non-traceable physical good and the quantity is provided along with the product then the tiered rate can be returned

If no product is defined then a rate or a list of rates is retrieved for each product included in the billable entity

From CRM.COM R17.0.0

For all products, all tiered rates are retrieved

Tip
For CRM.COM R17.0.0, product_identifier is semi-optional and if a product is provided then the tiered rates are provided as well

date

(optional)

Date

The date for which you want to see the available rates for.

Applicable for all products apart from termed services

from_date

(optional)

The date from which the termed service is rated for.

Applicable only for termed services

to_date

(optional)

The date up to which the termed service is to be rated.

Applicable only for termed services

quantity

(optional)

The quantity of the physical goods or termed services.

Applicable only for physical goods and termed services (multiple viewing points)

duration

(optional)

The duration of the one time service.

Applicable only for one time services

usage_amount

(optional)

The usage amount of the usage service.

Applicable only for usage services

usage_zone

(optional)

The usage zone the required usage service belongs to.

Applicable only for usage services

rate_model

(optional)

String

The price plan rate model that determines how the calculation will be performed in order to retrieve a product's final price. If specified then price plan rates that are following the specific rate model will be retrieved, otherwise price plan rates of any model will be retrieved. The allowed price plan rate models are the following:

QUANTITYBASED
QUANTITYANDMATURITYBASED
BILLABLEPERIODBASED (FLATRATEMATURITYBASED)
DURATIONBASED
FLATFEEBASED (FLATRATE)
USAGEBASED (NEW)

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

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

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.

Response Data

Include Page

	V4:Copy of price_plan_rates_complete
	V4:Copy of price_plan_rates_complete

...

Expand

title	Example 1

HTTP Method: GET

Request:

{{server}}/crmapi/rest/v2/pricing/get_rates?token={{token}}&subscription_identifier=number=S0000009439&number_of_results=5&offset=1&product_identifier=code=Bronze

Response:

{ "data": [ { "product": { "code": "Bronze", "product_type": { "meter_reading_type": null, "service_type": "TERMED", "used_for_provisioning": true, "alternative_code": "Main Packages", "udr_type": null, "composition_method": "FLAT", "name": "Main Packages", "description": null, "id": "E186E293AAAB49EE86A729540A4287FE", "classification": "SERVICES", "physical_good_type": null }, "alternative_code": "B", "description": "Bronze", "id": "F50CC52934BD4F119B6E18E215A4FC55", "priority_level": null }, "code": "1766229", "price_plan": { "code": "SOA_4", "name": "SOA 4", "effective_date": "2018-05-18T00:00:00", "description": null, "id": "157440BB0DEC436CAA403362DDC03A43", "type": "BASE", "expiration_date": null }, "base_amount": 5, "rate_model": "BILLABLEPERIODBASED", "effective_starting_from": null, "uot": null, "time_period": null, "product_bundle": null, "tiered_rates_set": [] } ], "status": { "code": "OK", "description": "", "message": "" } }

...

Versions Compared

Old Version 11

New Version Current

Key

Response Data