- Created by George Rossides , last modified on Apr 12, 2016
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Next »
Name | Type | Description |
|---|---|---|
| upcoming_rates | ||
| recurring_rates |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
total_amount | Number | The total amount that the subscription is rated for |
| total_amount_of_parent | Number | The total rated amount that should be paid by the parent account. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
| total_amount_of_member | Number | The total rated amount that should be paid by the member account. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
| total_discount_amount | Number | The total discount amount |
| total_discount_amount_of_parent | Number | The discount amount that the parent account will benefit from. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
| total_discount_amount_of_member | Number | The discount amount that will be given to the member account. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
| total_vat_amount | Number | The total VAT amount Available from CRM.COM R12.0.0 |
| total_vat_amount_of_parent | Number | The VAT amount that the parent account will be rated for. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
| total_vat_amount_of_member | Number | The VAT amount that the member account will be rated for. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
| total_tax_amount | Number | The total Tax amount Available from CRM.COM R12.0.0 |
| total_tax_amount_of_parent | Number | The Tax amount that the parent account will be rated for. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
| total_tax_amount_of_member | Number | The Tax amount that the member account will be rated for. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
amount_to_be_paid | Number | The amount that should be paid at the time of calculation, considering any balance brought forward |
| amount_to_be_paid_by_parent | The amount that should be paid at the time of calculation by the parent account. Applicable only if the account owner is a member of a group which is funded by another account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated | |
| amount_to_be_paid_by_member | Number | The amount that should be paid at the time of calculation by the member account. Applicable only if the account owner is a member of a group Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be deprecated |
| as_of_date | Date | The date that was used to rate the services |
| currency | Currency Object | The currency related to the rates Available from CRM.COM R10.0.0 |
| service_rates_set | Set of upcoming service rates | The rates that are applied on each subscription service |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
total_amount | Number | The total amount that the service is rated for |
| total_discount_amount | Number | The total discount amount |
| from_date | Date | The start of the time period, that the calculated rate will be covering, for the specific service |
| to_date | Date | The end of the time period, that the calculated rate will be covering, for the specific service |
| currency | Currency Object | The currency related to the rates Available from CRM.COM R10.0.0 |
| service | Product Object | The service that was rated |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
| global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between
|
| uot | String | The 'UOT' applicable for the rate
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
- No labels