Skip to end of banner
Go to start of banner

GET leads/get_overdue

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Available from CRM.COM R5.0.0


This method returns all leads which are not completed and are past their expected completion time. Multiple leads are returned by each call. Note that identifiers are optional for this method.


Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(optional)

Contact information identifier

The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number 

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number 

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

type_identifier
(optional)

Lead type identifier

The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the lead type

name

(semi-optional)

String

The name of the lead type

alternative_code

(semi-optional)

String

The alternative code of lead type

category_identifier

(optional)

Lead Category Identifier

The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the lead category

name

(semi-optional)

String

The name of the lead category

code

(semi-optional)

String

The code of  the lead category

source_identifier

(optional)

Lead Source Identifier

The identifier of the source lead. The allowed lead source identifier fields are the following:

Name

Type

Description

type

(semi-optional)

String

The source type related with the leads that should be returned as a result. The allowed lead source type fields are the following: ADVERTISEMENT, NOTIFICATIONS, COMMUNICATIONS, RECOMMENDED_BY_CONTACT, RECOMMENDED_BY_EMPLOYEE,RECOMMENDED_BY_PARTNER, WEBSITE, OTHER, CUSTOM1, CUSTOM2, CUSTOM3

name

(semi-optional)

String

The source name related with the leads that should be returned as a result. The allowed lead source name is a free text and applies for the case that a source of type ADVERTISEMENT, WEBSITE, OTHER, CUSTOM1, CUSTOM2, CUSTOM3

source_notifications_identifier

(semi-optional)

Notification Identifier

The notification related with the source of the leads that should be returned as a result. The allowed notification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the notification

number

(semi-optional)

String

The number of the notification

source_communications_identifier

(semi-optional)

Communication Identifier

The communication related with the source of the leads that should be returned as a result. The allowed communication identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the communication

number

(semi-optional)

String

The number of the communicaiton

source_recommended_by_contact_identifier

(semi-optional)

Contact Information Identifier

The contact information related with the source of the leads that should be returned as a result. The allowed contact information identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number 

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number 

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

source_recommended_by_employee_identifier

(semi-optional)

User Identifier

The user information related with the source of the leads that should be returned as a result. The allowed user identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

source_recommended_by_partner_identifier

(semi-optional)

Contact Information Identifier

The contact information representing the partner related with the source of the leads that should be returned as a result. The allowed contact information identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number 

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number 

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

importance

(optional)

Lead Importance

The importance related with the leads that should be returned as a result. The allowed lead importance fields are the following: IMPORTANCE1, IMPORTANCE2, IMPORTANCE3, IMPORTANCE4, IMPORTANCE5, CUSTOM1, CUSTOM2, CUSTOM3

priority

(optional)

Lead Priority

The priority related with the leads that should be returned as a result. The allowed lead priority fields are the following: 1, 2, 3, 4, 5, 6

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name

Type

Description

id

String

The ID of the retrieved lead

number

String

The number of the retrieved lead 

contact_emailStringThe email address of the contact as specified on the retrieved lead
contact_phoneString

The phone of the contact as specified on the retrieved lead

Available from CRM.COM R11.1.0

descriptionStringThe 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, CANCELLED

CANCELLED life cycle state available from CRM.COM R11.1.0

probability_to_winNumberThe probability to win the retrieved lead which can vary from 0 to 100
importanceString

The importance of the retrieved lead, which can be one of the following:

IMPORTANCE1, IMPORTANCE2, IMPORTANCE3, IMPORTANCE4, IMPORTANCE5, CUSTOM1, CUSTOM2 , CUSTOM3

priorityString

The priority level of the retrieved lead, which can be one of the following:

1, 2, 3, 4, 5, 6

target_amountNumberThe amount that is predicted to be gained when winning the retrieved lead
start_dateDateThe date that the lead is created
expected_completion_dateDateThe date that the lead is expected to be completed
actual_completion_dateDateThe date that the lead 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_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

lead_sourceLead Source ObjectThe source related with the specified lead and lead source type

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified lead

contact_informationContact Information objectThe contact information related with the specified lead 
lead_ownerUser object

The user who owns the specified lead

Available from CRM.COM R15.0.0

