- Created by George Rossides (Unlicensed) , last modified by Former user on Dec 28, 2016
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 16 Next »
POST subscriptions/installed_items/add
It adds one or multiple installed items on a specific subscription
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription to be modified. The allowed subscription 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:
| ||||||||||||
job_identifier (optional) | Job identifier | The Job for which the subscription action is performed. The allowed job identifier fields are the following:
Available from CRM.COM R9.0.0 | ||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||||||
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 | ||||||||||||
(mandatory) | Set of subscription installed item objects | The installed items that should be added on the subscription | ||||||||||||
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 Available from CRM.COM R10.0.0 |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
installed_item_identifier (mandatory) | Installed item identifier | The identifier of the installed item. The allowed installed item identifier fields are the following:
| ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
installed_items_distribution_set (optional) | Set of subscription installed item distribution objects | The distribution of the installed items that will be added on the subscription Deprecated from CRM.COM R15.0.0 |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
provisioning_distributor_identifier (mandatory) | Provisioning distributor identifier | The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription action |
number | String | The number of the retrieved subscription action |
transaction_reference_number | String | The unique transaction reference number of the retrieved subscription action Available from CRM.COM R13.1.0 |
life_cycle_state | String | The life cycle state of the subscription action. One of the following values is returned: EXECUTED, EXECUTEDWITHERRORS, REJECTEDSYSTEMFAILURE, REJECTEDSYSTEMVALIDATION, SCHEDULED, CANCELLED From CRM.COM R15.0.0 the available life cycle states are:
|
classification | String | The classification that was provided when the subscription action was submitted. Available from CRM.COM R17.0.0 |
behavior_code | String | The behavior code of the subscription action |
business_classification_code | String | The business classification code of the subscription action |
scheduled_date | Date | The date that the subscription was scheduled to be executed |
executed_on | Date | The date that the subscription action is executed |
submitted_on | Date | The date that the business action was submitted into the system |
performed_on | Date | The date that the business action was actually performed, which might be different than the date that was submitted into the system |
udf_string_1 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_2 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_3 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_4 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_5 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_6 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_7 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_8 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_9 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_10 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_11 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_12 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_13 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_14 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_15 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_16 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_float_1 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_2 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_3 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_4 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_5 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_6 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_7 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_8 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_date_1 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_2 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_3 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_4 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
submitted_by | User Object | The user that submitted the action into the system |
performed_by | User Object | The user that actually performed the subscription action, which might be different than the user that submitted the action into the system |
performed_by_unit | Unit Object | The unit that performed the subscription action Available from CRM.COM R14.0.0 Deprecated from CRM.COM R18.0.0 |
performed_by_business_unit | Business Unit Object | The business unit that performed the subscription action Available from CRM.COM R18.0.0 |
action_type | Subscription Action Type Object | The action type of the subscription action Deprecated from CRM.COM R15.0.0 |
sub_action_type | Subscription Sub Action Type Object | The sub action type of the subscription action Deprecated from CRM.COM R15.0.0 |
subscription | Subscription Object | The subscription that was or will be modified by the execution of the subscription action |
job | Job Object | The Job for which the subscription action was performed Available from CRM.COM R9.0.0 |
resubmitted_by | Subscription Action Object | The subscription action that was generated when the retrieved subscription was re-submitted. Applicable only if the retrieved subscription action is in Rejected life cycle state Available from CRM.COM R17.0.0 |
subscription_action_affected_services_set | Set of subscription action affected services | A list of subscription services which are affected by the specified subscription action. Each subscription service might be affected if it is being added or removed by the subscription action, or if its life cycle changes because of the action. Available from CRM.COM R15.0.0 |
subscription_action_affected_installed_items_set | Set of subscription action affected installed items | A list of subscription installed items which are affected by the specified subscription action. Each subscription installed item might be affected if it is being added or removed by the subscription action Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
code | String | The code of the retrieved business unit |
unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved subscription action type |
name | String | The name of the retrieved subscription action type |
alternative_code | String | The alternative code of the retrieved subscription action type |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved subscription sub action type |
name | String | The name of the retrieved subscription sub action type |
alternative_code | String | The alternative code of the retrieved subscription sub action type |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription |
number | String | The number of the retrieved subscription |
life_cycle_state | String | The life cycle state of the subscription. One of the following values is returned DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0 PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0 |
first_activated_date | Date | The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started) Available from CRM.COM R9.0.0 |
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
accounts_receivable | Accounts receivable object | The accounts receivable owning the subscriptions |
type | Subscription type object | The type of the retrieved subscription |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription type |
name | String | The name of the retrieved subscription type |
alternative_code | String | The alternative code of the retrieved subscription type |
description | String | A description of the retrieved subscription type |
classification | String | The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
description | String | The description of the retrieved job |
life_cycle_state | String | The life cycle state of the retrieved job The supported options are
|
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
Accounts Receivable object | The accounts receivable related with the specified job | |
type | Job type object | The type information of the retrieved job Available from CRM.COM R11.2.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved job type |
name | String | The Name of the retrieved job type |
alternative_code | String | The Alternative Code of the retrieved job type |
description | String | The Description of the retrieved job type |
billing_directive | String | The billing directive of the retrieved job type The supported billing directive options are
Available from CRM.COM R10.0.0 |
billing_method | String | The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE The supported billing methods are
Available from CRM.COM R10.0.0 From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
fulfillment_scope | String | The fulfillment scope of the retrieved job type The supported fulfillment scopes are
The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS From CRM.COM R15.0.0 and onward, all fulfillment scopes will be deprecated |
fulfillment_method | String | The fulfillment method of the retrieved job type The supported fulfillment methods are
From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
Name | Type | Description |
---|---|---|
affected_mode | String | Defines how the subscription service was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED |
product | Product object | The product of the service that was affected because of the subscription action |
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 |
---|---|---|
affected_mode | String | Defines how the subscription installed item was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED |
installed_item | Installed Item object | The installed item that was affected because of the subscription action |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved installed item |
serial_number | String | The serial number of the retrieved installed item |
alternative_code | String | The alternative code of the retrieved installed item |
state | String | The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE |
state_classification | State Classification object | The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0 |
Product object | The product of the retrieved installed item |
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 |
---|---|---|
name | String | The name of the installed item's state classification |
alternative_code | String | The alternative code of the installed item's state classification |
description | String | The description of the installed item's state classification |
Examples
HTTP Method: POST
Request:
Body:
{ "token":"16AFA54B31AF441C8379D4AD45BF7447", "subscription_identifier":{"number":"S60250"}, "action_type_identifier": {"name" : "Add Installed Item"}, "performed_by_user_identifier":{"username":"JackH"}, "performed_on":"2015-03-18T05:07:41", "installed_items_set":[ { "installed_item_identifier":{ "serial_number":"SC1-000A-0018" }, "installed_items_distribution_set":[ { "provisioning_distributor_identifier":{ "name":"Main" } } ] } ] }
Response:
{ "status": { "message": null, "description": null, "code": "OK" }, "data": { "scheduled_date": "2015-03-19T14:18:28", "action_type": { "name": "Add Installed Item", "id": "37ACD6A180B942FC96FCAC0E487C057A", "alternative_code": "AII" }, "submitted_on": "2015-03-19T14:18:28", "sub_action_type": null, "business_classification_code": "ADD_INSTALLED_ITEM", "number": "756", "executed_on": "2015-03-19T14:18:28", "life_cycle_state": "EXECUTED", "performed_by": { "person_name": "Jack Hadjicosti", "username": "JackH", "id": "B8650C555C4EA8C741103961276E7773", "email": "j_hadjicosti@crm.com" }, "behavior_code": "ADD_INSTALLED_ITEM", "submitted_by": { "person_name": "Marios Lannister", "username": "mpadministrator", "id": "1" }, "id": "DFC66C7877FA4433991FA05736E69ECE", "subscription": { "accounts_receivable": { "account_owner": { "last_name": "May", "life_cycle_state": "FINANCIAL", "middle_name": "Alan", "company_profile": null, "title": "Mr", "type": "PERSON", "first_name": "Michael", "name": "Michael May", "id": "22AD2164CE074EB60ECFD5F3F9A55E2D", "company_name": null, "demographics": { "gender": "MALE", "passport_issued_by_country": { "name": "UNITED KINGDOM", "id": "126" }, "passport_number": "123456", "social_security_number": "654321", "country_of_residence": { "name": "CYPRUS", "id": "181" }, "industry_sector": { "name": "FINANCIALS", "id": "03EA93890F51506ABD9E994CD826EC78", "alternative_code": "FIN" }, "date_of_birth": { "month": 5, "day": 30, "year": 1983 }, "name_day": { "month": 11, "day": 7 }, "id_number": "868561", "id_issued_by_country": { "name": "UNITED KINGDOM", "id": "126" }, "industry": { "name": "IndustryTest", "id": "D65E1F283AE9FED5A572F817DE23EDD1", "code": "IndTest" } } }, "life_cycle_state": "ACTIVE", "number": "319", "name": "anotherAccount", "id": "A41AE5E4FA9783A05B16F7BA27945B42" }, "life_cycle_state": "EFFECTIVE", "number": "S60250", "type": { "name": "Normal Subscription", "id": "6BB2B984CC9309775D06650C7493A836", "description": null, "alternative_code": "ST" }, "id": "FA648EFF99188F3C2B8343F7C03806C1" }, "performed_on": "2015-03-18T05:07:41" } }
HTTP Method: POST
Request:
Body:
{ "token":"16AFA54B31AF441C8379D4AD45BF7447", "fields_set":"submitted_by,subscription,sub_action_type,job,action_type", "subscription_identifier":{"number":"S60250"}, "action_type_identifier": {"name" : "Add Installed Item"}, "sub_action_type_identifier":{"name" : "Add Installed Item"}, "performed_by_user_identifier":{"username":"JackH"}, "performed_on":"2015-03-18T05:07:41", "installed_items_set":[ { "installed_item_identifier":{ "serial_number":"smartcard_1_01" }, "installed_items_distribution_set":[ { "provisioning_distributor_identifier":{ "name":"New" } } ] } ] }
Response:
{ "status": { "message": "", "description": "", "code": "OK" }, "data": { "action_type": { "id": "32DE4AD093334F80BDABE93507E12A30", "name": "Add Installed Item", "alternative_code": "AII" }, "sub_action_type": { "id": "E3DD837DA6AF4F90904A17EFB650AAEB", "name": "Add Installed Item", "alternative_code": "AII" }, "submitted_by": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" }, "job": null, "subscription": { "life_cycle_state": "DRAFT", "accounts_receivable": { "account_owner": { "last_name": "Clark", "middle_name": "S.", "life_cycle_state": "FINANCIAL", "company_profile": null, "title": "Mrs", "first_name": "Kathy", "type": "PERSON", "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08", "name": "Clark Kathy", "company_name": null, "demographics": { "gender": "FEMALE", "passport_issued_by_country": null, "social_security_number": "88996633", "passport_number": "4564455", "industry_sector": null, "country_of_residence": { "three_character_code": "USA", "two_character_code": "US", "id": "127", "name": "UNITED STATES", "alternative_code": null }, "name_day": { "month": 1, "day": 1 }, "date_of_birth": { "month": 1, "day": 1, "year": 1980 }, "id_number": "87878000", "industry": null, "id_issued_by_country": null } }, "life_cycle_state": "ACTIVE", "number": "191", "id": "D64410DDAC580029C9664EAB74ACAC9C", "name": "Kat's Main TV Account" }, "number": "S60250", "type": { "id": "3100B0D56E7C7EADF073C34BCE1E42AF", "name": "London2", "description": null, "alternative_code": "LND2" }, "id": "A521D332281C71FE88C58ACEC78C39BD", "first_activated_date": null, "rating_state": "PENDING" } } }
POST subscriptions/installed_items/remove
It removes one or multiple subscription installed items from a specific subscription
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription to be modified. The allowed subscription 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:
| ||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||||||
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 | ||||||||||||
(optional) | Set of subscription installed item objects | The installed items that should be added on the subscription | ||||||||||||
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 Available from CRM.COM R10.0.0 |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subscription_installed_item_id (semi-optional) | String | The ID of the subscription installed item | ||||||||||||
installed_item_identifier (semi-optional) | Installed item identifier | The identifier of the installed item which is related with the subscription installed item belonging to the subscription specified in the parameters. The allowed installed item identifier fields are the following:
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription action |
number | String | The number of the retrieved subscription action |
transaction_reference_number | String | The unique transaction reference number of the retrieved subscription action Available from CRM.COM R13.1.0 |
life_cycle_state | String | The life cycle state of the subscription action. One of the following values is returned: EXECUTED, EXECUTEDWITHERRORS, REJECTEDSYSTEMFAILURE, REJECTEDSYSTEMVALIDATION, SCHEDULED, CANCELLED From CRM.COM R15.0.0 the available life cycle states are:
|
classification | String | The classification that was provided when the subscription action was submitted. Available from CRM.COM R17.0.0 |
behavior_code | String | The behavior code of the subscription action |
business_classification_code | String | The business classification code of the subscription action |
scheduled_date | Date | The date that the subscription was scheduled to be executed |
executed_on | Date | The date that the subscription action is executed |
submitted_on | Date | The date that the business action was submitted into the system |
performed_on | Date | The date that the business action was actually performed, which might be different than the date that was submitted into the system |
udf_string_1 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_2 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_3 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_4 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_5 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_6 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_7 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_8 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_9 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_10 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_11 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_12 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_13 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_14 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_15 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_16 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_float_1 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_2 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_3 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_4 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_5 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_6 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_7 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_8 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_date_1 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_2 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_3 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_4 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
submitted_by | User Object | The user that submitted the action into the system |
performed_by | User Object | The user that actually performed the subscription action, which might be different than the user that submitted the action into the system |
performed_by_unit | Unit Object | The unit that performed the subscription action Available from CRM.COM R14.0.0 Deprecated from CRM.COM R18.0.0 |
performed_by_business_unit | Business Unit Object | The business unit that performed the subscription action Available from CRM.COM R18.0.0 |
action_type | Subscription Action Type Object | The action type of the subscription action Deprecated from CRM.COM R15.0.0 |
sub_action_type | Subscription Sub Action Type Object | The sub action type of the subscription action Deprecated from CRM.COM R15.0.0 |
subscription | Subscription Object | The subscription that was or will be modified by the execution of the subscription action |
job | Job Object | The Job for which the subscription action was performed Available from CRM.COM R9.0.0 |
resubmitted_by | Subscription Action Object | The subscription action that was generated when the retrieved subscription was re-submitted. Applicable only if the retrieved subscription action is in Rejected life cycle state Available from CRM.COM R17.0.0 |
subscription_action_affected_services_set | Set of subscription action affected services | A list of subscription services which are affected by the specified subscription action. Each subscription service might be affected if it is being added or removed by the subscription action, or if its life cycle changes because of the action. Available from CRM.COM R15.0.0 |
subscription_action_affected_installed_items_set | Set of subscription action affected installed items | A list of subscription installed items which are affected by the specified subscription action. Each subscription installed item might be affected if it is being added or removed by the subscription action Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
code | String | The code of the retrieved business unit |
unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved subscription action type |
name | String | The name of the retrieved subscription action type |
alternative_code | String | The alternative code of the retrieved subscription action type |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved subscription sub action type |
name | String | The name of the retrieved subscription sub action type |
alternative_code | String | The alternative code of the retrieved subscription sub action type |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription |
number | String | The number of the retrieved subscription |
life_cycle_state | String | The life cycle state of the subscription. One of the following values is returned DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0 PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0 |
first_activated_date | Date | The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started) Available from CRM.COM R9.0.0 |
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
accounts_receivable | Accounts receivable object | The accounts receivable owning the subscriptions |
type | Subscription type object | The type of the retrieved subscription |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription type |
name | String | The name of the retrieved subscription type |
alternative_code | String | The alternative code of the retrieved subscription type |
description | String | A description of the retrieved subscription type |
classification | String | The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
description | String | The description of the retrieved job |
life_cycle_state | String | The life cycle state of the retrieved job The supported options are
|
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
Accounts Receivable object | The accounts receivable related with the specified job | |
type | Job type object | The type information of the retrieved job Available from CRM.COM R11.2.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved job type |
name | String | The Name of the retrieved job type |
alternative_code | String | The Alternative Code of the retrieved job type |
description | String | The Description of the retrieved job type |
billing_directive | String | The billing directive of the retrieved job type The supported billing directive options are
Available from CRM.COM R10.0.0 |
billing_method | String | The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE The supported billing methods are
Available from CRM.COM R10.0.0 From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
fulfillment_scope | String | The fulfillment scope of the retrieved job type The supported fulfillment scopes are
The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS From CRM.COM R15.0.0 and onward, all fulfillment scopes will be deprecated |
fulfillment_method | String | The fulfillment method of the retrieved job type The supported fulfillment methods are
From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
Name | Type | Description |
---|---|---|
affected_mode | String | Defines how the subscription service was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED |
product | Product object | The product of the service that was affected because of the subscription action |
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 |
---|---|---|
affected_mode | String | Defines how the subscription installed item was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED |
installed_item | Installed Item object | The installed item that was affected because of the subscription action |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved installed item |
serial_number | String | The serial number of the retrieved installed item |
alternative_code | String | The alternative code of the retrieved installed item |
state | String | The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE |
state_classification | State Classification object | The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0 |
Product object | The product of the retrieved installed item |
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 |
---|---|---|
name | String | The name of the installed item's state classification |
alternative_code | String | The alternative code of the installed item's state classification |
description | String | The description of the installed item's state classification |
Examples
HTTP Method: POST
Request:
Body:
{ "token":"FFB8A25C40DE45BCA437F01B6D2F1FAF", "subscription_identifier":{"number":"S60225"}, "action_type_identifier":{"name":"Remove Hardware"}, "sub_action_type_identifier":{"name":"Remove Installed Item"}, "performed_by_user_identifier":{"username":"JackH"}, "performed_on":"2014-07-16T05:07:41", "installed_items_set": [ { "installed_item_identifier":{"serial_number":"SC1-000A-0006"} } ] }
Response:
{ "status": { "message": null, "description": null, "code": "OK" }, "data": { "action_type": { "name": "Remove Hardware", "id": "CCAD5B2B6AB4BA8082DE3274D436DAD0", "alternative_code": "RH" }, "submitted_on": "2015-02-26T11:19:55", "sub_action_type": { "name": "Remove Installed Item", "id": "13", "alternative_code": null }, "business_classification_code": "REMOVE_INSTALLED_ITEM", "number": "352", "executed_on": "2015-02-26T11:19:56", "life_cycle_state": "EXECUTED", "performed_by": { "person_name": "Jack Hadjicosti", "username": "JackH", "id": "B8650C555C4EA8C741103961276E7773", "email": "j_hadjicosti@crm.com" }, "behavior_code": "REMOVE_INSTALLED_ITEM", "submitted_by": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1" }, "id": "08C4D6B63DEB4EF988E8D6F6C5367B3B", "subscription": { "accounts_receivable": { "account_owner": { "last_name": "Xenofontos ", "life_cycle_state": "FINANCIAL", "middle_name": "Iatrou", "company_profile": null, "title": "Mr", "type": "PERSON", "first_name": "Kyriacos", "name": "Kyriacos Xenofontos", "id": "31260911295E70BB660EBEB0C4F941AC", "company_name": null, "demographics": { "gender": "MALE", "passport_issued_by_country": { "name": "UNITED KINGDOM", "id": "126" }, "passport_number": "3463463", "social_security_number": "73473567", "country_of_residence": { "name": "UNITED KINGDOM", "id": "126" }, "industry_sector": null, "date_of_birth": { "month": 5, "day": 6, "year": 1988 }, "name_day": { "month": 5, "day": 3 }, "id_number": "87878000", "id_issued_by_country": { "name": "UNITED KINGDOM", "id": "126" }, "industry": null } }, "life_cycle_state": "ACTIVE", "number": "195", "name": "Xenofontos", "id": "5B51429862A7BCBAD60CC81982BBD45B" }, "life_cycle_state": "EFFECTIVE", "number": "S60225", "type": { "name": "London", "id": "3100B0D56E7C7EADF073C34BCE1E42AF", "description": "For Subscribers residing in London ", "alternative_code": "LND" }, "id": "681905183544B0E30834B67A1AC8F634" }, "performed_on": "2014-07-16T05:07:41" } }
POST subscriptions/installed_items/swap
It swaps one or multiple installed items belonging to a specific subscription with other installed items
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription to be modified. The allowed subscription 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:
| ||||||||||||
job_identifier (optional) | Job identifier | The Job for which the subscription action is performed. The allowed job identifier fields are the following:
Available from CRM.COM R9.0.0 | ||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||||||
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 | ||||||||||||
(mandatory) | Set of subscription installed items swap objects | A set of installed item pairs that should be swapped. | ||||||||||||
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 Available from CRM.COM R10.0.0 |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
warranty_coverage_reason (mandatory on conditions) | Warranty Coverage Reason identifier | The identifier of the Warranty Coverage Reason. Applicable and mandatory only if the installed item to be replaced is still covered by a Warranty Policy (i.e.it was sold to the customer). The allowed Warranty Coverage Reason identifier fields are the following:
Available from CRM.COM R14.1.0 | ||||||||||||
(mandatory) | Existing subscription installed item object | The subscription installed item that should be removed from the subscription | ||||||||||||
to_installed_item (mandatory) | New subscription installed item object | The installed item that should be added on the subscription
|
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subscription_installed_item_id (semi-optional) | String | The ID of the subscription installed item | ||||||||||||
installed_item_identifier (semi-optional) | Installed item identifier | The identifier of the installed item which is related with the subscription installed item belonging to the subscription specified in the parameters. The allowed installed item identifier fields are the following:
|
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
installed_item_identifier (mandatory) | Installed item identifier | The identifier of the installed item. The allowed installed item identifier fields are the following:
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription action |
number | String | The number of the retrieved subscription action |
transaction_reference_number | String | The unique transaction reference number of the retrieved subscription action Available from CRM.COM R13.1.0 |
life_cycle_state | String | The life cycle state of the subscription action. One of the following values is returned: EXECUTED, EXECUTEDWITHERRORS, REJECTEDSYSTEMFAILURE, REJECTEDSYSTEMVALIDATION, SCHEDULED, CANCELLED From CRM.COM R15.0.0 the available life cycle states are:
|
classification | String | The classification that was provided when the subscription action was submitted. Available from CRM.COM R17.0.0 |
behavior_code | String | The behavior code of the subscription action |
business_classification_code | String | The business classification code of the subscription action |
scheduled_date | Date | The date that the subscription was scheduled to be executed |
executed_on | Date | The date that the subscription action is executed |
submitted_on | Date | The date that the business action was submitted into the system |
performed_on | Date | The date that the business action was actually performed, which might be different than the date that was submitted into the system |
udf_string_1 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_2 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_3 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_4 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_5 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_6 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_7 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_8 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_9 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_10 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_11 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_12 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_13 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_14 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_15 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_16 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_float_1 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_2 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_3 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_4 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_5 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_6 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_7 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_8 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_date_1 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_2 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_3 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_4 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
submitted_by | User Object | The user that submitted the action into the system |
performed_by | User Object | The user that actually performed the subscription action, which might be different than the user that submitted the action into the system |
performed_by_unit | Unit Object | The unit that performed the subscription action Available from CRM.COM R14.0.0 Deprecated from CRM.COM R18.0.0 |
performed_by_business_unit | Business Unit Object | The business unit that performed the subscription action Available from CRM.COM R18.0.0 |
action_type | Subscription Action Type Object | The action type of the subscription action Deprecated from CRM.COM R15.0.0 |
sub_action_type | Subscription Sub Action Type Object | The sub action type of the subscription action Deprecated from CRM.COM R15.0.0 |
subscription | Subscription Object | The subscription that was or will be modified by the execution of the subscription action |
job | Job Object | The Job for which the subscription action was performed Available from CRM.COM R9.0.0 |
resubmitted_by | Subscription Action Object | The subscription action that was generated when the retrieved subscription was re-submitted. Applicable only if the retrieved subscription action is in Rejected life cycle state Available from CRM.COM R17.0.0 |
subscription_action_affected_services_set | Set of subscription action affected services | A list of subscription services which are affected by the specified subscription action. Each subscription service might be affected if it is being added or removed by the subscription action, or if its life cycle changes because of the action. Available from CRM.COM R15.0.0 |
subscription_action_affected_installed_items_set | Set of subscription action affected installed items | A list of subscription installed items which are affected by the specified subscription action. Each subscription installed item might be affected if it is being added or removed by the subscription action Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
code | String | The code of the retrieved business unit |
unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved subscription action type |
name | String | The name of the retrieved subscription action type |
alternative_code | String | The alternative code of the retrieved subscription action type |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved subscription sub action type |
name | String | The name of the retrieved subscription sub action type |
alternative_code | String | The alternative code of the retrieved subscription sub action type |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription |
number | String | The number of the retrieved subscription |
life_cycle_state | String | The life cycle state of the subscription. One of the following values is returned DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0 PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0 |
first_activated_date | Date | The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started) Available from CRM.COM R9.0.0 |
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
accounts_receivable | Accounts receivable object | The accounts receivable owning the subscriptions |
type | Subscription type object | The type of the retrieved subscription |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription type |
name | String | The name of the retrieved subscription type |
alternative_code | String | The alternative code of the retrieved subscription type |
description | String | A description of the retrieved subscription type |
classification | String | The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
description | String | The description of the retrieved job |
life_cycle_state | String | The life cycle state of the retrieved job The supported options are
|
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
Accounts Receivable object | The accounts receivable related with the specified job | |
type | Job type object | The type information of the retrieved job Available from CRM.COM R11.2.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved job type |
name | String | The Name of the retrieved job type |
alternative_code | String | The Alternative Code of the retrieved job type |
description | String | The Description of the retrieved job type |
billing_directive | String | The billing directive of the retrieved job type The supported billing directive options are
Available from CRM.COM R10.0.0 |
billing_method | String | The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE The supported billing methods are
Available from CRM.COM R10.0.0 From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
fulfillment_scope | String | The fulfillment scope of the retrieved job type The supported fulfillment scopes are
The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS From CRM.COM R15.0.0 and onward, all fulfillment scopes will be deprecated |
fulfillment_method | String | The fulfillment method of the retrieved job type The supported fulfillment methods are
From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
Name | Type | Description |
---|---|---|
affected_mode | String | Defines how the subscription service was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED |
product | Product object | The product of the service that was affected because of the subscription action |
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 |
---|---|---|
affected_mode | String | Defines how the subscription installed item was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED |
installed_item | Installed Item object | The installed item that was affected because of the subscription action |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved installed item |
serial_number | String | The serial number of the retrieved installed item |
alternative_code | String | The alternative code of the retrieved installed item |
state | String | The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE |
state_classification | State Classification object | The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0 |
Product object | The product of the retrieved installed item |
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 |
---|---|---|
name | String | The name of the installed item's state classification |
alternative_code | String | The alternative code of the installed item's state classification |
description | String | The description of the installed item's state classification |
Examples
HTTP Method: POST
Request:
Body:
{ "token":"FFB8A25C40DE45BCA437F01B6D2F1FAF", "fields_set":"submitted_by,subscription,sub_action_type,job,action_type", "subscription_identifier":{"number":"S60250"}, "action_type_identifier":{"name":"Swap Installed Item"}, "sub_action_type_identifier":{"name":"Swap Inst Item"}, "performed_by_user_identifier":{"username":"JackH"}, "performed_on":"2014-07-16T05:07:41", "installed_items_swap_set": [ { "from_installed_item":{"installed_item_identifier":{"serial_number":"smartcard_1_01"}}, "to_installed_item":{"installed_item_identifier":{"serial_number":"IS000002"}} } ] }
Response:
{ "status": { "message": "", "description": "", "code": "OK" }, "data": { "action_type": { "id": "72663ADABC6C401EADC825F2540ECD88", "name": "Swap Installed Item", "alternative_code": "SIP" }, "sub_action_type": { "id": "55076C5A73C347CA9A678684825FCA5B", "name": "Swap Inst Item", "alternative_code": "SII" }, "submitted_by": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" }, "job": null, "subscription": { "life_cycle_state": "DRAFT", "accounts_receivable": { "account_owner": { "last_name": "Clark", "middle_name": "S.", "life_cycle_state": "FINANCIAL", "company_profile": null, "title": "Mrs", "first_name": "Kathy", "type": "PERSON", "id": "460BB0DB7A4EB61D9D6E3DFEE8566C08", "name": "Clark Kathy", "company_name": null, "demographics": { "gender": "FEMALE", "passport_issued_by_country": null, "social_security_number": "88996633", "passport_number": "4564455", "industry_sector": null, "country_of_residence": { "three_character_code": "USA", "two_character_code": "US", "id": "127", "name": "UNITED STATES", "alternative_code": null }, "name_day": { "month": 1, "day": 1 }, "date_of_birth": { "month": 1, "day": 1, "year": 1980 }, "id_number": "87878000", "industry": null, "id_issued_by_country": null } }, "life_cycle_state": "ACTIVE", "number": "191", "id": "D64410DDAC580029C9664EAB74ACAC9C", "name": "Kat's Main TV Account" }, "number": "S60250", "type": { "id": "3100B0D56E7C7EADF073C34BCE1E42AF", "name": "London2", "description": null, "alternative_code": "LND2" }, "id": "A521D332281C71FE88C58ACEC78C39BD", "first_activated_date": null, "rating_state": "PENDING" } } }
POST subscriptions/installed_items/move_to_another_subscription
Available from CRM.COM R9.0.0
It moves one or multiple installed items belonging to a specific subscription to another subscription belonging to the same accounts receivable owner.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
subscription_identifier (mandatory) | Source Subscription identifier | The source subscription of the installed item (i.e the subscription from which the installed item will be removed from). The allowed subscription 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:
| ||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||||||
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 | ||||||||||||
(mandatory) | Set of subscription installed items swap objects | A set of installed item pairs that should be swapped. |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
to_subscription (mandatory) | Target subscription identifier | The identifier of the subscription to which the installed item will be moved to. The allowed subscription identifier fields are the following:
| ||||||||||||
installed_item_identifier (mandatory) | Subscription installed item identifier | The identifier of the installed item that should be moved to the target subscription. The allowed installed item identifier fields are the following:
| ||||||||||||
installed_items_distribution_set (optional) | Set of subscription installed item distribution objects | The distribution of the installed items that will be added on the subscription Deprecated from CRM.COM R18.0.0 |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
provisioning_distributor_identifier (mandatory) | Provisioning distributor identifier | The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription action |
number | String | The number of the retrieved subscription action |
transaction_reference_number | String | The unique transaction reference number of the retrieved subscription action Available from CRM.COM R13.1.0 |
life_cycle_state | String | The life cycle state of the subscription action. One of the following values is returned: EXECUTED, EXECUTEDWITHERRORS, REJECTEDSYSTEMFAILURE, REJECTEDSYSTEMVALIDATION, SCHEDULED, CANCELLED From CRM.COM R15.0.0 the available life cycle states are:
|
classification | String | The classification that was provided when the subscription action was submitted. Available from CRM.COM R17.0.0 |
behavior_code | String | The behavior code of the subscription action |
business_classification_code | String | The business classification code of the subscription action |
scheduled_date | Date | The date that the subscription was scheduled to be executed |
executed_on | Date | The date that the subscription action is executed |
submitted_on | Date | The date that the business action was submitted into the system |
performed_on | Date | The date that the business action was actually performed, which might be different than the date that was submitted into the system |
udf_string_1 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_2 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_3 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_4 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_5 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_6 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_7 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_8 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_9 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_10 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_11 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_12 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_13 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_14 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_15 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_string_16 | String | User Defined Field of type String Available from CRM.COM R14.2.0 |
udf_float_1 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_2 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_3 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_4 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_5 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_6 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_7 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_float_8 | Float | User Defined Field of type Float Available from CRM.COM R14.2.0 |
udf_date_1 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_2 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_3 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
udf_date_4 | Date | User Defined Field of type Date Available from CRM.COM R14.2.0 |
submitted_by | User Object | The user that submitted the action into the system |
performed_by | User Object | The user that actually performed the subscription action, which might be different than the user that submitted the action into the system |
performed_by_unit | Unit Object | The unit that performed the subscription action Available from CRM.COM R14.0.0 Deprecated from CRM.COM R18.0.0 |
performed_by_business_unit | Business Unit Object | The business unit that performed the subscription action Available from CRM.COM R18.0.0 |
action_type | Subscription Action Type Object | The action type of the subscription action Deprecated from CRM.COM R15.0.0 |
sub_action_type | Subscription Sub Action Type Object | The sub action type of the subscription action Deprecated from CRM.COM R15.0.0 |
subscription | Subscription Object | The subscription that was or will be modified by the execution of the subscription action |
job | Job Object | The Job for which the subscription action was performed Available from CRM.COM R9.0.0 |
resubmitted_by | Subscription Action Object | The subscription action that was generated when the retrieved subscription was re-submitted. Applicable only if the retrieved subscription action is in Rejected life cycle state Available from CRM.COM R17.0.0 |
subscription_action_affected_services_set | Set of subscription action affected services | A list of subscription services which are affected by the specified subscription action. Each subscription service might be affected if it is being added or removed by the subscription action, or if its life cycle changes because of the action. Available from CRM.COM R15.0.0 |
subscription_action_affected_installed_items_set | Set of subscription action affected installed items | A list of subscription installed items which are affected by the specified subscription action. Each subscription installed item might be affected if it is being added or removed by the subscription action Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
code | String | The code of the retrieved business unit |
unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved subscription action type |
name | String | The name of the retrieved subscription action type |
alternative_code | String | The alternative code of the retrieved subscription action type |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved subscription sub action type |
name | String | The name of the retrieved subscription sub action type |
alternative_code | String | The alternative code of the retrieved subscription sub action type |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription |
number | String | The number of the retrieved subscription |
life_cycle_state | String | The life cycle state of the subscription. One of the following values is returned DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0 PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0 |
first_activated_date | Date | The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started) Available from CRM.COM R9.0.0 |
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
accounts_receivable | Accounts receivable object | The accounts receivable owning the subscriptions |
type | Subscription type object | The type of the retrieved subscription |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved subscription type |
name | String | The name of the retrieved subscription type |
alternative_code | String | The alternative code of the retrieved subscription type |
description | String | A description of the retrieved subscription type |
classification | String | The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0 |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
description | String | The description of the retrieved job |
life_cycle_state | String | The life cycle state of the retrieved job The supported options are
|
rating_state | String | The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
Accounts Receivable object | The accounts receivable related with the specified job | |
type | Job type object | The type information of the retrieved job Available from CRM.COM R11.2.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved job type |
name | String | The Name of the retrieved job type |
alternative_code | String | The Alternative Code of the retrieved job type |
description | String | The Description of the retrieved job type |
billing_directive | String | The billing directive of the retrieved job type The supported billing directive options are
Available from CRM.COM R10.0.0 |
billing_method | String | The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE The supported billing methods are
Available from CRM.COM R10.0.0 From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
fulfillment_scope | String | The fulfillment scope of the retrieved job type The supported fulfillment scopes are
The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS From CRM.COM R15.0.0 and onward, all fulfillment scopes will be deprecated |
fulfillment_method | String | The fulfillment method of the retrieved job type The supported fulfillment methods are
From CRM.COM R15.0.0 and onward, this attribute will be deprecated |
Name | Type | Description |
---|---|---|
affected_mode | String | Defines how the subscription service was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED |
product | Product object | The product of the service that was affected because of the subscription action |
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 |
---|---|---|
affected_mode | String | Defines how the subscription installed item was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED |
installed_item | Installed Item object | The installed item that was affected because of the subscription action |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved installed item |
serial_number | String | The serial number of the retrieved installed item |
alternative_code | String | The alternative code of the retrieved installed item |
state | String | The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE |
state_classification | State Classification object | The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0 |
Product object | The product of the retrieved installed item |
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 |
---|---|---|
name | String | The name of the installed item's state classification |
alternative_code | String | The alternative code of the installed item's state classification |
description | String | The description of the installed item's state classification |
Examples
HTTP Method: POST
Request:
Body:
{ "token":"482293FF78614B54A8DA0B3AD932E4ED", "subscription_identifier":{"number":"S60647"}, "performed_by_user_identifier":{"username":"JackH"}, "performed_on":"2014-07-16T05:07:41", "installed_items_swap_set": [ { "to_subscription":{"subscription_identifier":{"number":"S60646"}}, "installed_item": { "installed_item_identifier":{"serial_number":"sc000012126"}, "installed_items_distribution_set": [ {"provisioning_distributor_identifier":{"name":"Conax Main 22"}}, {"provisioning_distributor_identifier":{"name":"PA Main"}} ] } } ] }
Response:
{ "status": { "message": "", "description": "", "code": "OK" }, "data": { "scheduled_date": "2016-01-11T13:24:28", "submitted_on": "2016-01-11T13:24:28", "action_type": null, "sub_action_type": null, "business_classification_code": "MOVE_ITEM_TO_OTHER_SUBSCRIPTION", "number": "2635", "executed_on": "2016-01-11T13:24:30", "life_cycle_state": "EXECUTED", "performed_by": { "person_name": "Jack Hadjicosti2", "username": "JackH", "id": "B8650C555C4EA8C741103961276E7773", "email": "j_hadjicosti@crm.com" }, "behavior_code": "MOVE_INSTALLED_ITEM", "id": "4A161CAE7C2E4F18827CD06E7BFDB80A", "submitted_by": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1" }, "subscription": { "life_cycle_state": "EFFECTIVE", "accounts_receivable": { "account_owner": { "last_name": "Smith", "middle_name": null, "life_cycle_state": "FINANCIAL", "company_profile": null, "title": null, "first_name": "Mary", "type": "PERSON", "id": "EEF4B599C62D4051903CC6A15F0EC2F6", "name": "Smith Mary", "company_name": null, "demographics": { "gender": null, "passport_issued_by_country": null, "social_security_number": null, "passport_number": null, "industry_sector": null, "country_of_residence": { "three_character_code": "CYP", "two_character_code": "CY", "id": "181", "name": "CYPRUS", "alternative_code": null }, "name_day": { "month": null, "day": null }, "date_of_birth": { "month": null, "day": null, "year": null }, "id_number": "123213", "industry": null, "id_issued_by_country": null } }, "life_cycle_state": "ACTIVE", "number": "ACR000930", "id": "505D6565E194498EA207ED5ACF2A81F5", "name": "ACR000930" }, "number": "S60647", "type": { "udf_float_1": null, "udf_float_2": null, "udf_date_1": null, "udf_float_3": null, "udf_date_2": null, "udf_float_4": null, "udf_date_3": null, "udf_date_4": null, "name": "United Kingdom", "udf_string_1": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_6": null, "udf_string_7": null, "log_information": { "updated_date": "2015-12-30T13:39:38", "created_date": "2014-06-25T15:44:04", "created_by_unit": { "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_unit": { "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1 Test Description for resource request tab.Test Description for resource request tab.", "alternative_code": "MG" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1" } }, "udf_string_8": null, "id": "1C81FBB1E5D90040F440ECE98D6A368D", "description": "United Kingdom", "alternative_code": "UK" }, "id": "77D5DF0656B141FD8D15DA5EFAF33C1C" }, "performed_on": "2014-07-16T05:07:41" } }
- No labels