xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
Auto DMSConsumer Goods DMSSales Force Automation (SFA) FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Lead — entity reference
REFERENCE · Last reviewed

Lead — entity reference

A lead is an enquiry that has not been qualified yet: who the person or business is, how to reach them, where the enquiry came from and what they want. It has three record types (Sales, Service, Partner) and appears in the CRM, Service and Partner Onboarding apps. Leads are created by hand, by campaign runs (members, contract schedules, maintenance schedules) or from a support case, and are numbered from document numbering (shipped series L). Status starts as New; shipped business rules set Contacted when a call or email activity is logged and Converted when the lead is saved with an opportunity, and Converted and Lost are final. On every save the postal code can route the lead to a branch and partner account, and a matching account fills the customer details. A sales or service lead converts through a dialog that creates or links an account, contact and opportunity; a partner lead converts in one step. A lead converts once, raises at most one service order, and can release any number of sales orders. Step-by-step procedures are on the Leads page of the CRM documentation.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountThe existing customer account. Limited to active customer accounts. Choosing one fills the blank names, phone, email, city, state, postal code and contact from the account. Conversion uses it or replaces it with the account created or picked in the convert dialog.
AccountNameAccount NameCalculated (calculated)Calculated: the Business Name, or else the first and last name. A new account created by conversion is named from it.
AssetIdAssetLookup → AssetThe customer's asset the lead concerns. Required on the service form and limited to the account's assets. When no account is chosen, the asset's owner becomes the lead's account. Copied to the opportunity and service order.
AssetMaintenanceIdAsset MaintenanceLookup → AssetMaintenance
BranchIdBranchLookup → BranchThe branch handling the lead. Required when the partner account has branches and limited to them. Set from the branch postal code mapping when the postal code matches.
CaseIdCaseLookup → CaseThe support case the lead was created from by the case's Lead action.
CityCityPickListThe enquirer's city. Overwritten from the postal code list when the postal code matches. Copied to a new account's billing and shipping address on conversion. Values: Mumbai, Pune, Kolkata, Delhi.
ContactIdContactLookup → ContactThe person at the account. Limited to the account's contacts; filled with the account's most recently created contact when empty. Conversion sets it to the contact it creates or links.
ContactNameContact NameTextRetired. The contact's name comes from the lead's First Name and Last Name on conversion.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DateTimeOpenedDate Time OpenedDateAndTime
DocumentDateDocument DateDateThe lead's business date. Defaults to today on the first save.
DocumentSeriesFieldDocument Series FieldCalculated (calculated)series
EmailEmailTextThe enquirer's email address. Must contain @. Becomes the contact's email on conversion and the email on a partner opportunity.
EventTaskCountEvent Task CountBooleanRetired. Activity roll-ups on the lead now set only Is Emailed Or Call; this count is no longer maintained.
FirstNameFirst NameTextThe enquirer's given name. Filled from the selected account or, when empty, from the selected contact. At least one of First Name, Last Name or Business Name is required unless an account or contact is selected. Becomes the contact's first name on conversion.
IdIdGuidYes
InterestedItemIdInterested ItemLookup → ItemThe product or service the enquirer wants. Conversion and the Order and Service Order actions add one line for it, quantity 1.
IsEmailedOrCalledIs Emailed Or CallBooleanSet automatically when a Call or Email activity exists for the lead, and recalculated when activities change. The shipped Contacted status rule reads it.
ItemMaintenanceScheduleIdItem Maintenance ScheduleLookup → ItemMaintenanceScheduleThe maintenance schedule that raised the lead, set by a campaign's Maintenance Schedule action.
ItemServiceContractIdItem Service ContractLookup → ItemServiceContractThe service contract behind the lead, set by a campaign's Contract Schedule action. Copied to the opportunity and service order.
LastNameLast NameTextThe enquirer's family name. Filled from the selected account or, when empty, from the selected contact. Becomes the contact's last name on conversion.
LeadDueDateLead Due DateDateThe date the underlying contract or maintenance work falls due. Set on leads raised by a campaign's Contract Schedule and Maintenance Schedule actions.
LeadRatingLead RatingPickListHow promising the lead is: Hot, Warm or Cold. Descriptive only; it does not affect conversion, assignment or scoring. Values: Hot, Warm, Cold.
LeadSourceLead SourcePickListWhere the lead came from. Required on the create forms. Shipped values: Dealer, Campaign, Visit based, Web, Phone, Email, AMC, Scheduled Maintenance, Employee Referal, Social Media. Values: Dealer, Campaign, Visit based, Web, AMC, Scheduled Maintenance, Employee Referal, Social Media.
LeadTypeLead TypePickListRetired. Campaign runs record their origin in Lead Source and in the campaign, contract and maintenance schedule links instead. Values: Recall, Maintenance Schedule, Manual, Contract Schedule.
LostReasonLost ReasonPickListWhy the lead was lost, asked by the Lead Lost action: Customer Unresponsive, Timeline Constraints, Service Unavailability, Requirement Withdrawn, Budget Constraint, Competitor Selection, Duplicate, Service Not Aligned with Requirements. Mark Lost leaves it empty; merging sets Duplicate on the merged-away lead. Values: Others.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextYesThe lead's document number, generated on the first save from the Lead Name Setting. The shipped format is L, the day, month and year, and a six-digit counter, joined by hyphens.
OpportunityIdOpportunityLookup → OpportunityThe opportunity created or linked by conversion. Once set, the lead cannot be converted again.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountYour selling company handling the lead. Required on every save and must be an active partner account. Set from the branch postal code mapping when the postal code matches. Copied to the opportunity, order and service order.
PhoneNumberPhone NumberTextThe enquirer's number. When the lead has no account, a phone number matching an existing account's phone links the lead to that account and fills its blank details. Must be a 10-digit Indian mobile number starting 6 to 9 when the country code is +91 or blank. Becomes the contact's mobile number on conversion.
PostalCodePostal CodeTextThe enquirer's postal code. On every save it is matched to the postal code list, replaced with its standard spelling, and fills City, State and Country; if a branch postal code covers it, Branch and Partner Account are set from the mapping (the oldest mapping wins). An assignment rule covering Partner Account or Branch switches this routing off. A lead with a postal code does not need a partner account and branch for conversion and release.
PotentialRevenuePotential RevenueCurrencyAn estimate of what the lead is worth, for reporting. Not copied to records created from the lead.
RecordTypeIdRecord TypeGuid, hidden
RemarksRemarksTextFree-text notes, ideally the customer's own words. Also filled by the Lead Lost dialog. Becomes the customer's voice on a service order raised from the lead.
ReminderOffsetNumberReminder Offset NumberNumberWhich of the campaign's three reminder offsets (1, 2 or 3) raised the lead. Set by schedule-driven campaign runs.
ResourceIdExecutiveLookup → ResourceThe executive handling the lead. Limited to active resources. On a new lead, a matching partner-resource assignment sets it, replacing any value entered, unless an assignment rule decides it. Becomes the executive on a released order and the service advisor on a service order.
CampaignBatchInstanceIdCampaign Batch InstanceText
CampaignIdCampaignLookup → CampaignThe campaign that produced the lead. Limited to active, current campaigns of the lead's partner account or of no partner account. Set by campaign runs.
CampaignMemberIdCampaign MemberLookup → CampaignMemberThe campaign member the lead was raised for, set by a campaign's Leads action.
ServiceContractItemIdServiceContractItemLookup → ItemThe item the service contract was quoted against. Copied to the opportunity and service order with the contract.
SKUIdSKULookup → SKUThe variant of the interested item, limited to that item's SKUs. Copied to the line created on the opportunity, sales order or service order.
StateStatePickListThe enquirer's state. Overwritten from the postal code list when the postal code matches. Copied to a new account's address on conversion. Values: Maharashtra.
StatusStatusPickListThe lead's stage: New, Contacted, Nurturing, Lost or Converted. Defaults to New. Shipped rules set Contacted when a call or email activity is logged and Converted when the lead is saved with an opportunity; once Converted or Lost it can no longer change. Lead Lost and Mark Lost set Lost; Advance Status moves New to Contacted to Nurturing. Values: New, Contacted, Nurturing, Lost, Converted.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
ConvertLeadLeadServerAction (ConvertLead)Full lead conversion in one step: when the lead has no account it creates a new customer Account named from the lead's AccountName plus a Contact for it; when an existing account is linked but has no primary contact it creates that contact; then it always creates an Opportunity carrying the lead's account/partner/branch/asset/contract links and stamps Lead.OpportunityId. Refused when OpportunityId is already set (already converted). Record types are mapped from the lead's record type to the Opportunity equivalent.
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditInLineEditEditEdit
EditInLine2EditEditInlineEdit
EditRowEditEditInlineEdit
LeadLostLead LostServerAction (LeadLost)Lead Lost
NewNewNewNew
NewSalesNewNewNew
PerformLeadToOpportunityPerform Lead To OpportunityServerAction (PerformLeadToOpportunity)Dialog-driven convert: arguments choose per record whether to create or reuse - CreateNewAccount/CreateNewContact/CreateNewOpportunity flags, explicit AccountId/ContactId/OpportunityId picks, AccountFields/ContactFields/OpportunityFields value arrays typed in the dialog, and an optional ConvertedStatus for the lead. ContactFields are applied for both new and existing accounts, and the created/selected account always wins over the lead's old account on the resulting Opportunity. Same preconditions as ConvertLead (no existing OpportunityId; partner/branch resolved).
PerformReleaseOpportunityOpportunityServerAction (PerformReleaseOpportunity)Creates an Opportunity from the lead (OpportunityService.CreateOpportunityFromLead). Preconditions: the lead must not already have an OpportunityId, and PartnerAccountId + BranchId are mandatory unless the lead carries a PostalCode (which auto-resolves them).
PerformReleaseOrderOrderServerAction (PerformReleaseOrder)Creates a sales Order directly from the lead (OrderService.CreateOrderFromLead), skipping the opportunity/quote stages. PartnerAccountId and BranchId are mandatory unless PostalCode is set.
RunMacroRun MacroServerAction (RunMacro)Runs a Macro's steps against this lead through the generic macro engine (IMacroRunner) - the same entity-agnostic RunMacro handler used on cases; no lead-specific behavior.
testLeadConvertOpportunityServerActionconvert Lead

Validations

ValidationApplies toError messageNotes
AccountNamerequiredAccountName, ErrorAccount Name is mandatory.Account Name is mandatory.
Email Validation RuleEmail, ErrorEnter Valid Email.Enter Valid Email.
Mobile Validation RulePhoneNumber, ErrorEnter Valid No.Enter Valid No.

Lookup filters

FilterLookup fieldNotes
Branch For Partner AccountBranchIdBranch For Partner Account - Service
Branch For Partner AccountBranchId
Customer Account FilterAccountId
Customer Account FilterAccountIdCustomer Account
Executive FilterResourceIdExecutive Filter
Executive FilterResourceId
Partner Account FilterPartnerAccountIdPartnerAccountFilter
Partner Account Filter ServicePartnerAccountIdPartner Account