- Created by Former user on Jul 04, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
POST activities/create
This method creates an activity. Single activities can be created by each call. Only customer activities can be created through this method.
Resource URL
Parameters
Name | Type | Description | |||||||||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||||||||
type_identifier (mandatory) | Activity Type Identifier | The type of the activity. The allowed activity type identifiers are the following:
| |||||||||||||||||||||
contact_information_identifier (mandatory) | Contact Information Identifier | The contact information related with the activity. The allowed contact information identifiers are the following:
| |||||||||||||||||||||
category_identifier (optional) | Category Identifier | The category of the activity. The allowed activity category identifiers are the following:
| |||||||||||||||||||||
status_identifier (optional) | Activity Status Identifier | The status of the activity. If not specified then the default status will be set automatically.The allowed activity status identifiers are the following:
| |||||||||||||||||||||
description (optional) | String | The description of the retrieved activity | |||||||||||||||||||||
notes (optional) | String | The notes of the retrieved activity | |||||||||||||||||||||
start_date (optional) | Date | The date that the activity will start | |||||||||||||||||||||
owned_by_group_identifier (mandatory) | The identifier of the owned by group information | The owned by group information of the activity. The allowed group identifier fields are the following:
| |||||||||||||||||||||
privacy_level_identifier (optional) | The identifier of the privacy level | The privacy level of the activity. The allowed privacy level identifier fields are the following:
| |||||||||||||||||||||
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 | |||||||||||||||||||||
expected_completion_date (semi-optional) | Date | The date that the activity is expected to be completed | |||||||||||||||||||||
(semi-optional) | Time Period Object | The time that is estimated to complete the activity, measured in minutes, hours, days, weeks, years | |||||||||||||||||||||
(optional) | Assign To Object | The assignment information of the activity | |||||||||||||||||||||
(optional) | Performed for Object | The entities which are related with the activity | |||||||||||||||||||||
(optional) | Set of Services to be Provided Object | The information related to the services to be provided with the activity | |||||||||||||||||||||
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 |
Referred Parameters Objects Data
Name | Type | Description |
---|---|---|
time_period_value (mandatory) | Number | The time period value |
time_period_uot (mandatory) | String | The time period unit of time The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
user_identifier (semi-optional) | Identifier | The identifier of the user that the activity should be assigned to. The allowed user identifier fields are the following:
| ||||||||||||
unit_identifier (semi-optional) | Identifier | The identifier of the unit that the activity should be assigned to. The allowed unit identifier fields are the following:
|
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
subscription_identifier
| Subscription object | The subscription which is related with the activity. The allowed subscription identifier fields are the following:
| |||||||||
job_identifier | Job object | The job which is related with the activity . The allowed job identifier fields are the following:
| |||||||||
service_request_identifier | Service Request Identifier | The service request which is related with the activity. The allowed service request identifier fields are the following:
| |||||||||
lead_identifier | Lead Identifier | The lead which is related with the activity. The allowed lead identifier fields are the following:
|
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
product_identifier (mandatory) | Product Identifier | The product classified as one time service which is related with the one time service
| ||||||||||||
(optional) | Time Period Object | The time that was spend on each service, measured in minutes, hours, days, weeks, months and years. | ||||||||||||
(optional) | Resource Request Object | The request for resources needed in order to deliver the specified service |
Referred Parameter Objects Data
Name | Type | Description |
---|---|---|
time_period_value (mandatory) | Number | The time period value |
time_period_uot (mandatory) | String | The time period unit of time The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description | ||||||||||||
requested_by_business_unit_identifier (mandatory) | Business Unit Identifier | The Identifier of the business unit that is requesting the resource. The available business unit Identifier fields are the following:
Available from CRM.COM R18.0.0 | ||||||||||||
requested_by_group_identifier (mandatory) | Group Identifier | The Identifier of the Group that is requesting the resource. The available Group Identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
requested_by_unit_identifier (mandatory) | Unit Identifier | The Identifier of the Unit that is requesting the resource. The available Unit Identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
requested_by_user_identifier (mandatory) | User Identifier | The Identifier of the User that is requesting the resource. The available User Identifier fields are the following:
| ||||||||||||
number_of_resources (optional) | Number | The number of required resources | ||||||||||||
planned_date (mandatory) | Date | The planned date | ||||||||||||
from_time (mandatory) | String | The from time that the required resource should be start. | ||||||||||||
to_time (mandatory) | String | The from time that the required resource should be end. | ||||||||||||
requested_resource_plan_entry _identifier (mandatory) | Resource Plan Entry Identifier | The identifier of the resource plan entry which should be reserved for this resource request, in the case were the resource request was accepted. The available resource plan entry identifier fields are the following:
| ||||||||||||
description (optional) | String | The description of the resource request | ||||||||||||
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 |
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 activity |
number | String | The number of the retrieved activity |
description | String | The description of the retrieved activity |
notes | String | The notes of the retrieved activity |
life_cycle_state | String | The life cycle state of the retrieved activity which can be PENDING, IN PROGRESS, COMPLETED, CANCELLED |
start_date | Date | The date that the activity is created |
expected_completion_date | Date | The date that the activity is expected to be completed |
actual_completed_date | Date | The date that the activity is actually completed |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_string_9 | String | User Defined Field of type String |
udf_string_10 | String | User Defined Field of type String |
udf_string_11 | String | User Defined Field of type String |
udf_string_12 | String | User Defined Field of type String |
udf_string_13 | String | User Defined Field of type String |
udf_string_14 | String | User Defined Field of type String |
udf_string_15 | String | User Defined Field of type String |
udf_string_16 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_float_5 | Float | User Defined Field of type Float |
udf_float_6 | Float | User Defined Field of type Float |
udf_float_7 | Float | User Defined Field of type Float |
udf_float_8 | Float | User Defined Field of type Float |
udf_float_9 | Float | User Defined Field of type Float |
udf_float_10 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
udf_date_5 | Date | User Defined Field of type Date |
udf_date_6 | Date | User Defined Field of type Date |
udf_date_7 | Date | User Defined Field of type Date |
udf_date_8 | Date | User Defined Field of type Date |
udf_date_9 | Date | User Defined Field of type Date |
udf_date_10 | Date | User Defined Field of type Date |
assigned_to | Assign Object | The assignment information of the retrieved activity |
type | Activity type object | The type information of the retrieved activity |
status | Activity Status object | The status information of the retrieved activity |
category | Activity Category object | The categories information of the retrieved activity |
estimated_completion_time | Time Period Object | The time that is estimated to complete the activity, measured in MINUTES, HOURS, DAYS, WEEKS, YEARS From CRM.COM R17.0.0, YEARS is deprecated |
time_to_completion | Time Period Object | The time that is left up to the expected completion date |
time_overdue | Time Period Object | The time past the expected completion date |
performed_for | Performed for object | The entities which are related with the activity and can include Subscriptions, Jobs |
Contact Information object | The contact information related with the specified activity | |
cancellation_reason | Activities Cancellation Object | The reason that the activity was cancelled. This is applicable only if the activity is on a cancelled life cycle state |
owned_by_group | Group object | The group that is owning the activity Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
owned_by_business_unit | Business Unit Object | The business unit that is owning the activity Available from CRM.COM R18.0.0 |
privacy_level | Privacy level object | The activity privacy level Deprecated from CRM.COM R18.0.0 |
Log Information Object | The log information related with the retrieved activity | |
services_to_be_provided_set | Services to be Provided object | The services that will be provided as part of the activity and the time that was spend on each one, measured in minutes, hours, days, weeks, months and years. |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
user | User object | The user which is assigned with the retrieved activity |
business_unit | Business Unit object | The business unit which is assigned with the retrieved activity Available from CRM.COM R18.0.0 |
unit | Unit object | The unit which is assigned with the retrieved activity Deprecated from CRM.COM R18.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 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 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 activity type |
name | String | The name of the retrieved activity type |
alternative_code | String | The alternative code of the retrieved activity type |
description | String | A description of the retrieved activity type |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved activity status |
name | String | The name of the retrieved activity status |
alternative_code | String | The alternative code of the retrieved activity status |
description | String | A description of the retrieved activity status |
life_cycle_state | String | The life cycle state related with the retrieved activity status. The supported life cycle states are the following: PENDING, IN_PROGRESS,COMPLETED,CANCELLED |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved activity category |
name | String | The Name of the retrieved activity category |
code | String | The code of the retrieved activity category |
description | String | The description of the retrieved activity category |
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 |
---|---|---|
subscription
| Subscription object | The subscription which is related with the retrieved activity |
job | Job object | The job which is related with the retrieved activity |
service_request | Service Request Object | The service request which is related with the activity |
lead | Lead Object | The lead which is related with the activity |
Referred Objects Response Data
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 |
---|---|---|
id | String | The ID of the retrieved service request |
number | String | The number of the retrieved service request |
description | String | The description of the retrieved service request |
life_cycle_state | String | The life cycle state of the retrieved service request which can be PENDING, RESPONDED, TEMPORARY_RESOLVED, FINAL_RESOLVED, COMPLETED |
Accounts Receivable object | The accounts receivable related with the specified service request |
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 lead |
number | String | The number of the retrieved lead |
description | String | The description of the retrieved lead |
life_cycle_state | String | The life cycle state of the retrieved lead which can be PENDING, IN_PROGRESS, LOST, WON |
Contact Information object | The contact information related with the specified lead |
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 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 activity cancellation reason |
name | String | The name of the retrieved activity cancellation reason |
alternative_code | String | The alternative code of the retrieved activity cancellation reason |
description | String | A description of the retrieved activity cancellation reason |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved group |
name | String | The name of the retrieved group |
community_name | String | The name of the community that the retrieved group belongs to |
alternative_code | String | The alternative code of the retrieved group |
unified_code | String | The unified code of the retrieved group Available from CRM.COM R16.2.2 |
description | String | The description of the retrieved group |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved privacy level |
number | String | The number of the retrieved privacy level |
name | String | The name of the retrieved privacy level |
hierarchy_level | String | The hierarchy level of the retrieved privacy level |
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects Response Data
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 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 activity service to be provided |
time_spend | Time Period Object | The time that was spend on each service, measured in minutes, hours, days, weeks, months and years. |
service | Product object | The product classified as one time service which is related with the retrieved activity service |
resource_requests_set | Set of Resource Request Objects | The resource requests that were submitted against the retrieved activity service |
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 |
---|---|---|
time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved resource request |
number | String | The number of the retrieved resource request |
description | String | The description of the retrieved resource request |
number_of_resources | Number | The number of required resources |
from_date | Date | The start date and time of the period for which the resource is requested for |
to_date | Date | The end date and time of the period for which the resource is requested for |
life_cycle_state | String | The life cycle state of the retrieved resource request which can be PENDING, ACCEPTED, REJECTED or CANCELLED |
Unit Object | The business unit that is requested as a resource Deprecated from CRM.COM R18.0.0 | |
Business Unit Object | The business unit that is requested as a resource Available from CRM.COM R18.0.0 |
Referred Objects Response Data
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 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 |
Examples
HTTP Method: POST
Request:
Body:
{ "token" : "010255E946388E6C1A033037DD21E040", "type_identifier" : { "name" : "Activity Type 2" }, "contact_information_identifier": { "id" : "31260911295E70BB660EBEB0C4F941AC" }, "status_identifier" : { "name" : "To Be approved"}, "description" : "Description For Activity", "start_date" : "2014-08-01T09:00:00", "estimate_completion_time" : { "time_period_value" : 5, "time_period_uot" : "DAYS" }, "assign_to" : { "unit_identifier" : { "name" : "Admin Unit"} }, "performed_for" : { "subscription_identifier" : { "number" : "S60142"} }, "services_to_be_provided_set": [ { "product_identifier" : { "code" : "OTP001"}, "time_spend" : { "time_period_value" : 10, "time_period_uot" : "WEEKS" } }, { "product_identifier" : { "code" : "OTP002" }, "time_spend" : { "time_period_value" : 10, "time_period_uot" : "DAYS" } }, { "product_identifier" : { "code" : "OTP003" }, "time_spend" : { "time_period_value" : 2.5, "time_period_uot" : "DAYS" } } ], "udf_float_1": 10, "udf_float_2": 12, "udf_float_3": 13, "udf_float_4": 14, "udf_string_1": "userfield1", "udf_string_2": "userfield2", "udf_string_3": "userfield3", "udf_date_1" : "2014-08-01T09:00:00", "udf_date_2" : "2014-08-01T09:00:00", "udf_date_3" : "2014-08-01T09:00:00", "udf_string_4": "userfield4", "udf_date_4" : "2014-08-01T09:00:00", "udf_string_5": "userfield5", "udf_string_6": "userfield6", "udf_string_7": "userfield7", "udf_string_8": "userfield8", "privacy_level_identifier": { "id": "0BA1A4672D1A071351BB1297A99F2915" }, "owned_by_group_identifier": { "name": "Nicosia Office", "id": "68D54DA033606669621E3D2E4B355DA0" }, "notes": "ACTIVITY" }
Response:
{ "status": { "message": null, "description": null, "code": "OK" }, "data": { "notes": "ACTIVITY", "udf_string_10": null, "udf_string_11": null, "udf_string_12": null, "udf_date_10": null, "udf_string_13": null, "number": "306", "udf_string_14": null, "performed_for": { "subscription": { "accounts_receivable": { "account_owner": { "last_name": "Xenofontos ", "life_cycle_state": "FINANCIAL", "middle_name": "Iatrou", "company_profile": null, "title": null, "type": "PERSON", "first_name": "Kyriakos", "name": "Kyriakos Xenofontos", "id": "31260911295E70BB660EBEB0C4F941AC", "company_name": null, "demographics": { "gender": "MALE", "passport_issued_by_country": null, "passport_number": null, "social_security_number": null, "country_of_residence": { "name": "UNITED KINGDOM", "id": "126" }, "industry_sector": null, "date_of_birth": { "month": null, "day": null, "year": null }, "name_day": { "month": null, "day": null }, "id_number": "87878000", "id_issued_by_country": null, "industry": null } }, "life_cycle_state": "ACTIVE", "number": "195", "name": "Xenofontos", "id": "5B51429862A7BCBAD60CC81982BBD45B" }, "life_cycle_state": "EFFECTIVE", "number": "S60142", "type": { "name": "United Kingdom", "id": "1C81FBB1E5D90040F440ECE98D6A368D", "description": "For subscribers residing in United Kingdom", "alternative_code": "UK" }, "id": "253A818FECCA1D1B212703FEE056C8EA" }, "job": null }, "udf_string_15": null, "assign_to": { "unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "user": null }, "udf_string_1": "userfield1", "udf_string_16": null, "udf_string_2": "userfield2", "privacy_level": { "number": null, "hierarchy_level": 1, "name": "3", "id": "0BA1A4672D1A071351BB1297A99F2915" }, "contact_information": { "last_name": "Xenofontos ", "life_cycle_state": "FINANCIAL", "middle_name": "Iatrou", "company_profile": null, "title": null, "type": "PERSON", "first_name": "Kyriakos", "name": "Kyriakos Xenofontos", "id": "31260911295E70BB660EBEB0C4F941AC", "company_name": null, "demographics": { "gender": "MALE", "passport_issued_by_country": null, "passport_number": null, "social_security_number": null, "country_of_residence": { "name": "UNITED KINGDOM", "id": "126" }, "industry_sector": null, "date_of_birth": { "month": null, "day": null, "year": null }, "name_day": { "month": null, "day": null }, "id_number": "87878000", "id_issued_by_country": null, "industry": null } }, "udf_string_3": "userfield3", "udf_string_4": "userfield4", "udf_string_5": "userfield5", "udf_string_6": "userfield6", "udf_string_7": "userfield7", "udf_string_8": "userfield8", "udf_string_9": null, "id": "7D8C99BB3F3BBB154105AB0FDA36750C", "udf_date_1": "2014-08-01T09:00:00", "udf_date_2": "2014-08-01T09:00:00", "udf_date_3": "2014-08-01T09:00:00", "expected_completion_date": "2014-08-06T09:00:00", "udf_date_4": "2014-08-01T09:00:00", "start_date": "2014-08-01T09:00:00", "udf_date_5": null, "udf_date_6": null, "udf_date_7": null, "time_to_completion": { "time_period_value": null, "time_period_uot": "DAYS" }, "time_overdue": { "time_period_value": 2.6774193548387095, "time_period_uot": "MONTHS" }, "udf_date_8": null, "udf_date_9": null, "owned_by_group": { "community_name": "Main Community", "name": "Nicosia Office", "id": "68D54DA033606669621E3D2E4B355DA0", "description": null, "alternative_code": "NO" }, "log_information": { "updated_date": "2014-10-27T09:45:10", "created_by_unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "created_date": "2014-10-27T09:45:09", "updated_by_unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "created_by_user": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1", "email": null }, "updated_by_user": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1", "email": null } }, "status": { "name": "To Be approved", "id": "C93B05CCFC11CFFA62BA2A04F87603C8", "description": null, "alternative_code": "TBA" }, "actual_completed_date": null, "life_cycle_state": "PENDING", "estimate_completion_time": { "time_period_value": 5, "time_period_uot": "DAYS" }, "type": { "name": "Activity Type 2", "id": "DC21155B4A625F4B6230BF1B63C393FF", "description": "ACTTYPE", "alternative_code": "AT2" }, "description": "Description For Activity", "category": null, "services_to_be_provided_set": [ { "service": { "product_type": { "physical_good_type": null, "service_type": "ONETIME", "used_for_provisioning": true, "composition_method": "FLAT", "classification": "SERVICES", "name": "One Time Services", "id": "7EDF537A938DECAB1352E6EEAD54A5D0", "description": "A type which is used for one time services", "alternative_code": "OTS" }, "id": "891E24F7F1C8C79A1E179B670680E611", "description": null, "code": "OTP001", "alternative_code": "OTP001" }, "id": "1002C0CB43E2844D3484213DF583C675", "time_spend": { "time_period_value": 10, "time_period_uot": "WEEKS" } }, { "service": { "product_type": { "physical_good_type": null, "service_type": "ONETIME", "used_for_provisioning": true, "composition_method": "FLAT", "classification": "SERVICES", "name": "One Time Services", "id": "7EDF537A938DECAB1352E6EEAD54A5D0", "description": "A type which is used for one time services", "alternative_code": "OTS" }, "id": "0576A176E6C792A1BAF5986B4A3B6E87", "description": null, "code": "OTP003", "alternative_code": "OTP003" }, "id": "E8B588AE000564407B46769F8CC47C1F", "time_spend": { "time_period_value": 2.5, "time_period_uot": "DAYS" } }, { "service": { "product_type": { "physical_good_type": null, "service_type": "ONETIME", "used_for_provisioning": true, "composition_method": "FLAT", "classification": "SERVICES", "name": "One Time Services", "id": "7EDF537A938DECAB1352E6EEAD54A5D0", "description": "A type which is used for one time services", "alternative_code": "OTS" }, "id": "9485FC0F5C75279E4E8E1FF3B7B247AE", "description": null, "code": "OTP002", "alternative_code": "OTP002" }, "id": "6BF2E43266367D991AA594C911A43227", "time_spend": { "time_period_value": 10, "time_period_uot": "DAYS" } } ] } }
HTTP Method: POST
Request:
Body:
{ "token" : "2F734D18F7024990B91204ED5BC5CEFF", "type_identifier" : { "name" : "Activity Type 2" }, "contact_information_identifier": { "id" : "31260911295E70BB660EBEB0C4F941AC" }, "status_identifier" : { "name" : "To Be approved"}, "description" : "Description For Activity", "start_date" : "2015-02-23T09:00:00", "estimate_completion_time" : { "time_period_value" : 5, "time_period_uot" : "DAYS" }, "assign_to" : { "unit_identifier" : { "name" : "Admin Unit"} }, "performed_for" : { "subscription_identifier" : { "number" : "S60142"} }, "services_to_be_provided_set": [ { "product_identifier" : { "code" : "Installation"}, "time_spend" : { "time_period_value" : 10, "time_period_uot" : "WEEKS" }, "resource_request":{ "requested_by_group_identifier" : {"name" : "Developers Group"}, "planned_date" : "2015-02-25T00:00:00", "from_time" : "12:00", "to_time" : "18:00", "requested_by_unit_identifier" : {"name" : "U1"}, "requested_by_user_identifier" : {"username" : "MPAdministrator"}, "requested_resource_plan_entry_identifier" : { "number" : "1827"}, "requested_one_time_service_identifier":{"code" : "Installation"}, "number_of_resources":1 } } ], "udf_float_1": 10, "udf_float_2": 12, "udf_float_3": 13, "udf_float_4": 14, "udf_string_1": "userfield1", "udf_string_2": "userfield2", "udf_string_3": "userfield3", "udf_date_1" : "2014-08-01T09:00:00", "udf_date_2" : "2014-08-01T09:00:00", "udf_date_3" : "2014-08-01T09:00:00", "udf_string_4": "userfield4", "udf_date_4" : "2014-08-01T09:00:00", "udf_string_5": "userfield5", "udf_string_6": "userfield6", "udf_string_7": "userfield7", "udf_string_8": "userfield8", "privacy_level_identifier": { "id": "0BA1A4672D1A071351BB1297A99F2915" }, "owned_by_group_identifier": { "name": "Nicosia Office", "id": "68D54DA033606669621E3D2E4B355DA0" }, "notes": "ACTIVITY" }
Response:
{ "status": { "message": null, "description": null, "code": "OK" }, "data": { "udf_string_10": null, "udf_float_1": 10, "udf_string_11": null, "udf_float_2": 12, "udf_string_12": null, "udf_float_3": 13, "udf_string_13": null, "udf_float_4": 14, "udf_string_14": null, "udf_float_5": null, "udf_string_15": null, "udf_string_16": null, "udf_float_6": null, "udf_string_1": "userfield1", "udf_string_2": "userfield2", "udf_float_7": null, "privacy_level": { "number": null, "hierarchy_level": 1, "name": "3", "id": "0BA1A4672D1A071351BB1297A99F2915" }, "contact_information": { "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 } }, "udf_string_3": "userfield3", "udf_float_8": null, "udf_string_4": "userfield4", "udf_float_9": null, "udf_string_5": "userfield5", "udf_string_6": "userfield6", "udf_string_7": "userfield7", "udf_string_8": "userfield8", "udf_string_9": null, "id": "975C62DEB1B54E5BB212B2ADFB52BE6F", "expected_completion_date": "2015-02-28T09:00:00", "time_to_completion": { "time_period_value": 4, "time_period_uot": "DAYS" }, "time_overdue": { "time_period_value": null, "time_period_uot": null }, "log_information": { "updated_date": "2015-02-24T13:19:32", "created_by_unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "created_date": "2015-02-24T13:19:30", "updated_by_unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "created_by_user": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1" }, "updated_by_user": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1" } }, "life_cycle_state": "PENDING", "estimate_completion_time": { "time_period_value": 5, "time_period_uot": "DAYS" }, "type": { "name": "Activity Type 2", "id": "DC21155B4A625F4B6230BF1B63C393FF", "description": "ACTTYPE", "alternative_code": "AT2" }, "services_to_be_provided_set": [ { "service": { "product_type": { "physical_good_type": null, "service_type": "ONETIME", "used_for_provisioning": true, "composition_method": "FLAT", "classification": "SERVICES", "name": "One Time Services", "id": "7EDF537A938DECAB1352E6EEAD54A5D0", "description": "A type which is used for one time services", "alternative_code": "OTS" }, "id": "8E990D550CC2F4D2951A273E9D84F9E6", "description": null, "code": "Installation", "alternative_code": "IN" }, "resource_requests_set": [ { "to_date": "2015-02-25T18:00:00", "from_date": "2015-02-25T12:00:00", "number_of_resources": 1, "requested_unit": null, "life_cycle_state": "PENDING", "number": "82", "id": "6896A4B4FB80478AA6E119B64EC1DD4E", "description": null } ], "id": "870F53BEA9AC4C4A9DFF0E66924BB7A1", "time_spend": { "time_period_value": 10, "time_period_uot": "WEEKS" } } ], "notes": "Marios Lannister 24/2/2015 13:19:30 ACTIVITY", "udf_date_10": null, "number": "31", "performed_for": { "service_request": null, "lead": null, "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": "S60142", "type": { "name": "United Kingdom", "id": "1C81FBB1E5D90040F440ECE98D6A368D", "description": "For subscribers residing in United Kingdom", "alternative_code": "UK" }, "id": "253A818FECCA1D1B212703FEE056C8EA" }, "job": null }, "assign_to": { "unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "user": null }, "udf_date_1": "2014-08-01T09:00:00", "udf_date_2": "2014-08-01T09:00:00", "udf_float_10": null, "udf_date_3": "2014-08-01T09:00:00", "udf_date_4": "2014-08-01T09:00:00", "start_date": "2015-02-23T09:00:00", "udf_date_5": null, "udf_date_6": null, "udf_date_7": null, "udf_date_8": null, "udf_date_9": null, "owned_by_group": { "community_name": "Main Community", "name": "Nicosia Office", "id": "68D54DA033606669621E3D2E4B355DA0", "description": null, "alternative_code": "NO" }, "status": { "name": "To Be approved", "id": "C93B05CCFC11CFFA62BA2A04F87603C8", "description": null, "alternative_code": "TBA" }, "actual_completed_date": null, "description": "Description For Activity", "category": null } }
- No labels