SalesLeads
The sales lead resource is used to view, create, or modify a lead. A lead is a transaction record created when a party has expressed an interest in a product or service. It represents a selling opportunity.
Columns
| Name | Type | ReadOnly | References | Description |
| LeadId [KEY] | Long | False |
Partner Type. Indicates the type of partner stamped on the lead. | |
| AILeadScore | Double | True |
AILeadScore | |
| AcceptedDate | Date | True |
The date on which lead was accepted by a resource assigned to it. | |
| AcceptedDateTime | Datetime | True |
Date and time when the sales lead is accepted by a resource assigned to it. | |
| AccountPartyNumber | String | False |
AccountPartyNumber | |
| AddrElementAttribute1 | String | False |
Additional address element to support flexible address format. | |
| AddrElementAttribute2 | String | False |
Additional address element to support flexible address format. | |
| AddrElementAttribute3 | String | False |
Additional address element to support flexible address format. | |
| AddrElementAttribute4 | String | False |
Additional address element to support flexible address format. | |
| AddrElementAttribute5 | String | False |
Additional address element to support flexible address format. | |
| AddressLinesPhonetic | String | False |
Phonetic or Kana representation of the Kanji address lines (used in Japan). | |
| ApprovalDate | Date | False |
The date on which a partner registered lead is approved by internal channel manager. | |
| ApprovalDateTime | Datetime | False |
Date and time when the sales lead is approved. This is only applicable to deal registrations. | |
| AssetId | Long | False |
Unique identifier for the Asset associated with the Sales Lead. | |
| AssetNumber | String | False |
Unique Number for the Asset associated with the Sales Lead. | |
| AssetSerialNumber | String | True |
Serial Number for the Asset associated with the Sales Lead. | |
| AssignmentStatusCode | String | False |
Includes the current assignment related status for the lead, for example whether the lead is assigned or unassigned. | |
| BudgetAmount | Decimal | False |
Budget amount associated with this sales lead. | |
| BudgetCurrencyCode | String | False |
Currency code associated with the Budget Amount associated with this sales lead. | |
| BudgetStatus | String | False |
Budget status associated with the Budget Amount associated with this sales lead. | |
| Building | String | False |
Specific building name or number at a given address. | |
| BusinessUnitId | Long | False |
Business Unit Identifier associated with the business unit of the sales lead creator. | |
| CampaignName | String | True |
Name of the campaign associated with the sales lead. | |
| ChannelType | String | False |
Indicates the channel through which this lead contacted the company. | |
| ClassCode1 | String | False |
The auxilliary dimension for the Account. | |
| ClassCode2 | String | False |
The auxilliary dimension for the Account. | |
| ClassCode3 | String | False |
The auxilliary dimension for the Account. | |
| ClassCode4 | String | False |
The auxilliary dimension for the Account. | |
| ConflictId | Long | False |
ConflictId | |
| ContactDoNotPreference | Bool | False |
ContactDoNotPreference | |
| ContactFormattedAddress | String | True |
ContactFormattedAddress | |
| ContactPartyNumber | String | False |
ContactPartyNumber | |
| ContactTimezoneCd | String | False |
Preferred time zone of the contact pursued on the lead. | |
| ConvertedDateTime | Datetime | False |
Date and time when the sales lead is converted to an opportunity. | |
| CreatedBy | String | True |
Indicates the user who created this record. | |
| CreationDate | Datetime | True |
Indicates the date and time when this record is created. | |
| CurrencyCode | String | False |
Currency code for the lead. | |
| CustPartyType | String | False |
CustPartyType | |
| CustomerId | Long | False |
Customer Id. It is a reference to the customer record in the TCA schema. | |
| CustomerNeed | String | False |
Indicates what need the lead product serves for the lead customer. | |
| CustomerPartyName | String | False |
Name of the customer. | |
| DealAmount | Decimal | False |
The total amount attributed to a lead. | |
| DecisionMakerIdentifiedFlag | Bool | False |
Indicates if the decision maker at customer site has been identified. | |
| DeleteFlag | Bool | True |
This flag controls if the user has access to delete the record | |
| Description | String | False |
Description associated with this sales lead. | |
| Distance | Double | True |
Distance from the input location. | |
| EligibleForConversionFlag | Bool | False |
EligibleForConversionFlag | |
| EnableCreateAccount | String | False |
EnableCreateAccount | |
| EnableCreateContact | String | False |
EnableCreateContact | |
| EstimatedCloseDate | Date | False |
Estimated close date for a deal once registered | |
| ExpirationDate | Date | False |
Expiration date associated with this sales lead. | |
| FloorNumber | String | False |
Specific floor number at a given address or in a particular building when building number is provided. | |
| FollowupTimestamp | Date | False |
Indicates when the sales lead needs to be followed up. | |
| FormattedPhoneNumber1 | String | True |
FormattedPhoneNumber1 | |
| IBAssetId | Long | False |
Unique identifier for the IB Asset associated with the Sales Lead. | |
| IBAssetNumber | String | True |
Unique number for the IB Asset associated with the Sales Lead. | |
| IBAssetSerialNumber | String | True |
Unique serial number for the IB Asset associated with the Sales Lead. | |
| InventoryItemDescription | String | False |
The description of the product added to a lead. | |
| JobTitle | String | False |
Job title of the primary contact on the sales lead. | |
| LastAssignmentDate | Datetime | False |
The date on which the lead was last reassigned. | |
| LastUpdateDate | Datetime | True |
Who column: indicates the date and time of the last update of the row. | |
| LastUpdateLogin | String | True |
Who column: indicates the login of the user who last updated the row. | |
| LastUpdatedBy | String | True |
Who column: indicates the user who last updated the row. | |
| Latitude | Double | False |
Latitude information for the location. | |
| LeadAcceptedFlag | Bool | False |
Indicates if the lead has been accepted. | |
| LeadAging | Double | True |
The number of days elapsed since the lead was created. | |
| LeadCreatedBy | String | False |
Functional WHO: Indicates the user who created this record. | |
| LeadCreationDate | Datetime | False |
Functional WHO: Indicates the date and time when this record is created. | |
| LeadLastUpdateDate | Datetime | False |
Functional WHO: Indicates the date and time of the last update of the row. | |
| LeadLastUpdatedBy | String | False |
Functional WHO: Indicates the user who last updated the row. | |
| LeadNumber | String | False |
User friendly unique identifier for a lead. | |
| LeadOrigin | String | False |
Origin of the Lead | |
| Longitude | Double | False |
Longitude information for the location. | |
| Name | String | False |
Lead Name used for identifying the lead. | |
| OpportunityName | String | False |
OpportunityName | |
| OpportunityOwnerNumber | String | False |
OpportunityOwnerNumber | |
| OrganizationSize | String | False |
Organization Size | |
| OrganizationType | String | False |
Organization Type | |
| OwnerId | Long | False |
Party identifier associated with the owner of this sales lead. | |
| OwnerPartyName | String | False |
Name associated with the owner of this sales lead. | |
| OwnerPartyNumber | String | False |
OwnerPartyNumber | |
| PartnerCompanyNumber | String | False |
PartnerCompanyNumber | |
| PartnerId | Long | False |
Unique identifier for the primary partner associated with the lead. | |
| PartnerPartyName | String | False |
Name associated with the primary partner of this sales lead. This is a deal specific attribute. | |
| PartnerProgramId | Long | False |
A reference to the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute. | |
| PartnerProgramNumber | String | False |
PartnerProgramNumber | |
| PartnerType | String | False |
Indicates the type of the primary partner associated with this sales lead. This is a deal specific attribute. | |
| PostalPlus4Code | String | False |
Four digit extension to the United States Postal ZIP code. | |
| PrimaryCampaignId | Long | False |
PrimaryCampaignId | |
| PrimaryCampaignName | String | False |
PrimaryCampaignName | |
| PrimaryCampaignNumber | String | False |
PrimaryCampaignNumber | |
| PrimaryCompetitorName | String | False |
PrimaryCompetitorName | |
| PrimaryCompetitorPartyId | Long | False |
PrimaryCompetitorPartyId | |
| PrimaryCompetitorPartyNumber | String | False |
PrimaryCompetitorPartyNumber | |
| PrimaryContactAddress1 | String | False |
The first line of address associated with the primary contact of the lead. | |
| PrimaryContactAddress2 | String | False |
The second line of address associated with the primary contact of the lead. | |
| PrimaryContactAddress3 | String | False |
The third line of address associated with the primary contact of the lead. | |
| PrimaryContactAddress4 | String | False |
The fourth line of address associated with the primary contact of the lead. | |
| PrimaryContactCity | String | False |
The city where the primary contact of the lead is located. | |
| PrimaryContactCountry | String | False |
The country where the primary contact of the lead is located. | |
| PrimaryContactCountryName | String | True |
Full name associated with primary contact country code | |
| PrimaryContactCounty | String | False |
The county where the primary contact of the lead is located. | |
| PrimaryContactEmailAddress | String | False |
Email address for the primary sales lead contact on the lead | |
| PrimaryContactEmailPreference | String | False |
PrimaryContactEmailPreference | |
| PrimaryContactEmailVerificationDate | Datetime | False |
PrimaryContactEmailVerificationDate | |
| PrimaryContactEmailVerificationStatus | String | False |
PrimaryContactEmailVerificationStatus | |
| PrimaryContactId | Long | False |
Identifer of the sales lead contact marked as a primary lead contact. | |
| PrimaryContactMailPreference | String | False |
PrimaryContactMailPreference | |
| PrimaryContactPartyName | String | False |
Name associated with the primary lead contact. | |
| PrimaryContactPersonFirstName | String | False |
First name of the primary contact for a lead. | |
| PrimaryContactPersonLastName | String | False |
Last name of the primary contact for a lead. | |
| PrimaryContactPersonMiddleName | String | False |
Middle name of the primary contact for a lead. | |
| PrimaryContactPhonePreference | String | False |
PrimaryContactPhonePreference | |
| PrimaryContactPostalCode | String | False |
The zip code where the primary contact of the lead is located. | |
| PrimaryContactProvince | String | False |
The province where the primary contact of the lead is located. | |
| PrimaryContactRelationshipId | Long | False |
Unique identifier of the relationship primary contact has with its parent organization. | |
| PrimaryContactState | String | False |
The state where the primary contact of the lead is located. | |
| PrimaryInventoryItemId | Long | False |
Unique identifier of the primary product associated with a lead. | |
| PrimaryInventoryItemNumber | String | False |
PrimaryInventoryItemNumber | |
| PrimaryInventoryOrgId | Long | False |
Unique identifier of the organization to which the primary product associated with a lead belongs. | |
| PrimaryPhoneAreaCode | String | False |
Primary phone area code for the sales lead contact. | |
| PrimaryPhoneCountryCode | String | False |
Primary phone country code for the sales lead contact. | |
| PrimaryPhoneNumber | String | False |
Primary phone number for the sales lead contact. | |
| PrimaryPhoneVerificationDate | Datetime | False |
PrimaryPhoneVerificationDate | |
| PrimaryPhoneVerificationStatus | String | False |
PrimaryPhoneVerificationStatus | |
| PrimaryProductGroupId | Long | False |
Unique identifier of the primary product group associated with a lead. | |
| PrimaryProductGroupReferenceNumber | String | False |
PrimaryProductGroupReferenceNumber | |
| ProductGroupDescription | String | True |
Description of the product or product group associated with a lead. | |
| ProductGroupName | String | False |
Name of the product group associated with a lead. | |
| ProductType | String | False |
ProductType | |
| ProgramName | String | False |
Name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute. | |
| Project | String | False |
customer project identified for this sales lead. | |
| QualificationScore | Int | True |
Qualification score for a lead. | |
| QualifiedDate | Date | False |
Indicates the date when this sales lead was qualified. | |
| QualifiedDateTime | Datetime | False |
Date and time when the sales lead is qualified. | |
| Rank | String | False |
Rank associated with this sales lead. | |
| RawPrimaryPhoneNumber | String | False |
RawPrimaryPhoneNumber | |
| ReassignComment | String | False |
Comment provided by a user while requesting the lead reassignment. | |
| ReassignReasonCode | String | False |
Pre-defined code used to indicate the reason for lead reassignment. | |
| RecordSet | String | True |
RecordSet | |
| RegistrationNumber | String | False |
Registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute. | |
| RegistrationStatus | String | False |
Approval Status of the sales lead. This is a deal specific attribute. | |
| RegistrationType | String | False |
Indicates the registration type of the sales lead. This is a deal specific attribute. | |
| RejectByUserId | Long | False |
Identifier of the sales representative who rejected this sales lead. | |
| RejectComment | String | False |
Comments provided by the sales representative who rejected this sales lead. | |
| RejectReasonCode | String | False |
Pre-defined code used to indicate the reason for rejecting a lead. | |
| RejectedDateTime | Datetime | False |
Date and time when the sales lead is rejected. | |
| RetireComment | String | False |
Comments recorded when the sales lead is moved to a retired status. | |
| RetireReasonCode | String | False |
Pre-defined code used to indicate the reason for retiring a lead. | |
| RetiredDateTime | Datetime | False |
Date and time when the sales lead is moved to a retired status. | |
| SalesChannel | String | False |
Indicates the sales channel responsible for following up on this sales lead. | |
| SalesTargetLeadEloquaSyncDate | Datetime | False |
SalesTargetLeadEloquaSyncDate | |
| SalesTargetLeadOptOutComment | String | False |
SalesTargetLeadOptOutComment | |
| SalesTargetLeadOptOutDate | Datetime | False |
SalesTargetLeadOptOutDate | |
| SalesTargetLeadOptOutReasonCode | String | False |
SalesTargetLeadOptOutReasonCode | |
| SalesTargetLeadStage | String | False |
SalesTargetLeadStage | |
| SalesTargetLeadValidationDueDate | Datetime | False |
SalesTargetLeadValidationDueDate | |
| Score | Int | False |
The score associated with this sales lead. This score is computed based on the scoring rules. | |
| SourceCode | String | False |
Marketing source code associated with this sales lead. | |
| StatusCode | String | False |
Pre-defined code used to indicate the status of a lead. | |
| Timeframe | String | False |
Timeframe associated with this sales lead. | |
| ToReassignFlag | Bool | False |
Identifies leads that are marked for reassignment. | |
| UpdateFlag | Bool | True |
This flag controls if the user has access to update the record | |
| WorkPhoneAreaCode | String | False |
Work phone area code for the sales lead contact. | |
| WorkPhoneCountryCode | String | False |
Work phone country code for the sales lead contact. | |
| WorkPhoneNumber | String | False |
Work phone number for the sales lead contact. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Finder | String |
Input specifying the Finder type. |
| ContactId | String |
The unique identifier of the Contact. |
| SysEffectiveDate | String |
SysEffectiveDate. |
| ResourcePartyIdRest | String |
The unique identifier of the Resource. |
| RestCreationDateLower | String |
Finds the leads that are created before the date specified. |
| RestCreationDateUpper | String |
Finds the leads with the specified creation date. |
| RestRecordSet | String |
Finds the leads with the specified record set value. |
| RestStatusCode | String |
Finds the leads with the specified status code. |