| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_detail_record_identifier (mandatory) | Usage Detail Record identifier | The identifier of the usage detail record that should be returned as a result. The allowed usage detail record identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| accounts_receivable_identifier (semi-optional) | Accounts Receivable identifier | The identifier of the related accounts receivable. The allowed accounts receivable identifier fields are the following:
| ||||||
| subscription_identifier (semi-optional) | Subscription identifier | The identifier of the related subscription. The allowed subscription identifier fields are the following:
| ||||||
source_system_identifier (optional) | Usage Detail Record Source System identifier | The identifier of the related usage detail record source system. The allowed usage detail record source system identifier fields are the following:
| ||||||
type_identifier (optional) | Usage Detail Record Type identifier | The identifier of the related usage detail record type. The allowed usage detail record type identifier fields are the following:
| ||||||
usage_service_catalog_identifier (optional) | Usage Service Catalog identifier | The identifier of the related usage service catalog. The allowed usage service catalog identifier fields are the following:
| ||||||
device_identifier (optional) | Usage Detail Record Device identifier | The identifier of the related usage detail record device. The allowed usage detail record device identifier fields are the following:
| ||||||
usage_method_identifier (optional) | Usage Detail Record Usage Method identifier | The identifier of the related usage detail record usage method. The allowed usage detail record usage method identifier fields are the following:
| ||||||
source_category_identifier (optional) | Usage Detail Record Source Category identifier | The identifier of the related usage detail record source category. The allowed usage detail record source category identifier fields are the following:
| ||||||
destination_category_identifier (optional) | Usage Detail Record Destination Category identifier | The identifier of the related usage detail record destination category. The allowed usage detail record destination category identifier fields are the following:
| ||||||
product_identifier (optional) | Product Identifier | The identifier of the actual product that was used. The allowed product identifier fields are the following:
Only products classified as usage services can be specified in this parameter | ||||||
from_date (optional) | Date | The date from which the usage detail record that should be returned as a result was created (inclusive).
| ||||||
to_date (optional) | Date | The date until which the usage detail record that should be returned as a result was created (exclusive).
| ||||||
number_of_results (optional) | Number | The required number of usage detail records that should be returned as a result. If not specified, then all usage detail records that meet the rest of the criteria will be returned. If specified, then the most recent usage detail records will be retrieved.
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_detail_record_identifier (mandatory) | Usage Detail Record identifier | The identifier of the usage detail record that should be cancelled. The allowed usage detail record identifier fields are the following:
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| subscription_action_identifier (mandatory) | Subscription Action identifier | The subscription action identifier that should be used for cancelling the usage detail record lot. The allowed subscription action identifier fields are the following:
| ||||||
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 |
...
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
HTTP Method: POST
Request:
Body:
Response:
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_detail_record_identifier (mandatory) | Usage Detail Record identifier | The identifier of the usage detail record that should be cancelled. The allowed usage detail record identifier fields are the following:
| ||||||
product_identifier (optional) | Product identifier | The identifier of the product that was actually used. The allowed product identifier fields are the following:
| ||||||
source_system_identifier (optional) | Usage Detail Record Source System identifier | The identifier of the usage detail record source system. The allowed usage detail record source system identifier fields are the following:
| ||||||
from_date (optional) | Date | The date that the usage of the service started | ||||||
to_date (optional) | Number | The date that the usage of the service stopped | ||||||
usage_amount (optional) | Number | The usage detail record total usage amount | ||||||
total_amount (optional and applicable on conditions) | Number | The total amount that the usage detail record will be rated for. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog
| ||||||
vat_amount (optional and applicable on conditions) | Number | The VAT amount that will be applied on the usage detail record. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog
| ||||||
tax_amount (optional and applicable on conditions) | Number | The total Tax amount that will be applied on the usage detail record. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog
| ||||||
discount_amount (optional and applicable on conditions) | Number | The discount amount that will be applied on the usage detail record. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog
| ||||||
rating_date (optional and applicable on conditions) | Date | The date that the rating was applied on the usage detail record. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog
| ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_detail_record_identifier (mandatory) | Usage Detail Record identifier | The identifier of the usage detail record that should be updated. The allowed usage detail record identifier fields are the following:
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_detail_record_identifier (mandatory) | Usage Detail Record identifier | The identifier of the usage detail record that should be updated. The allowed usage detail record identifier fields are the following:
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_detail_record_identifier (mandatory) | Usage Detail Record identifier | The identifier of the usage detail record that should be cancelled. The allowed usage detail record identifier fields are the following:
|
...