Table of Contents

Crm.Presales.Leads Entity

Namespace: Crm.Presales

Leads are potential customers for your products. Because leads are usually processed in a hurry or imported from external lists, personal and company information is saved in a less structured way. With the advancement of the qualification process (including deduplication), the information is structured in the usual Person and Company entities. When successfully processed, leads can be converted to Opportunities. Entity: Crm_Leads (Introduced in version 21.1.3.78)

Default Visualization

Default Display Text Format:
{PersonFirstName} {PersonLastName}
Default Search Members:
CompanyName
Name Data Member:
CompanyName
Category: Documents
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Attributes

Name Type Description
CompanyName string (64) nullable The name of the company, which the person works for (in relation to the current lead). Filter(eq;like)
CreationTimestampUtc datetime System assigned date and time (in UTC), when the lead was initially created. Required Filter(ge;le) ReadOnly
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
MQLTimestampUtc datetime nullable System assigned date and time (in UTC), when the lead was first promoted to Marketing Qualified Lead (MQL). Filter(ge;le) ReadOnly
ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
PersonEmail string (64) nullable The email address of the sales lead person. Filter(eq;like)
PersonFirstName string (64) nullable The first name of the person, representing the sales lead. Filter(eq;like)
PersonLastName string (64) nullable The last name of the person, representing the sales lead. Filter(eq;like)
PersonMobilePhone string (32) nullable The mobile phone of the sales lead person. Filter(like)
PersonSalutation string (16) nullable Salutation for the sales lead person. Filter(eq;like)
PersonWebProfile string (64) nullable Web address (including protocol like https) of the personal profile in a social or professional network. The address itself, as it is full valid Internet address, contains also the network name. Filter(like)
PersonWorkPhone string (32) nullable The work phone of the sales lead person. Filter(like)
RoleInCompany string (32) nullable The role of the person in the company. Filter(eq;like)
SQLTimestampUtc datetime nullable System assigned date and time (in UTC), when the lead was first promoted to Sales Qualified Lead. Filter(ge;le) ReadOnly
SystemStage SystemStage The system stage of the lead - New, Qualifying, Marketing Qualified Lead, Sales Qualified Lead, Closed. (NEW, QUA, MQL, SQL, CLO). Required Default("NEW") Filter(multi eq) ReadOnly

References

Name Type Description
AssignedToSalesPerson SalesPersons (nullable) Sales rep to whom this lead is assigned for further processing. null - not yet assigned. Filter(multi eq)
Campaign Campaigns The marketing campaign under which the lead was generated. Required Filter(multi eq)
ConvertedToDeal Deals (nullable) Filled when the lead is converted to opportunity (deal). Filter(multi eq)
EnterpriseCompany EnterpriseCompanies The enterprise company to which this lead belongs. Required Filter(multi eq) Introduced in version 22.1.5.23
EnterpriseCompanyLocation CompanyLocations (nullable) The enterprise company location to which this lead belongs. Filter(multi eq) Introduced in version 22.1.6.41
IdentifiedCompany Companies (nullable) Filled when the company is identified within our database. Filter(multi eq)
IdentifiedPerson Persons (nullable) Filled when the person is identified and recorded in our master records. Filter(multi eq)
LeadUserStage LeadUserStages (nullable) The user-defined sub-stage of the lead. This also defines the step in the sales sequence and the next appropriate activity to engage the lead. null when the user stage is undefined (the pure System Stage defines the stage). Filter(multi eq) ReadOnly
MarketingCompanySize CompanySizeClasses (nullable) The size class of the company. Filter(multi eq)
MarketingIndustry Industries (nullable) The industry (for marketing purposes) of the lead. Filter(multi eq)
MarketingSolution MarketingSolutions (nullable) The marketing solution, in which the lead is interested or which generated the lead. Filter(multi eq)
OwnerUser Users The user, responsible for this record. Required Filter(multi eq)
SalesArea Areas (nullable) The sales area, where the lead is located, when it is identified. This should also indicate the Time Zone. Filter(multi eq)

Attribute Details

CompanyName

The name of the company, which the person works for (in relation to the current lead). Filter(eq;like)

Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

CreationTimestampUtc