assigned_toAssign ObjectThe assignment information of the retrieved lead
typeLead type objectThe type information of the retrieved lead
statusLead Status objectThe status information of the retrieved lead
lost_reasonLead Lost Reason ObjectThe reason that the Lead was lost.
categoryLead Category objectThe category of the retrieved lead
estimated_completion_timeTime Period ObjectThe time that is estimated to complete the lead, measured in minutes, hours, days, weeks, years
time_to_completionTime Period ObjectThe time that is left up to the expected completion date
time_overdueTime Period ObjectThe time past the expected completion date
owned_by_groupGroup object

The group that is owning the lead

Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)

owned_by_business_unitBusiness Unit Object

The business unit that is owning the lead

Available from CRM.COM R18.0.0

privacy_levelPrivacy level object

The privacy level of the lead

Deprecated from CRM.COM R18.0.0

log_information

Log Information Object

The log information related with the retrieved lead

competitors_setSet of Lead Competitor Objects

A lists of all possible competitors that can reach the same Lead for the same product/goal.

From CRM.COM R18.0.0, competitors are referring to company contact information

users_setSet of Lead UsersA list of Users that are set as the team involved with the lead
products_setSet of Lead Products Objects

A list of products for which the lead was taken for

Available from CRM.COM R14

Up to CRM.COM R17.0.0, products refer only to physical goods and services

subscription_package

Subscription Package Object

The subscription packages for which the retrieved lead was taken for

Available from CRM.COM R14

Deprecated from CRM.COM R18.0.0

Referred Objects Response Data

 lead_source_object response data

Name

Type

Description

id

String

The ID of the retrieved lead source type

typeStringThe source type of the retrieved lead, which can be: ADVERTISEMENT, NOTIFICATIONS, COMMUNICATIONS, RECOMMENDED_BY_CONTACT, RECOMMENDED_BY_EMPLOYEE, RECOMMENDED_BY_PARTNER, WEBSITE, OTHER, CUSTOM1, CUSTOM2, CUSTOM3

name

 

String

The lead source name related with the leads that should be returned as a result if the lead source is of one of the following types: ADVERTISEMENT, WEBSITE, OTHER, CUSTOM1, CUSTOM2, CUSTOM3

notification

 

Notifications Object

The notification information related with the leads of source type NOTIFICATIONS

communications

Communication Object

The communication information related with the leads of source type COMMUNICATIONS

recommended_by_contact

Contact information object

The contact information related with the leads of source type RECOMMENDED_BY_CONTACT

recommended_by_employee

User Object

The user information related with the leads of source type RECOMMENDED_BY_EMPLOYEE

recommended_by_partner

Contact information object

The contact information related with the leads of source type RECOMMENDED_BY_PARTNER (for now they are the same with the contact, until partner functionality is implemented)

Referred Objects Response Data

 notification object response data

Name

Type

Description

idStringThe ID of the retrieved notification
numberStringThe number of the retrieved notification
life_cycle_stateStringThe life cycle state of the retrieved notification which can be PENDING, REJECTED or COMPLETED and is calculated dynamically based on the related communication queue entry life cycle state
contact_informationContact Information objectThe contact information related with the specific notification
account receivableAccount Receivable objectThe account receivable related with the specific notification

Referred Objects Response Data

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe 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_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 communication object response data
Name
Type
Description
IdStringThe ID of the communication
numberStringThe code of communication

life_cycle_state

String

The lifecycle state of the retrieved communication which can be DRAFT or COMPLETE

subjectString

The subject of the retrieved communication

viewedBoolean

Defines whether the communication was viewed, or not

Available from CRM.COM R12.2.0

viewed_onDate

The date that the communication was viewed

Available from CRM.COM R12.2.0

contact_informationContact Information objectThe contact information related with the specified communication

Referred Objects Response Data

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 

 

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 user object 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

email

String

The email of the retrieved user

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe 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_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 user object 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

email

String

The email of the retrieved user

 assigned_to object response data

Name

Type

Description

userUser objectThe user which is assigned with the retrieved activity 
business_unitBusiness Unit object

The business unit which is assigned with the retrieved activity

Available from CRM.COM R18.0.0

unitUnit object

The unit which is assigned with the retrieved activity 

Deprecated from CRM.COM R18.0.0

