xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse 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
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/Opportunity — entity reference
REFERENCE · Last reviewed

Opportunity — entity reference

A qualified deal or customer service request, positioned between Lead and the transactional documents (Status: Prospecting, Qualification, Needs Analysis, Proposal/Quote, Negotiation, Closed Won, Closed Lost). Items/services under negotiation are child OpportunityLine rows. Server actions generate downstream documents and stamp one-way flags: PerformGenerateQuote copies the lines into a new Quote (isQuoteGenerated), PerformGenerateOrder creates a sales Order (orderId + isSaleOrderGenerated; order lines are copied by the order pipeline from the opportunity), PerformGenerateServiceOrder creates a ServiceOrder. Created from a Lead (leadId) or a Case (caseId) by their convert actions. Also carries service-intake fields for automotive/field-service flows (serviceAdvisorId, pick-up/drop-off addresses, usageReading) and document-level tax/total rollups.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → Account
AccountNameAccount NameText
AdjustedAdvanceAmountAdjusted Advance AmountCurrency
AdvanceAmountAdvance AmountCurrency
AmountAmountCalculated (calculated)
AppointmentDateAppointment DateDateAndTime
AppointmentTimeSlotIdAppointment Time SlotLookup → BranchTimeSlot
AssetIdAssetLookup → Asset
AssetServiceContractIdAsset Service ContractLookup → AssetServiceContract
BillingAddressBilling AddressText
BillingAddressIdBilling AddressLookup → ContactAddress
BillingCityBilling CityPickListValues: Mumbai, Pune, Chandigarh.
BillingCityPlaceIdBilling City PlaceLookup → PlaceValues: Pune, Mumbai, Chandigarh.
BillingContactAddressIdBilling AddressLookup → ContactAddress
BillingCountryBilling CountryPickListValues: India.
BillingPostalCodeBilling Postal CodeText
BillingRegionBilling RegionText
BillingStateBilling StatePickListValues: Haryana, Maharashtra, New Delhi, Punjab.
BillingStreetBilling StreetText
BranchIdBranchLookup → Branch
CancellationReasonCancellation ReasonPickList
CaseIdCaseLookup → Case
ContactIdContactLookup → Contact
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
CustomerVoiceCustomer VoiceText
DealerOnboardingIdDealer OnboardingLookup → DealerOnboarding
DiscountDiscountNumber
DiscountGroupIdDiscount GroupLookup → DiscountGroup
DocumentDateDocument DateDate
DropOffAddressIdDrop Off AddressLookup → ContactAddress
ExternalIdExternalText
FailureDateFailure DateDate
IdIdGuidYes
IsAppointmentGeneratedIs Appointment GeneratedBoolean
IsCancelledCancelledBooleanYes
IsConfirmedConfirmedBooleanYes
IsDropOffRequiredDrop Off RequiredBooleanYes
IsFieldServiceField ServiceBooleanYes
IsKPICalculatedKPI CalculatedBooleanYes
IsLinePopulatedLine PopulatedBooleanYes
IsPickUpRequiredPick Up RequiredBooleanYes
IsQuoteGeneratedQuote GeneratedBooleanYesOne-way flag stamped by the PerformGenerateQuote action after it copies the opportunity lines into a new Quote; the action refuses to run again once set.
IsRepairOrderGeneratedRepair Order GeneratedBooleanYes
IsSaleOrderGeneratedSale Order GeneratedBooleanYesStamped by PerformGenerateOrder together with OrderId when the sales Order is created from this opportunity; generation is skipped when OrderId is already set.
ItemServiceContractIdService ContractLookup → ItemServiceContract
JobTypeJob TypePickList
LeadIdLeadLookup → LeadThe originating Lead when this opportunity was produced by a lead-conversion action; the lead's own OpportunityId points back at this record.
LinesSubtotalTotal Line AmountCalculated (calculated)
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextYes
OpenAmountOpen AmountCalculated (calculated)
OpportunityTimeSlotBookingIdOpportunity Time Slot BookingLookup → BranchTimeSlotBooking
OrderIdOrderLookup → Order
OwnerIdOwnerLookup → UserAccountYes
PackageServiceIdPackage ServiceLookup → Item
PartnerAccountIdPartner AccountLookup → Account
PerformCancelPerform CancelBooleanYes
PerformConfirmPerform ConfirmBooleanYes
PerformGenerateQuotePerform Generate QuoteBoolean
PerformGenerateRepairOrderPerform Generate Repair OrderBooleanYes
PerformGenerateSaleOrderPerform Generate Sale OrderBooleanYes
PerformKPICalculationPerform KPI CalculationBooleanYes
PerformPopulateLinesPerform Populate LinesBooleanYes
PickUpAddressIdPick Up AddressLookup → ContactAddress
PickUpAssignedToIdExecutiveLookup → Resource
PopulateAssetMaintenancePopulate Asset MaintenanceBoolean
PriceAsOnDatePrice As On DateDate
PriceListIdPrice ListLookup → PriceList
QuoteForServiceContractIdQuote For Service ContractLookup → Quote
RecordTypeIdRecord TypeGuid, hidden
RemarksRemarksText
RepairOrderIdRepair OrderLookup
RoundOffRound OffCurrency
SaleOrderIdOrderLookup → Order
ServiceAddressService AddressText
ServiceAdvisorIdExecutiveLookup → Resource
ServiceCampaignBatchInstanceIdService Campaign Batch InstanceText
ServiceCampaignIdService CampaignLookup → ServiceCampaign
ServiceCampaignMemberIdService Campaign MemberLookup → ServiceCampaignMember
ServiceContractItemIdService Contract ItemLookup → Item
ServiceOrderIdService OrderLookup → ServiceOrder
ServiceTypeService TypePickListValues: Paid Repairs.
ServiceVanIdService VanLookup
ShippingAddressShipping AddressText
ShippingAddressIdShipping AddressLookup → ContactAddress
ShippingCityShipping CityPickListValues: Pune, Mumbai, Chandigarh.
ShippingCityPlaceIdShipping CityLookup → PlaceValues: Pune, Mumbai, Chandigarh.
ShippingContactAddressIdShipping AddressLookup → ContactAddress
ShippingCountryShipping CountryPickListValues: India.
ShippingPostalCodeShipping Postal CodeText
ShippingRegionShipping RegionText
ShippingStateShipping StatePickListValues: Haryana, Maharashtra, Punjab, New Delhi, Delhi.
ShippingStreetShipping StreetText
StatusStatusPickListSales-stage picklist: Prospecting, Qualification, Needs Analysis, Proposal/Quote, Negotiation, Closed Won, Closed Lost. Values: Prospecting, Appointment/Quote, Closed Won.
Tax1Tax1Currency
Tax1NameTaxName1Text
Tax1RateTaxRate1Currency
Tax1TypeTaxType1Text
TaxGroupIdTax GroupLookup → TaxGroup
TaxIdTaxLookup → Tax
TaxSupplyTypeTax Supply TypePickListValues: Within State.
TCSEligibleAmountTCS Eligible AmountCurrency
TotalAmountTotal AmountCalculated (calculated)
TotalDiscountAmountTotal Discount AmountCalculated (calculated)
TotalLineBaseAmountTotal Line Base AmountCalculated (calculated)
TotalLineGrossAmountTotal Line Gross AmountCalculated (calculated)
TotalLineTaxAmountTotal Line Tax AmountCalculated (calculated)
TotalQuantityTotal QuantityCalculated (calculated)
TotalTaxAmountTotal Tax AmountCalculated (calculated)
TotalTaxPostingAmountTotal Tax Posting AmountCalculated (calculated)
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
UsageReadingUsage ReadingDecimal
UsageReadingHoursUsage Reading HoursDecimal

