Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
goalStringThe goal of the retrieved lead
stageStringThe stage of the retrieved lead
probability_to_winNumberThe probability to win the retrieved lead which can vary from 0 to 100
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

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:

PRIORITY1, PRIORITY2, PRIORITY3, CUSTOM1, CUSTOM2, CUSTOM3

goal_amountNumberThe amount that is predicted to be gained when winning the retrieved lead
lead_revenueNumberThe retrieved lead revenue
competitors The competitors that can reach the same retrieved lead for the same product/goal
lost_reasonStringThe reason that the retrieved lead was lost, if the retrieved lead status is lost
source_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
start_dateDateThe date that the lead is created
expected_completion_dateDateThe date that the lead is expected to be completed
actual_completed_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

leadslead_source_informationLead Source Information ObjectThe Source information related with the specified lead and lead source type

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified lead

contact_information Contact Information objectThe contact information related with the specified lead 
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
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 objectThe group that is owning the lead
privacy_levelPrivacy level objectThe privacy level of the lead

log_information

Log Information Object

The log information related with the retrieved lead

activities_setSet of Activities ObjectsA list of activities which are planned for the retrieved lead
services_setSet of Services Objects

A list of services for which the lead was raised for

physical_goods_setSet of Physical Goods Objects

A list of the physical goods for which the retrieved lead was raised for, which can be traceable or not traceable

...