System assigned date and time (in UTC), when the lead was initially created. Required Filter(ge;le) ReadOnly

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
IIF( ( obj.MQLTimestampUtc == null), Convert( DateTime.UtcNow, Nullable1), obj.MQLTimestampUtc)`

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

MQLTimestampUtc

System assigned date and time (in UTC), when the lead was first promoted to Marketing Qualified Lead (MQL). Filter(ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

PersonEmail

The email address of the sales lead person. Filter(eq;like)

Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

PersonFirstName

The first name of the person, representing the sales lead. Filter(eq;like)

Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

PersonLastName

The last name of the person, representing the sales lead. Filter(eq;like)

Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

PersonMobilePhone

The mobile phone of the sales lead person. Filter(like)

Type: string (32) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 32
Show in UI: ShownByDefault

PersonSalutation

Salutation for the sales lead person. Filter(eq;like)

Type: string (16) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

PersonWebProfile

Web address (including protocol like https) of the personal profile in a social or professional network. The address itself, as it is full valid Internet address, contains also the network name. Filter(like)

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

PersonWorkPhone

The work phone of the sales lead person. Filter(like)

Type: string (32) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 32
Show in UI: ShownByDefault

RoleInCompany

The role of the person in the company. Filter(eq;like)

Type: string (32) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 32
Show in UI: ShownByDefault

SQLTimestampUtc

System assigned date and time (in UTC), when the lead was first promoted to Sales Qualified Lead. Filter(ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

SystemStage

The system stage of the lead - New, Qualifying, Marketing Qualified Lead, Sales Qualified Lead, Closed. (NEW, QUA, MQL, SQL, CLO). Required Default("NEW") Filter(multi eq) ReadOnly

Type: SystemStage
Category: System
Allowed values for the SystemStage(Crm.Presales.Leads.md#systemstage) data attribute
Allowed Values (Crm.Presales.LeadsRepository.SystemStage Enum Members)

Value Description
New New value. Stored as 'NEW'.
Database Value: 'NEW'
Model Value: 0
Domain API Value: 'New'
Qualifying Qualifying value. Stored as 'QUA'.
Database Value: 'QUA'
Model Value: 1
Domain API Value: 'Qualifying'
MarketingQualifiedLead MarketingQualifiedLead value. Stored as 'MQL'.
Database Value: 'MQL'
Model Value: 2
Domain API Value: 'MarketingQualifiedLead'
SalesQualifiedLead SalesQualifiedLead value. Stored as 'SQL'.
Database Value: 'SQL'
Model Value: 3
Domain API Value: 'SalesQualifiedLead'
Closed Closed value. Stored as 'CLO'.
Database Value: 'CLO'
Model Value: 4
Domain API Value: 'Closed'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: New
Show in UI: ShownByDefault

Reference Details

AssignedToSalesPerson

Sales rep to whom this lead is assigned for further processing. null - not yet assigned. Filter(multi eq)

Type: SalesPersons (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Campaign

The marketing campaign under which the lead was generated. Required Filter(multi eq)

Type: Campaigns
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ConvertedToDeal

Filled when the lead is converted to opportunity (deal). Filter(multi eq)

Type: Deals (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

EnterpriseCompany

The enterprise company to which this lead belongs. Required Filter(multi eq) Introduced in version 22.1.5.23

Type: EnterpriseCompanies
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

EnterpriseCompanyLocation

The enterprise company location to which this lead belongs. Filter(multi eq) Introduced in version 22.1.6.41

Type: CompanyLocations (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

IdentifiedCompany

Filled when the company is identified within our database. Filter(multi eq)

Type: Companies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

IdentifiedPerson

Filled when the person is identified and recorded in our master records. Filter(multi eq)

Type: Persons (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

LeadUserStage

The user-defined sub-stage of the lead. This also defines the step in the sales sequence and the next appropriate activity to engage the lead. null when the user stage is undefined (the pure System Stage defines the stage). Filter(multi eq) ReadOnly

Type: LeadUserStages (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

MarketingCompanySize

The size class of the company. Filter(multi eq)

Type: CompanySizeClasses (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

MarketingIndustry

The industry (for marketing purposes) of the lead. Filter(multi eq)

Type: Industries (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

MarketingSolution

The marketing solution, in which the lead is interested or which generated the lead. Filter(multi eq)

Type: MarketingSolutions (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

OwnerUser

The user, responsible for this record. Required Filter(multi eq)

Type: Users
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

SalesArea

The sales area, where the lead is located, when it is identified. This should also indicate the Time Zone. Filter(multi eq)

Type: Areas (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

  • customPropertyCode
    The code of the custom property
    Type: string

  • search
    The search text - searches by value or description. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • exactMatch
    If true the search text should be equal to the property value
    Type: boolean
    Optional: True
    Default Value: False

  • orderByDescription
    If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
    Type: boolean
    Optional: True
    Default Value: False

  • top
    The top clause - default is 10
    Type: int32
    Optional: True
    Default Value: 10

  • skip
    The skip clause - default is 0
    Type: int32
    Optional: True
    Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

Front-End Business Rules

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Crm_Presales_Leads?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Presales_Leads?$top=10

Suggest improvement to this page