- Created by George Rossides, last modified by Georgia Kountouri on May 03, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 7 Current »
Name | Type | Description |
id | String | The ID of the retrieved credit note item |
| quantity | number | The quantity of the product |
| cost | number | The cost of the product |
| net_amount | number | The net amount for the specified product, as calculated by the system |
| discount_percentage | number | The discount percentage that is applied |
| discount_amount | number | The discount amount that is applied |
| vat_percentage | number | The VAT percentage that is applied, based on the selected VAT rate Deprecated from CRM.COM R17.0.0 |
| vat_amount | number | The VAT amount that is applied, based on the selected VAT rate Deprecated from CRM.COM R17.0.0 |
| tax_amount | number | The total Tax amount applied Available from CRM.COM R12.0.0 |
| sub_total | number | The total amount that will be credited for the specified product |
| product | Product object | The product that was credited |
| vat_rate | VAT rate object | The VAT rate that is applied |
| applied_tax_rates | Set of Tax Rate Objects | The Tax Rate(s) applied on the credit note item Available from CRM.COM R12.0.0 |
Referred Objects Response Data
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 |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved vat rate |
| name | String | The Name of the retrieved vat rate |
| alternative_code | String | The Alternative Code of the retrieved vat rate |
| description | String | The Description of the retrieved vat rate |
| Name | Type | Description |
|---|---|---|
| tax_amount | Number | The amount of tax that was applied by the related Tax Rate |
| tax_percentage | Number | The percentage of the applied Tax Rate. |
| tax_rates | Tax Rate Object | The Tax Rate that was applied |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved Tax rate |
| name | String | The Name of the retrieved Tax rate |
| alternative_code | String | The Alternative Code of the retrieved Tax rate |
| description | String | The Description of the retrieved Tax rate |
- No labels