| Tip |
|---|
Available from CRM.COM R6.0.0 |
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| buy_in_advance_request_identifier (mandatory) | Buy in Advance Request identifier | The identifier of the buy in advance request that should be returned as a result. The allowed buy in advance request 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 | ||||||
| subscription_identifier (mandatory) | Subscription Identifier | The identifier of the subscription related with the buy in advance requests that should be returned as a result. The allowed subscription identifier fields are the following:
| ||||||
fields_set | 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 | |||||||
| subscription_identifier (mandatory) | Subscription Identifier | The identifier of the subscription related with the buy in advance request. The allowed subscription identifier fields are the following:
| |||||||
duration (mandatory) | Number | The duration that is requested to be bough in advance | |||||||
unit_of_time (mandatory) | String | The unit of time that measures the specified duration. The supported values are DAYS, WEEKS, MONTHS or YEARS | |||||||
description (optional) | String | A description of the retrieved buy in advance request | |||||||
billing_effective_date (optional) | Date | The billing effective date of the buy in advance request, that determines the earliest date that the request can be picked up by the billing engine. If not specified then it is automatically set to the date that the request is submitted | |||||||
udf_string_1 | String | User Defined Field of type String | |||||||
udf_string_2 | String | User Defined Field of type String | |||||||
udf_string_3 | String | User Defined Field of type String | |||||||
udf_string_4 | String | User Defined Field of type String | |||||||
udf_string_5 | String | User Defined Field of type String | |||||||
udf_string_6 | String | User Defined Field of type String | |||||||
udf_string_7 | String | User Defined Field of type String | |||||||
udf_string_8 | String | User Defined Field of type String | |||||||
udf_float_1 | Float | User Defined Field of type Float | |||||||
udf_float_2 | Float | User Defined Field of type Float | |||||||
udf_float_3 | Float | User Defined Field of type Float | |||||||
udf_float_4 | Float | User Defined Field of type Float | |||||||
udf_date_1 | Date | User Defined Field of type Date | |||||||
udf_date_2 | Date | User Defined Field of type Date | |||||||
udf_date_3 | Date | User Defined Field of type Date | |||||||
udf_date_4 | Date | User Defined Field of type Date | |||||||
buy_in_advance_request_services_set (optional) | Set of Buy in advance request services | A set of services which are bough in advance through this request. Applicable only for prepaid subscriptions and only for such subscriptions' pre-rated services
| |||||||
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 |
...
Anchor buy_in_advance_request referred parameter objectsparameter objects buy_in_advance_request referred parameter objects
Referred Parameter Objects Data
| buy_in_advance_request referred parameter objectsparameter objects | |
| buy_in_advance_request referred parameter objects |
| Include Page | ||||
|---|---|---|---|---|
|
...
|
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
...
This method updates an existing buy in advance request. This method can be used only if the specified buy in advance request is effective and not rated. A single buy in advance request can be update updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
...
Name | Type | Description | |||||||
token | String | The token retrieved from the login method | |||||||
| buy_in_advance_request_identifier (mandatory) | Buy in Advance Request identifier | The identifier of the buy in advance request that should be updated. The allowed buy in advance request identifier fields are the following:
| |||||||
duration (optional) | Number | The duration that is requested to be bough in advance | |||||||
unit_of_time (optional) | String | The unit of time that measures the specified duration. The supported values are DAYS, WEEKS, MONTHS or YEARS | |||||||
description (optional) | String | A description of the retrieved buy in advance request | |||||||
billing_effective_date (optional) | Date | The billing effective date of the buy in advance request, that determines the earliest date that the request can be picked up by the billing engine | |||||||
udf_string_1 | String | User Defined Field of type String | |||||||
udf_string_2 | String | User Defined Field of type String | |||||||
udf_string_3 | String | User Defined Field of type String | |||||||
udf_string_4 | String | User Defined Field of type String | |||||||
udf_string_5 | String | User Defined Field of type String | |||||||
udf_string_6 | String | User Defined Field of type String | |||||||
udf_string_7 | String | User Defined Field of type String | |||||||
udf_string_8 | String | User Defined Field of type String | |||||||
udf_float_1 | Float | User Defined Field of type Float | |||||||
udf_float_2 | Float | User Defined Field of type Float | |||||||
udf_float_3 | Float | User Defined Field of type Float | |||||||
udf_float_4 | Float | User Defined Field of type Float | |||||||
udf_date_1 | Date | User Defined Field of type Date | |||||||
udf_date_2 | Date | User Defined Field of type Date | |||||||
udf_date_3 | Date | User Defined Field of type Date | |||||||
udf_date_4 | Date | User Defined Field of type Date | |||||||
buy_in_advance_request_services_set (optional) | Set of Buy in advance request services | A set of prepaid pre-rated subscription services that are bough in advance through this request
| |||||||
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.
Anchor buy_in_advance_request_update referred parameter objects buy_in_advance_request_update referred parameter objects
Referred Parameter Objects Data
| buy_in_advance_request_update referred parameter objects | |
| buy_in_advance_request_update referred parameter objects |
| Include Page | ||||
|---|---|---|---|---|
|
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
...
Name | Type | Description | |||||||
token | String | The token retrieved from the login method | |||||||
| buy_in_advance_request_identifier (mandatory) | Buy in Advance Request identifier | The identifier of the buy in advance request that should be cancelled. The allowed buy in advance request identifier fields are the following:
| |||||||
udf_date_4 | Date | User Defined Field of type Date | |||||||
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 |
...