Actions

ActionLabelTypeWhat it does
ApplyPackageConfigurationApply Package ConfigurationServerAction (ApplyPackageConfiguration)Writes a package line's component selection: requires LineId and a components array of {ItemComponentId, Quantity, IsSelected}; the service applies the selection to the package's component lines under that opportunity line.
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeletedocDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
DeleteListDeleteDeleteDelete
EditEditEditEdit
EditEntityEditEditEdit
EditInLineEditEditInlineEdit
EditRowEditEditInlineEdit
GetConfigurableItemsGet Configurable ItemsServerAction (GetConfigurableItems)Read-only package-configurator query: returns the opportunity's lines that are configurable packages (ItemComponentService.GetConfigurableItemsForOpportunityAsync). No state change.
GetPackageConfigurationGet Package ConfigurationServerAction (GetPackageConfiguration)Read-only: returns the component configuration of one package line - requires a LineId argument; component pricing is resolved for the opportunity's partner account. No state change.
NewNewNewNew
PerformGenerateOrderOrderServerAction (PerformGenerateOrder)Creates a sales Order from the opportunity (skipped when OrderId is already set) and stamps OrderId + IsSaleOrderGenerated. Order lines are not copied here - the order pipeline creates them from the opportunity's lines via the new order's OpportunityId during the order save.
PerformGenerateQuoteQuoteServerAction (PerformGenerateQuote)Creates a Quote from the opportunity: copies account/partner/branch/asset/service fields onto a new Quote (Quote.OpportunityId links back) and copies every OpportunityLine into a QuoteLine. Sets IsQuoteGenerated and refuses to run when it is already true.
PerformGenerateServiceOrderService OrderServerAction (PerformGenerateServiceOrder)Creates a ServiceOrder from the opportunity (ServiceOrderService.CreateServiceOrderFromOpportunity), carrying the service-intake fields; the repair-order flow's generated flag is tracked on the opportunity (IsRepairOrderGenerated).
ProductConfiguratorProduct ConfiguratorServerAction (ProductConfigurator)ProductConfigurator
ProductDemoBook AppointmentServerAction (ProductDemo)ProductDemo

Validations

ValidationApplies toError messageNotes
Usage Reading blankErrorUsage Reading Cannot be blankUsage Reading Cannot be blank
Usage Reading Validation RuleUsageReading, ErrorUsage Reading Cannot be NegativeUsage Reading Cannot be Negative

Lookup filters

FilterLookup fieldNotes
ASC for Asset filterAssetId (inactive)
Asset Service Contract FilterAssetServiceContractIdAsset
Branch for PABranchIdBranch
Branch For Partner AccountBranchId
Customer Account FilterAccountId
Customer Account FilterAccountIdSales Opp
Executive FilterServiceAdvisorId
PA FilterPartnerAccountIdPA
Partner Account FilterPartnerAccountId