CR
CRLead
Represents a marketing lead or a sales lead.
View API Entity: Lead
/entity/Default/25.200.001/Lead| Field Name | Type | Display Name | Foreign Key | |
|---|---|---|---|---|
AnniversaryObsolete | datetime | Wedding Date | - | |
Description:The wedding date of the contact. | ||||
AssignDate | datetime | Assignment Date | - | |
Description:The date and time when OwnerID or WorkgroupID were last changed. | ||||
Attention | nvarchar(255) | Attention | - | |
Description:The name of the document recipient (a person or team) used in the documents. Not used in primary graph, only in documents, for instance, CROpportunity, SO.SOOrder, and so on. | ||||
AttributesNonexistent in DB | string | - | ||
Description:The attributes available for the current contact. The field is preserved for internal use. | ||||
BAccountID API | int | Business Account | BAccount | |
Description:The identifier of the related business account. Corresponds to the value of the BAccount.BAccountID field. | ||||
CampaignID API | nvarchar(15) | Source Campaign | CRCampaign | |
Description:The identifier of the campaign that resulted in creation of the contact. Corresponds to the CRCampaign.campaignID field. The property is used by the LeadMaint graph and displayed on the Leads (CR301000) form. | ||||
CanBeMadePrimaryNonexistent in DB | bool? | Can be made Primary | - | |
Description:No description available | ||||
ClassID API | nvarchar(10) | Class ID | CRLeadClass | |
Description:The identifier of the class. Corresponds to the value of the CRContactClass.ClassID field. | ||||
ConsentAgreement | bit | Consented to the Processing of Personal Data | - | |
Description:No description available | ||||
ConsentDate | datetime | Date of Consent | - | |
Description:No description available | ||||
ConsentExpirationDate | datetime | Consent Expires | - | |
Description:No description available | ||||
ContactID API | int | Lead ID | - | |
Description:The identifier of the contact. This field is the key field. This field is an identity auto-increment database field that in normal conditions cannot be duplicated in different tenants. This value is present in the URI of the open document: "ScreenId=CR302000&ContactID=100044". | ||||
ContactPriorityNonexistent in DB | int? | Type | - | |
Description:The numeric representation of ContactType used to sort a grid containing contacts of different types. The value is used in the following graphs: OUSearchMaint, CampaignMaint, CRMarketingListMaint. The possible values match ContactType values as follows: - ContactTypesAttribute.BAccountProperty: ContactTypesAttribute.bAccountPriority - ContactTypesAttribute.SalesPerson: ContactTypesAttribute.salesPersonPriority - ContactTypesAttribute.Employee: ContactTypesAttribute.employeePriority - ContactTypesAttribute.Person: ContactTypesAttribute.personPriority - ContactTypesAttribute.Lead: ContactTypesAttribute.leadPriority | ||||
ContactType | char(2) | Type | - | |
Description:The type of the lead. The field can have one of the values listed in the ContactTypesAttribute class. The default value is ContactTypesAttribute.Lead. This field must be specified at the initialization stage and not be changed afterwards. | ||||
ConvertedBy API | uniqueidentifier | Converted By | Users | |
Description:No description available | ||||
CreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
CreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
CreatedDateTime | datetime | Created On | - | |
Description:No description available | ||||
DateOfBirth | datetime | Date Of Birth | - | |
Description:The date of birth. | ||||
DefAddressID | int | Address | Address | |
Description:The identifier of the CR.Address object linked with the current document. The field can be empty for the contacts of the following types: ContactTypesAttribute.BAccountProperty and ContactTypesAttribute.Employee. Corresponds to the value of the Address.AddressID field. | ||||
DefaultTeamsClient | char(1) | Teams Client | - | |
Description:No description available | ||||
DeletedDatabaseRecord | bit | - | ||
Description:No description available | ||||
Description API | nvarchar(255) | Description | - | |
Description:An alphanumeric string of up to 255 characters that describes the lead. This field is used to add any additional information about the lead. | ||||
DisplayName API | nvarchar | Contact | Contact | |
Description:The display name of the contact. Its value is made up of the LastName, FirstName, MidName, and Title values. The format depends on the PreferencesGeneral.PersonNameFormat site setting. This field is changed when the fields it depends on are changed. | ||||
bool? | Duplicate Found | - | ||
Description:Specifies whether DuplicateStatus is equal to DuplicateStatusAttribute.PossibleDuplicated when the FeaturesSet.ContactDuplicate feature is enabled. | ||||
DuplicateStatus API | char(2) | Duplicate | - | |
Description:The duplicate status of the contact. The field indicates whether the contact was validated by the duplicate validation (see FeaturesSet.ContactDuplicate). The field can have one of the values listed in the DuplicateStatusAttribute class. The default value is DuplicateStatusAttribute.NotValidated. | ||||
EMail API | nvarchar | - | ||
Description:The email address of the contact. The field should be a valid email address, or a list of email addresses separated by semicolons. The email addresses will be validated with the EmailParser.ParseAddresses(string) method. | ||||
ExtRefNbr | nvarchar(40) | Ext. Ref. Nbr. | - | |
Description:The external reference number of the contact. It can be an additional number of the contact used in external integration. | ||||
Fax API | nvarchar(50) | Fax | - | |
Description:The fax number. The type of the number can be set by the FaxType field. The value should match the phone validation pattern specified for the current company. See Company.PhoneMask for details. | ||||
FaxType API | nvarchar(3) | Fax Type | - | |
Description:The phone type for the Fax field. The field can have one of the values listed in the PhoneTypesAttribute class. | ||||
FirstName API | nvarchar(50) | First Name | - | |
Description:The first name of the person. | ||||
FullName API | nvarchar(255) | Account Name | - | |
Description:The name of the company the contact works for. Either this field or the Contact.LastName field must be specified to create the lead. | ||||
Gender | char(1) | Gender | - | |
Description:The gender of the contact. The field can have one of the values listed in the GendersAttribute class, and a default value can be set depending on the value of Title. | ||||
GrammValidationDateTime | datetime | - | ||
Description:The date and time of the last gramm validation. The field is preserved for internal use. | ||||
HasRigthsNonexistent in DB | bool? | - | ||
Description:No description available | ||||
Img | nvarchar | Image | - | |
Description:The image attached to the contact. The value can be fetched from the exchange server during contacts synchronization (see FeaturesSet.ExchangeIntegration). | ||||
IsActive API | bit | Active | - | |
Description:Specifies whether the current contact is active and can be specified in documents. Only active contacts can be specified in such documents as CROpportunity, CRCase, CRQuote, PM.PMQuote. The duplicate validation feature FeaturesSet.ContactDuplicate works only with active contacts. | ||||
IsAddedAsExtNonexistent in DB | bool? | - | ||
Description:No description available | ||||
IsAddressSameAsMainNonexistent in DBObsolete | bool? | Same as in Account | - | |
Description:No description available | ||||
IsConvertableObsolete | bit | Can Be Converted | - | |
Description:No description available | ||||
IsMeaningfullNonexistent in DB | bool? | - | ||
Description:No description available | ||||
IsNotEmployeeNonexistent in DB | bool? | Is Not Employee | - | |
Description:Specifies whether the current contact's type is not the employee type. The value is true when the value of ContactType is not equal to ContactTypesAttribute.Employee. | ||||
IsPrimaryNonexistent in DB | bool? | Primary | - | |
Description:Specifies (if set to true) that the contact, which the current ContactAccount represents, is primary for the business account, which the current ContactAccount also represents. It is used only by the BusinessAccountMaint graph. | ||||
IsRelatedToProjectContactNonexistent in DB | bool? | Is Related To Project Contact | - | |
Description:No description available | ||||
LanguageID API | nvarchar(10) | Language/Locale | Locale | |
Description:The language in which the contact prefers to communicate. By default, the system fills in the box with the locale specified for the contact's country. This field is displayed on the form only if there are multiple active locales configured on the System Locales (SM200550) form (corresponds to the LocaleMaintenance graph). | ||||
LastModifiedByID | uniqueidentifier | Last Modified By | Users | |
Description:No description available | ||||
LastModifiedByScreenID | char(8) | - | ||
Description:No description available | ||||
LastModifiedDateTime API | datetime | Last Modified On | - | |
Description:No description available | ||||
LastName API | nvarchar(100) | Last Name | - | |
Description:The last name of the person. | ||||
LeadContactID | int | - | ||
Description:No description available | ||||
LeadCreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
LeadCreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
LeadCreatedDateTime | datetime | - | ||
Description:No description available | ||||
LeadLastModifiedByID | uniqueidentifier | Last Modified By | Users | |
Description:No description available | ||||
LeadLastModifiedByScreenID | char(8) | - | ||
Description:No description available | ||||
LeadLastModifiedDateTime | datetime | - | ||
Description:No description available | ||||
LeadNoteID | uniqueidentifier | - | ||
Description:No description available | ||||
MaritalStatus | char(1) | Marital Status | - | |
Description:The marital status of the contact. The field can have one of the values listed in the MaritalStatusesAttribute class. | ||||
MemberNameNonexistent in DB | string | Member Name | - | |
Description:Similar to DisplayName, but unlike DisplayName, it is a calculated field. It is equal to DisplayName if the latter is not null, and to FullName otherwise. | ||||
Method API | char(1) | Contact Method | - | |
Description:The person's preferred method of contact. The field can have one of the values listed in the CRContactMethodsAttribute class. | ||||
MidName | nvarchar(50) | Middle Name | - | |
Description:The middle name of the person. | ||||
NoCall API | bit | Do Not Call | - | |
Description:Specifies (if set to true) that the contact should not be called. The system does not rely on this field, but the value can be used by an external system or as an indicator. | ||||
NoEMail API | bit | Do Not Email | - | |
Description:Specifies (if set to true) that the email of the contact will not be involved in the mass email process. This contact will not receive any notification emails. Contacts with this field set to true will not receive mass emails sent by the CRMassMailMaint graph (the Mass Emails (CR308000) form). | ||||
NoFax API | bit | Do Not Fax | - | |
Description:Specifies (if set to true) that no fax should be sent to the contact. The system does not rely on this field, but the value can be used by an external system or as an indicator. | ||||
NoMail API | bit | Do Not Mail | - | |
Description:Specifies (if set to true) that no mail should be sent to the contact. The system does not rely on this field, but the value can be used by an external system or as an indicator. | ||||
NoMarketing API | bit | No Marketing | - | |
Description:Specifies (if set to true) that the email of the contact will not be involved in the mass email process. Contacts with this field set to true will not receive mass emails sent by the CRMassMailMaint graph (the Mass Emails (CR308000) form). | ||||
NoMassMail API | bit | No Mass Mail | - | |
Description:Specifies (if set to true) that the email of the contact will not be involved in the mass email process. Contacts with this field set to true will not receive mass emails sent by the CRMassMailMaint graph (the Mass Emails (CR308000) form). | ||||
NoteID API | uniqueidentifier | - | ||
Description:No description available | ||||
OverrideAddressNonexistent in DB | bool? | Override Address | - | |
Description:Specifies whether the address information of this contact differs from the address information of the business account associated with this contact. IF it is so, the address information is synchronized with the associated business account. The behavior is controlled by the ContactMaint.ContactBAccountSharedAddressOverrideGraphExt graph extension. | ||||
OverrideRefContact | bit | Override | - | |
Description:Specifies whether the contact and address information of this lead differs from the contact and address information of the business account associated with this lead. The behavior is controlled by the LeadMaint.LeadBAccountSharedAddressOverrideGraphExt graph extension. | ||||
OverrideSalesTerritory | bit | Override Territory | - | |
Description:The flag identified that the salesTerritoryID is filled automatically based on Address.state and Address.countryID or can be assigned manually. | ||||
OwnerID API | int | Owner | Contact | |
Description:No description available | ||||
ParentBAccountID API | int | Business Account | BAccount | |
Description:The identifier of the account that is considered as parent for the current account (BAccountID). Corresponds to the value of the BAccount.BAccountID field. There is no business logic in the application for this field. | ||||
PersonalEMail | nvarchar | Email (Personal) | - | |
Description:No description available | ||||
Phone1 API | nvarchar(50) | Phone 1 | - | |
Description:The phone number. The type of the number can be set by the Phone1Type field. The value should match the phone validation pattern specified for the current company. See Company.PhoneMask for details. | ||||
Phone1Type API | nvarchar(3) | Phone 1 Type | - | |
Description:The phone type for the Phone1 field. The field can have one of the values listed in the PhoneTypesAttribute class. | ||||
Phone2 API | nvarchar(50) | Phone 2 | - | |
Description:The second phone number. The type of the number can be set by the Phone2Type field. The value should match the phone validation pattern specified for the current company. See Company.PhoneMask for details. | ||||
Phone2Type API | nvarchar(3) | Phone 2 Type | - | |
Description:The phone type for the Phone2 field. The field can have one of the values listed in the PhoneTypesAttribute class. | ||||
Phone3 API | nvarchar(50) | Phone 3 | - | |
Description:The third phone number. The type of the number can be set by the Phone3Type field. The value should match the phone validation pattern specified for the current company. See Company.PhoneMask for details. | ||||
Phone3Type API | nvarchar(3) | Phone 3 Type | - | |
Description:The phone type for the Phone3 field. The field can have one of the values listed in the PhoneTypesAttribute class. | ||||
PreferredName | nvarchar | Preferred Name | - | |
Description:No description available | ||||
PreviousEmailNonexistent in DB | string | Previous Email | - | |
Description:No description available | ||||
PseudonymizationStatus | int | Pseudonymized | - | |
Description:No description available | ||||
QualificationDate API | datetime | Qualification Date | - | |
Description:The date when the lead was converted to the opportunity. The value is filled by the LeadMaint.CreateOpportunityAllFromLeadGraphExt graph extension. | ||||
RefContactID API | int | Contact | Contact | |
Description:The identifier of the contact that is associated with this lead. Corresponds to the value of the Contact.ContactID field. | ||||
Resolution API | char(2) | Reason | - | |
Description:The reason why the Status field of this lead has been changed. The field values are controlled by the workflow engine, and the field is not used by the application logic directly. | ||||
RevisionID | int | - | ||
Description:The identifier of the revision of the contact. It is increased at each update of the contact. This field is used to check whether the original contact was changed. Tables in PX.Objects that rely on this field: APContact, AR.ARContact, CRContact, PM.PMContact, PO.POContact, SO.SOContact, | ||||
RolesCSVNonexistent in DB | string? | User Roles | - | |
Description:User Roles | ||||
SalesTerritoryID | nvarchar(15) | Sales Territory | SalesTerritory | |
Description:The reference to SalesTerritory.salesTerritoryID. If overrideSalesTerritory is false then it's filled automatically based on Address.state and Address.countryID otherwise it's assigned by user. | ||||
Salutation API | nvarchar(255) | Job Title | - | |
Description:The job title of the person. | ||||
SearchSuggestionNonexistent in DBObsolete | string | Search Suggestion | - | |
Description:No description available | ||||
SelectedNonexistent in DB | bool? | Selected | - | |
Description:No description available | ||||
Source API | char(1) | Source | - | |
Description:The source of the lead. The field can have one of the values listed in the CRMSourcesAttribute class. The value of the field is automatically changed when the ClassID property is changed. | ||||
Spouse | nvarchar(255) | Spouse/Partner Name | - | |
Description:The name of the spouse or partner of the contact. | ||||
Status API | char(1) | Status | - | |
Description:The status of the lead. The field values are controlled by the workflow engine. The possible default values of the field are listed in the LeadWorkflow.States class. | ||||
Synchronize | bit | Synchronize with Exchange | - | |
Description:Specifies whether the contact should be included in exchange synchronization. The value is used in the exchange integration (see FeaturesSet.ExchangeIntegration). The default value is true. | ||||
TeamsID | nvarchar(255) | Override Teams ID | - | |
Description:No description available | ||||
Title API | nvarchar(50) | Title | - | |
Description:The title of the person. The predefined values are listed in the TitlesAttribute class, but this field can have any value. | ||||
TriggerEmailChangeNonexistent in DB | string | Trigger Email Change | - | |
Description:No description available | ||||
UserID | uniqueidentifier | Users | ||
Description:The identifier of the user associated with the contact. Corresponds to the Users.PKID field. | ||||
WebSite API | nvarchar | Web | - | |
Description:The URL of the contact website. The field should contain a valid URL. | ||||
WorkgroupID API | int | Workgroup | EPCompanyTree | |
Description:No description available | ||||
tstamp | timestamp | - | ||
Description:No description available | ||||