- Created by Joseph Ioannou (Unlicensed) , last modified by George Rossides (Unlicensed) on Oct 09, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 12 Next »
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 |
notes | String | The notes of the retrieved job |
contact_email | String | The email of the customer related with the retrieved job, which will be used in order to communicate the job |
contact_phone | String | The phone of the customer related with the retrieved job, which will be used in order to communicate the job |
life_cycle_state | String | The life cycle state of the retrieved job which can be DRAFT, PENDING, IN PROGRESS, COMPLETED, CANCELLED |
start_date | Date | The date that the job is created |
expected_completion_date | Date | The date that the job is expected to be completed |
actual_completed_date | Date | The date that the job is actually completed |
rating_state | String | The rating state of the job The supported options are
|
amount_to_be_paid_through_wallet | Float | The amount that the customer was intending to use from his wallet in order to pay for the specific job |
amount_already_paid | Float | The amount that was already paid for that job, calculated dynamically based on the payments that were submitted against that job |
items_receipt_method | String | Determines if the customer prefers the job physical goods to be send to him at the specified delivery address, to pick them up from a specific unit or in any other way The supported options are
|
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
assigned_to | Assign Object | The assignment information of the retrieved job |
type | Job Type Object | The type information of the retrieved job |
status | Job Status object | The status information of the retrieved job |
category | Job Category object | The category of the retrieved job |
service_request | Service Request Object | The service request that was related to the retrieved job. |
estimated_completion_time | Time Period Object | The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years |
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 |
Accounts Receivable object | The accounts receivable related with the specified job | |
location | Address Object | The physical location that the job should be performed and delivered to |
cancellation_reason | Jobs Cancellation Object | The reason that the job was canceled. This is applicable only if the job is on a canceled life cycle state |
owned_by_group | Group Object | The group that is owning the job |
privacy_level | Privacy Level Object | The job privacy level |
cloned_job | Job Object | The job that was cloned in order to create the new job This is applicable only if the job is a clone of another job |
Unit object | The identifier of the unit that the customer requested to pick up the job physical goods from Applicable only if the items_receipt_method is set as PICK_UP | |
point_of_no_return | Point of no Return Object | The job point of no return |
milestones_set | Set of Milestone Objects | A set of milestones that were reached in relation to the specific job |
ordered_physical_goods_set | Set of Ordered Physical Goods Objects | The physical goods that were requested by the retrieved job |
ordered_expenses_set | Set of Ordered Expenses Objects | The expenses that were requested by the retrieved job |
ordered_activity_services_set | Set of Ordered Activity Services Objects | The activity services that were requested by the retrieved job |
ordered_subscriptions_set | Set of Ordered Subscription and Subscription Action Object | The subscription and subscription actions that were requested by the retrieved job |
bills_set | Set of Bill Objects | A set of bills that were generated by the billing engine in relation to the specific job |
payments_set | Set of Payment Objects | A set of payments that were generated in relation to the specific job |
invoices_set | Set of Invoice Objects | A set of invoices that were generated in relation to the specific job |
credit_notes_set | Set of Credit Notes Objects | A set of credit notes that were generated in relation to the specific job |
Log Information Object | The log information related to the retrieved job |
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 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 job status |
name | String | The name of the retrieved job status |
alternative_code | String | The alternative code of the retrieved job status |
description | String | A description of the retrieved job status |
life_cycle_state | String | The life cycle state related with the retrieved job status The supported life cycle states are the following: DRAFT, PENDING, IN_PROGRESS,COMPLETED,CANCELLED |
Name | Type | Description |
---|---|---|
Id | String | The ID of the retrieved job category |
name | String | The Name of the retrieved job category |
code | String | The code of the retrieved job category |
description | String | The Description of the retrieved job category |
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 |
---|---|---|
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 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 |
From R14.2.0, the following object is applicable for CRM.COM Address Format
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved address |
type | String | The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
postal_code | String | The postal code of the retrieved address |
street_name | String | The street name of the retrieved address |
street_number | String | The street number of the retrieved address |
floor | Integer | The floor of the retrieved address |
apartment_number | String | The apartment number of the retrieved address |
area | String | The area of the retrieved address |
town_city | String | The town / city of the retrieved address |
district | String | The district of the retrieved address |
municipality | String | The municipality of the retrieved address |
po_box | String | The PO box of the retrieved address |
po_box_postal_code | String | The PO box postal code of the retrieved address |
care_of | String | The care of person of the retrieved address |
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_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 |
Country Object | The country of the retrieved address | |
is_primary | Boolean | Defines if the address is the contact's primary address or not. Available from CRM.COM R15 |
From R14.2.0, the following object is applicable for International Address Format
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved address |
type | String | The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
postal_code | String | The postal code of the retrieved address |
town_city | String | The town / city of the retrieved address |
address_line_1 | String | The address line 1 |
address_line_2 | String | The address line 2 |
state_province_county | String | The state or province or county of the address. |
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_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 |
Country Object | The country of the retrieved address | |
is_primary | Boolean | Defines if the address is the contact's primary address or not. Available from CRM.COM R15 |
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 job cancellation reason |
name | String | The name of the retrieved job cancellation reason |
alternative_code | String | The alternative code of the retrieved job cancellation reason |
description | String | A description of the retrieved job 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 |
---|---|---|
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 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 job milestone |
milestone_label | String | The milestone label |
milestone_due_date | Date | The date that the milestone is due |
milestone_reached_date | Date | The date that the milestone was reached |
milestone_state | String | The state of the milestone. Such attribute is set when the related milestone is reached The supported values are
|
User Object | The user that created the related milestone | |
milestone_invoice | Invoice Object | The invoice created against the related milestone (if applicable) |
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 invoice |
number | String | The number of the retrieved invoice |
reference_number | String | The reference number of the retrieved invoice |
life_cycle_state | String | The life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
issued_on | Date | The date that the invoice was issued |
posted_on | Date | The date that the invoice was posted |
due_on | Date | The date that the credit period for that specific invoice is ending. |
total_amount | Number | The total amount of the invoice |
outstanding_amount | Number | The total outstanding amount of the invoice |
unsettled_amount | Number | The total unsettled amount of the invoice |
currency_rate_period | Currency Rate Period object | The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency rate period |
rate | Number | The exchange rate of the currency rate period |
inverse_rate | Number | The inverse exchange rate of the currency rate period |
from_date | Date | The date from which the exchange rate is valid |
to_date | Date | The date until which the exchange rate is valid |
currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency |
code | String | The code of the retrieved currency |
prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
integer_part_name | String | The integer part name for the specified currency |
decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved bill |
number | String | The number of the retrieved bill |
life_cycle_state | String | The life cycle state of the bill. One of the following values is returned: POSTED, PRESENTED, PRESENTED_CONFIRMED, PRESENTED_REJECTED |
from_date | Date | The date from which the accounts receivable is billed for |
to_date | Date | The date until which the accounts receivable is billed for |
due_date | Date | The due date of bill. The field is calculated dynamically. The maximum due date of related invoices. Available from CRM.COM R12.4.0 |
total_billed_amount | Number | The total billed amount |
total_amount_to_be_paid | Number | The total amount to be paid |
bill_status | String | The status of the bill in terms of it is settled or not.The supported values are the following: SETTLED, UNSETTLED, PARTIALLY_SETTLED |
currency | Currency object | The bill's currency Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency |
code | String | The code of the retrieved currency |
prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
integer_part_name | String | The integer part name for the specified currency |
decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved payment |
number | String | The number of the retrieved payment |
reference_number | String | The reference number of the retrieved payment |
life_cycle_state | String | The life cycle state of the payment. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED, PENDING_VERIFICATION |
issued_on | Date | The date that the payment was issued |
posted_on | Date | The date that the payment was posted |
payment_amount | Number | The total amount of the payment |
processed_by_payment_gateway | String | The payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
payment_gateway_reference_number | String | A reference to the number of the payment that was created on the payment gateway. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed |
currency_rate_period | Currency Rate Period | The currency rate period based on which the refund was created Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency rate period |
rate | Number | The exchange rate of the currency rate period |
inverse_rate | Number | The inverse exchange rate of the currency rate period |
from_date | Date | The date from which the exchange rate is valid |
to_date | Date | The date until which the exchange rate is valid |
currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency |
code | String | The code of the retrieved currency |
prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
integer_part_name | String | The integer part name for the specified currency |
decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved invoice |
number | String | The number of the retrieved invoice |
reference_number | String | The reference number of the retrieved invoice |
life_cycle_state | String | The life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
issued_on | Date | The date that the invoice was issued |
posted_on | Date | The date that the invoice was posted |
due_on | Date | The date that the credit period for that specific invoice is ending. |
total_amount | Number | The total amount of the invoice |
outstanding_amount | Number | The total outstanding amount of the invoice |
unsettled_amount | Number | The total unsettled amount of the invoice |
currency_rate_period | Currency Rate Period object | The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency rate period |
rate | Number | The exchange rate of the currency rate period |
inverse_rate | Number | The inverse exchange rate of the currency rate period |
from_date | Date | The date from which the exchange rate is valid |
to_date | Date | The date until which the exchange rate is valid |
currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency |
code | String | The code of the retrieved currency |
prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
integer_part_name | String | The integer part name for the specified currency |
decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved credit note |
number | String | The number of the retrieved credit note |
reference_number | String | The reference number of the retrieved credit note |
life_cycle_state | String | The life cycle state of the credit note. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
issued_on | Date | The date that the credit note was issued |
posted_on | Date | The date that the credit note was posted |
total_amount | Number | The total amount of the credit note |
currency_rate_period | Currency Rate Period object | The currency rate period based on which the credit note's amounts were calculated Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency rate period |
rate | Number | The exchange rate of the currency rate period |
inverse_rate | Number | The inverse exchange rate of the currency rate period |
from_date | Date | The date from which the exchange rate is valid |
to_date | Date | The date until which the exchange rate is valid |
currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved currency |
code | String | The code of the retrieved currency |
prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
integer_part_name | String | The integer part name for the specified currency |
decimal_part_name | String | The decimal part name for the specified currency |
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 |
- No labels