...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
This method is setting an Effective subscription in short-term deactivation period. The method can be applied on a single subscription only
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
subscription_identifier
(semi-optional)
...
The subscription to be modified. 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 |
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory |
...
accounts_receivable_identifier
(semi-optional)
...
The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:
...
| Note |
|---|
The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription |
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
action_type_identifier
(optional)
...
The action type that should be used. The allowed subscription action type identifier fields are the following:
Name | Type | Description |
|---|---|---|
id (semi-optional) | String | The ID of the subscription action type |
name (semi-optional) | String | The name of the subscription action type |
alternative_code (semi-optional) | String | The alternative code of the subscription action type |
...
sub_action_type_identifier
(optional)
...
The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
Name | Type | Description |
|---|---|---|
id (semi-optional) | String | The ID of the subscription sub action type |
name (semi-optional) | String | The name of the subscription sub action type |
alternative_code (semi-optional) | String | The alternative code of the subscription sub action type |
...
end_short_term_deactivation_on
(semi-optional)
...
end_short_term_deactivation_after_specific_days
(semi-optional)
...
transaction_reference_number
(optional)
...
The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
performed_by_user_identifier
(optional)
...
The user that actually performed the action. The allowed user identifier fields are the following:
...
performed_by_unit_identifier
(optional)
...
The unit that performed the action. The allowed unit identifier fields are the following:
...
| Tip |
|---|
Available from CRM.COM R14.0.0 |
...
performed_on
(optional)
...
billing_effective_date
(optional)
...
billable_period_start_date
(optional)
...
scheduled_date
(optional)
...
The date that the action is scheduled to be executed. If not specified then the action will be executed immediately
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
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
fields_set
(optional)
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
| Tip |
|---|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"2D5C85BD2B0B4131B3F754757BFADA5A",
"subscription_identifier":{"number":"S60113"},
"end_short_term_deactivation_after_specific_days":3,
} |
Response:
...
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
...
| Excerpt |
|---|
This method is setting an Effective subscription in short-term deactivation period. The method can be applied on a single subscription only |
Resource URL
Parameters
Name | Type | Description | ||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||
subscription_identifier (semi-optional) | Subscription identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
| ||||||||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:
| ||||||||||||||
action_type_identifier (optional) | Subscription action type identifier | The action type that should be used. The allowed subscription action type identifier fields are the following:
| ||||||||||||||
sub_action_type_identifier (optional) | Subscription sub action type identifier | The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
| ||||||||||||||
classification_identifier (optional) | Subscription Action Classification Identifier | The subscription action's classification. The allowed subscription action classification identifier fields are the following:
| ||||||||||||||
end_short_term_deactivation_on (semi-optional) | Date | The date that the short term deactivation period should end. End short term deactivation on date is mandatory unless end short term deactivation after specific days is specified. It is not allowed to specify both information | ||||||||||||||
end_short_term_deactivation_after_specific_days (semi-optional) | Number | It defines the date that the short term deactivation period should end, based on the date that the subscription will go into short term deactivation and the specified number of days. End short term deactivation after specific days is mandatory unless end short term deactivation on date is specified. It is not allowed to specify both information | ||||||||||||||
transaction_reference_number (optional) | String | The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.
| ||||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||||
performed_by_unit_identifier (optional) | Unit Identifier | The unit that performed the action. The allowed unit identifier fields are the following:
| ||||||||||||||
performed_by_business_unit_identifier (optional) | Business Unit Identifier | The business unit that performed the action. The allowed business unit identifier fields are the following:
| ||||||||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||||||||
billing_effective_date (optional) | Date | Determines when the subscription services that are affected by the subscription action should be billed by the billing engine. | ||||||||||||||
billable_period_start_date (optional) | Date | Determines the start date of the billable period of each subscription service (it answers to the question “from which date should I start billing this service) that is affected by the subscription action. | ||||||||||||||
scheduled_date (optional) | Date | The date that the action is scheduled to be executed. If not specified then the action will be executed immediately | ||||||||||||||
use_proposed_scheduled_date (optional) | Boolean | Defines whether the scheduled date automatically calculated and proposed by the system based on business rules, will be automatically set as the subscription's scheduled date or not. Applicable only if the subscription action includes a scheduled date and only if this scheduled date does not meet the business rules.
| ||||||||||||||
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 | ||||||||||||||
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
|
Restrictions
- 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:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|