Referred Objects Response Data

 user object 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

email

String

The email of the retrieved user

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 unit object 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

 lead_type response data object
NameType Description
IdStringThe ID of the retrieved lead type
nameStringThe Name of the retrieved lead type
alternative_codeStringThe Alternative Code of the retrieved lead type
descriptionStringThe Description of the retrieved lead type

 lead_status object response data

Name

Type

Description

id

String

The ID of the retrieved lead status

name

String

The name of the retrieved lead status

alternative_code

String

The alternative code of the retrieved lead status

descriptionStringA description of the retrieved lead status
life_cycle_stateString

The life cycle state related with the retrieved lead status. The supported life cycle states are the following:

PENDING, IN_PROGRESS, LOST, WON, CANCELLED

CANCELLED life cycle state available from CRM.COM R11.1.0

 lead_lost_reason object response data

Name

Type

Description

id

String

The ID of the retrieved lead lost reason

name

String

The name of the retrieved lead lost reason

alternative_code

String

The alternative code of the retrieved lost reason

descriptionStringA description of the retrieved lead lost reason

 lead_category data object
NameType Description
idStringThe ID of the retrieved lead category
nameStringThe Name of the retrieved lead category
codeStringThe Code of the retrieved lead category
descriptionStringThe Description of the retrieved lead category
parent_idString

The id of the retrieved category's parent category

 period object response data

Name

Type

Description

time_period_valueNumber

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

 group object response data

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_codeString

The unified code of the retrieved group

Available from CRM.COM R16.2.2

description

String

The description of the retrieved group

 privacy_level object response data

Name

Type

Description

id

String

The id of the retrieved privacy level

numberStringThe 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

 log_information object response data

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

created_by_unit

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

created_by_business_unit

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

created_by_user

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

updated_by_unit

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

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

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

 unit object 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

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object 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

email

String

The email of the retrieved user

 lead_users object response data

Name

Type

Description

id

String

The ID of the retrieved lead user

userUser objectThe user which is related with the retrieved lead user

Referred Objects Response Data

 user object 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

email

String

The email of the retrieved user

 lead_competitors object response data

Name

Type

Description

id

String

The ID of the retrieved lead competitor

Deprecated from CRM.COM R18.0.0 

company_competitorContact Information Object

The company contact information related to the lead competitor

Available from CRM.COM R18.0.0 

competitorCompetitor object

The competitor which is related with the retrieved lead competitor

Deprecated from CRM.COM R18.0.0 

Referred Objects Response Data

 contact_information object 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object 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_dateDate

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_dateDate

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

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object 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_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 company profile object response data

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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 industry object response data

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

 industry sector object response data

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

 competitor object response data

Name

Type

Description

id

String

The ID of the retrieved lead competitor

name

String

The name of the retrieved lead competitor

descriptionStringA description of the retrieved lead competitor
websiteStringThe website of the retrieved lead competitor

 lead_services object response data

Name

Type

Description

id

String

The ID of the retrieved lead service

productProduct objectThe product classified as service which is related with the retrieved lead service
product_typeProduct type objectThe product type classified as service which is related with the retrieved lead service
product_familyProduct family objectThe product family classified as service which is related with the retrieved lead service
product_brandProduct brand objectThe product brand classified as service which is related with the retrieved lead service

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 global rate object response data

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:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

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

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 product_family object data response
NameType Description
IdStringThe ID of the retrieved product family
nameStringThe Name of the retrieved product family
codeStringThe code of the retrieved product family
descriptionStringThe Description of the retrieved product family

 product_brand object data response
NameType Description
IdStringThe ID of the retrieved product brand
nameStringThe Name of the retrieved product brand
alternative_codeStringThe Alternative Code of the retrieved product brand
descriptionStringThe Description of the retrieved product brand

 lead_physical_goods object response data

Name

Type

Description

id

String

The ID of the retrieved lead physical good

productProducts ObjectThe product related with the retrieved lead physical good

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 global rate object response data

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:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

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

 lead_subscription_package object response data

Name

Type

Description

id

String

The ID of the retrieved lead subscription package

subscription_packageSubscription Package ObjectThe subscription package related with the retrieved lead subscription package

Referred Objects Response Data

 subscription type object response data

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

