Skip to end of banner
Go to start of banner

GET pricing/get_rates

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Available from CRM.COM R15.0.0

This method returns the available price plan rates included in a price plan either for a specific product or for all products. Multiple price plan rates might be retrieved by each call. Price plan rates are retrieved by providing one and only one of the semi-optional parameters 

  • A specific subscription type: If specified then the process will retrieved all effective price plans which are allowed by the billing term schemes which are allowed by the specified subscription type
  • A specific job type: If specified then the process will retrieved all effective price plans which are allowed by the billing term schemes which are allowed by the specified job type

and optionally one of the following or both of the optional parameters: 

  • A specific product: If specified then the process will retrieve only the rates for that specific product. If not specified then the process will retrieve rates of any products
  • A specific rate model: If specified then the process will retrieve only the rates that are following the specific rate model. If not specified then the process will retrieve rates following any rate mode

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

String

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

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

job_identifier

(semi-optional)

String

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

Name

Type

Description

id

(semi-optional)

String

The ID of the job

number

(semi-optional)

String

The number of the job

accounts_receivable_identifier

(semi-optional)

String

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

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

product_identifier

(optional)

String

The identifier of the product whose price plan rates should be returned as a result. The allowed product 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

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

  • 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

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

Unable to render {include} The included page could not be found.

Examples

 Example 1

HTTP Method: GET

 Request:


Response:

 

 Example 2

HTTP Method: GET

 Request:


Response:

 

 


  • No labels