descriptionStringA description of the retrieved subscription type
classificationString

The classification of the retrieved subscription type, Flexible or Package

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

Examples

 Example 1

HTTP Method: GET

 

Request: http://host_name/crmapi/rest/v2/leads/get_overdue?token=8308DBB946F992DF90863872E1AD5391&type_identifier=name=Software Purchase

Response:

{
   "status":
   {
       "message": null,
       "description": null,
       "code": "OK"
   },
   "data":
   [
       {
           "actual_completion_date": null,
           "services_set":
           [
           ],
           "target_amount": null,
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "11",
           "udf_float_4": null,
           "competitors_set":
           [
           ],
           "udf_string_1": null,
           "udf_string_2": null,
           "assigned_to":
           {
               "unit": null,
               "user":
               {
                   "person_name": "Antonis",
                   "username": "Antonis",
                   "id": "40928D9B96FE6CB963D2DD8955814774",
                   "email": null
               }
           },
           "estimated_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "MONTHS"
           },
           "udf_string_3": null,
           "privacy_level": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "physical_goods_set":
           [
           ],
           "udf_string_7": null,
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner": null,
               "life_cycle_state": "ACTIVE",
               "number": "506",
               "name": "t1",
               "id": "452040A4F233459C6FDB249B198C4C48"
           },
           "id": "43EBC5DD14A59E3D8973534EF55E5A86",
           "probability_to_win": null,
           "priority": 2,
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "expected_completion_date": "2015-05-12T15:10:44",
           "udf_date_4": null,
           "start_date": "2015-02-12T15:10:44",
           "users_set":
           [
           ],
           "time_overdue":
           {
               "time_period_value": 9.137931034482758,
               "time_period_uot": "MONTHS"
           },
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "log_information":
           {
               "updated_date": "2015-02-12T15:11:30",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-02-12T15:10:44",
               "updated_by_unit":
               {
                   "community_name": null,
                   "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": "Interest",
               "id": "B738753EE56D01FC6CD964D14FBBCC7A",
               "description": null,
               "alternative_code": "I"
           },
           "importance": "IMPORTANCE1",
           "life_cycle_state": "IN_PROGRESS",
           "type":
           {
               "name": "Software Purchase",
               "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
               "description": null,
               "alternative_code": "SP"
           },
           "description": null,
           "contact_email": "11",
           "category":
           {
               "name": "Software Purchase",
               "id": "C60F332D0B4CB8DD22A0159413951434",
               "description": null,
               "code": null
           }
       },
       {
           "actual_completion_date": null,
           "services_set":
           [
           ],
           "target_amount": null,
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "12",
           "udf_float_4": null,
           "competitors_set":
           [
           ],
           "udf_string_1": null,
           "udf_string_2": null,
           "assigned_to":
           {
               "unit": null,
               "user":
               {
                   "person_name": "Antonis",
                   "username": "Antonis",
                   "id": "40928D9B96FE6CB963D2DD8955814774",
                   "email": null
               }
           },
           "estimated_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "MONTHS"
           },
           "udf_string_3": null,
           "privacy_level": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "physical_goods_set":
           [
           ],
           "udf_string_7": null,
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner": null,
               "life_cycle_state": "ACTIVE",
               "number": "507",
               "name": "ac",
               "id": "AEB2C1AA39202E85A7C6195B3794A06A"
           },
           "id": "3BDE92A368211F2BAC01E8A3263B9583",
           "probability_to_win": null,
           "priority": 2,
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "expected_completion_date": "2015-05-12T15:15:24",
           "udf_date_4": null,
           "start_date": "2015-02-12T15:15:24",
           "users_set":
           [
           ],
           "time_overdue":
           {
               "time_period_value": 9.137931034482758,
               "time_period_uot": "MONTHS"
           },
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "log_information":
           {
               "updated_date": "2015-02-12T15:16:39",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-02-12T15:15:24",
               "updated_by_unit":
               {
                   "community_name": null,
                   "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": "Interest",
               "id": "B738753EE56D01FC6CD964D14FBBCC7A",
               "description": null,
               "alternative_code": "I"
           },
           "importance": "IMPORTANCE1",
           "life_cycle_state": "IN_PROGRESS",
           "type":
           {
               "name": "Software Purchase",
               "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
               "description": null,
               "alternative_code": "SP"
           },
           "description": null,
           "contact_email": "43d@cd.com",
           "category":
           {
               "name": "Software Purchase",
               "id": "C60F332D0B4CB8DD22A0159413951434",
               "description": null,
               "code": null
           }
       },
       {
           "actual_completion_date": null,
           "services_set":
           [
           ],
           "target_amount": null,
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "13",
           "udf_float_4": null,
           "competitors_set":
           [
           ],
           "udf_string_1": null,
           "udf_string_2": null,
           "assigned_to":
           {
               "unit": null,
               "user":
               {
                   "person_name": "Antonis",
                   "username": "Antonis",
                   "id": "40928D9B96FE6CB963D2DD8955814774",
                   "email": null
               }
           },
           "estimated_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "MONTHS"
           },
           "udf_string_3": null,
           "privacy_level": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "physical_goods_set":
           [
           ],
           "udf_string_7": null,
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner": null,
               "life_cycle_state": "ACTIVE",
               "number": "508",
               "name": "test33333",
               "id": "E2E03F572B46A15FE8B0F8BB90088AA7"
           },
           "id": "03A24D3D2C371263B524F1371DC7B04A",
           "probability_to_win": null,
           "priority": 2,
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "expected_completion_date": "2015-05-12T15:16:48",
           "udf_date_4": null,
           "start_date": "2015-02-12T15:16:48",
           "users_set":
           [
           ],
           "time_overdue":
           {
               "time_period_value": 9.137931034482758,
               "time_period_uot": "MONTHS"
           },
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "log_information":
           {
               "updated_date": "2015-02-12T15:17:48",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-02-12T15:16:48",
               "updated_by_unit":
               {
                   "community_name": null,
                   "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": "Interest",
               "id": "B738753EE56D01FC6CD964D14FBBCC7A",
               "description": null,
               "alternative_code": "I"
           },
           "importance": "IMPORTANCE1",
           "life_cycle_state": "IN_PROGRESS",
           "type":
           {
               "name": "Software Purchase",
               "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
               "description": null,
               "alternative_code": "SP"
           },
           "description": null,
           "contact_email": "test@crm.com",
           "category":
           {
               "name": "Software Purchase",
               "id": "C60F332D0B4CB8DD22A0159413951434",
               "description": null,
               "code": null
           }
       },
       {
           "actual_completion_date": null,
           "services_set":
           [
               {
                   "id": "CFBA6EE27C3FB776B961074F22A3746C",
                   "product":
                   {
                       "product_type": null,
                       "id": "7D4A6FE566968324344AF2BFE3AB643C",
                       "description": "Adult- Only for Additional ",
                       "code": "Adult- Only for Additional ",
                       "alternative_code": null
                   }
               },
               {
                   "id": "2C23866BA622ECEA63B23595693D9EFC",
                   "product":
                   {
                       "product_type": null,
                       "id": "2DAC89CF56BE7B661E1A1B0246E8BF08",
                       "description": "Kids TV",
                       "code": "Kids TV",
                       "alternative_code": null
                   }
               }
           ],
           "target_amount": null,
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "14",
           "udf_float_4": null,
           "competitors_set":
           [
               {
                   "id": "DED53D29AEE8E1A4FE08576BC5CCD7C4",
                   "competitor":
                   {
                       "website": "www.competitor2.com",
                       "name": "Competitor 2",
                       "id": "F868B1EFFFB42A5232186348362A5C91",
                       "description": null
                   }
               }
           ],
           "udf_string_1": null,
           "udf_string_2": null,
           "assigned_to":
           {
               "unit": null,
               "user":
               {
                   "person_name": "Scheduler",
                   "username": "Scheduler",
                   "id": "3",
                   "email": null
               }
           },
           "estimated_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "MONTHS"
           },
           "udf_string_3": null,
           "privacy_level": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "physical_goods_set":
           [
               {
                   "id": "80C7CDE3E56F558725399F78F50E4DEB",
                   "product":
                   {
                       "product_type": null,
                       "id": "F7CEEAAFCE2519EDBD207755588F34F9",
                       "description": "Card product 003",
                       "code": "Card Product 003",
                       "alternative_code": "CP003"
                   }
               }
           ],
           "udf_string_7": null,
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner": null,
               "life_cycle_state": "ACTIVE",
               "number": "509",
               "name": "l1l1",
               "id": "61009F6CCC79188E6040D0FF308758DC"
           },
           "id": "AF71019727FA80E97E26147A849B65E4",
           "lead_source":
           {
               "type": "ADVERTISEMENT",
               "name": "test"
           },
           "probability_to_win": null,
           "priority": 2,
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "expected_completion_date": "2015-05-12T15:18:15",
           "udf_date_4": null,
           "start_date": "2015-02-12T15:18:15",
           "users_set":
           [
           ],
           "time_overdue":
           {
               "time_period_value": 9.137931034482758,
               "time_period_uot": "MONTHS"
           },
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "log_information":
           {
               "updated_date": "2015-02-12T16:42:10",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-02-12T15:18:15",
               "updated_by_unit":
               {
                   "community_name": null,
                   "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": "Interest",
               "id": "B738753EE56D01FC6CD964D14FBBCC7A",
               "description": null,
               "alternative_code": "I"
           },
           "importance": "IMPORTANCE1",
           "life_cycle_state": "IN_PROGRESS",
           "type":
           {
               "name": "Software Purchase",
               "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
               "description": null,
               "alternative_code": "SP"
           },
           "description": null,
           "contact_email": "l1@crm.com",
           "category":
           {
               "name": "Software Purchase",
               "id": "C60F332D0B4CB8DD22A0159413951434",
               "description": null,
               "code": null
           }
       },
       {
           "actual_completion_date": null,
           "services_set":
           [
           ],
           "target_amount": null,
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "19",
           "udf_float_4": null,
           "competitors_set":
           [
           ],
           "udf_string_1": null,
           "udf_string_2": null,
           "assigned_to":
           {
               "unit": null,
               "user":
               {
                   "person_name": "Smanager",
                   "username": "Smanager",
                   "id": "DCA93D75753E5CC5AD1E69556368E616",
                   "email": null
               }
           },
           "estimated_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "MONTHS"
           },
           "udf_string_3": null,
           "privacy_level": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "physical_goods_set":
           [
           ],
           "udf_string_7": null,
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner":
               {
                   "last_name": "Lannister",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": null,
                   "company_profile": null,
                   "title": "Mr",
                   "type": "PERSON",
                   "first_name": "Marios",
                   "name": null,
                   "id": "F60EF6A65658F86B3DFADA3809BD85C4",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "MALE",
                       "passport_issued_by_country": null,
                       "passport_number": null,
                       "social_security_number": null,
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": 5,
                           "day": 1,
                           "year": 1963
                       },
                       "name_day":
                       {
                           "month": 5,
                           "day": 1
                       },
                       "id_number": "593664",
                       "industry": null
                   }
               },
               "life_cycle_state": "ACTIVE",
               "number": "4",
               "name": "mar",
               "id": "5C7045E4DCE86FE0670CEE3A32437227"
           },
           "id": "7E4D45DD4000EB8B71CC5656A6C93C03",
           "lead_source":
           {
               "recommended_by_employee":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               },
               "type": "RECOMMENDEDBYEMPLOYEE"
           },
           "probability_to_win": null,
           "priority": 2,
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "expected_completion_date": "2015-05-13T09:52:09",
           "udf_date_4": null,
           "start_date": "2015-02-13T09:52:09",
           "users_set":
           [
           ],
           "time_overdue":
           {
               "time_period_value": 9.10344827586207,
               "time_period_uot": "MONTHS"
           },
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "log_information":
           {
               "updated_date": "2015-02-13T11:32:02",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-02-13T09:52:09",
               "updated_by_unit":
               {
                   "community_name": null,
                   "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": "Interest",
               "id": "B738753EE56D01FC6CD964D14FBBCC7A",
               "description": null,
               "alternative_code": "I"
           },
           "importance": "IMPORTANCE1",
           "life_cycle_state": "IN_PROGRESS",
           "type":
           {
               "name": "Software Purchase",
               "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
               "description": null,
               "alternative_code": "SP"
           },
           "description": null,
           "contact_email": "photos.panayi@crm.com",
           "category":
           {
               "name": "Software Purchase",
               "id": "C60F332D0B4CB8DD22A0159413951434",
               "description": null,
               "code": null
           }
       },
       {
           "actual_completion_date": null,
           "services_set":
           [
           ],
           "target_amount": null,
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "24",
           "udf_float_4": null,
           "competitors_set":
           [
           ],
           "udf_string_1": null,
           "udf_string_2": null,
           "assigned_to":
           {
               "unit": null,
               "user":
               {
                   "person_name": "csmanager",
                   "username": "csmanager",
                   "id": "344BFEB717808669B0BF955212FEB28C",
                   "email": null
               }
           },
           "estimated_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "MONTHS"
           },
           "udf_string_3": null,
           "privacy_level": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "udf_string_6": null,
           "physical_goods_set":
           [
           ],
           "udf_string_7": null,
           "udf_string_8": null,
           "accounts_receivable":
           {
               "account_owner":
               {
                   "last_name": "Browndasda",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": "fsafa",
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Simon",
                   "name": null,
                   "id": "99A9AF3ACF4991ED5E1DB1DEFB72209A",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "MALE",
                       "passport_issued_by_country": null,
                       "passport_number": null,
                       "social_security_number": "230664",
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": 1,
                           "day": 1,
                           "year": 1947
                       },
                       "name_day":
                       {
                           "month": 1,
                           "day": 1
                       },
                       "id_number": "895623",
                       "industry": null
                   }
               },
               "life_cycle_state": "ACTIVE",
               "number": "85",
               "name": "SM1",
               "id": "A032BB90C0F1A1E1F5DE97FFFCC7BBCD"
           },
           "id": "7086AF522C6724DB825A1CE400F3C296",
           "lead_source":
           {
               "type": "RECOMMENDEDBYCONTACT",
               "recommended_by_contact":
               {
                   "last_name": "Christodoulou",
                   "life_cycle_state": "FINANCIAL",
                   "middle_name": null,
                   "company_profile": null,
                   "title": null,
                   "type": "PERSON",
                   "first_name": "Elisa",
                   "name": "Elisa Christodoulou",
                   "id": "290041FAAE222A7358DC79C0D1CFFAAF",
                   "company_name": null,
                   "demographics":
                   {
                       "gender": "FEMALE",
                       "passport_issued_by_country":
                       {
                           "name": "ALGERIA",
                           "id": "130"
                       },
                       "passport_number": "1234567",
                       "social_security_number": null,
                       "country_of_residence":
                       {
                           "name": "ALBANIA",
                           "id": "129"
                       },
                       "industry_sector": null,
                       "date_of_birth":
                       {
                           "month": 3,
                           "day": 3,
                           "year": 1990
                       },
                       "name_day":
                       {
                           "month": 2,
                           "day": 6
                       },
                       "id_number": "123456",
                       "id_issued_by_country":
                       {
                           "name": "ALGERIA",
                           "id": "130"
                       },
                       "industry": null
                   }
               }
           },
           "probability_to_win": null,
           "priority": 2,
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "expected_completion_date": "2015-05-13T11:16:18",
           "udf_date_4": null,
           "start_date": "2015-02-13T11:16:18",
           "users_set":
           [
           ],
           "time_overdue":
           {
               "time_period_value": 9.10344827586207,
               "time_period_uot": "MONTHS"
           },
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "log_information":
           {
               "updated_date": "2015-02-13T11:48:04",
               "created_by_unit":
               {
                   "community_name": null,
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-02-13T11:16:18",
               "updated_by_unit":
               {
                   "community_name": null,
                   "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": "Interest",
               "id": "B738753EE56D01FC6CD964D14FBBCC7A",
               "description": null,
               "alternative_code": "I"
           },
           "importance": "IMPORTANCE1",
           "life_cycle_state": "IN_PROGRESS",
           "type":
           {
               "name": "Software Purchase",
               "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
               "description": null,
               "alternative_code": "SP"
           },
           "description": null,
           "contact_email": "test@crm.com",
           "category":
           {
               "name": "Software Purchase",
               "id": "C60F332D0B4CB8DD22A0159413951434",
               "description": null,
               "code": null
           }
       }
}
  • No labels