Opportunity — entity reference

An opportunity is a qualified deal being worked: the customer, the items or services under negotiation with their prices, and the record quotes, sales orders and service orders are raised from. It has three record types (Sales, Service, Partner) and appears in the CRM, Service and Partner Onboarding apps. It is created directly, by converting a lead or a case, or by a campaign run, and is numbered from document numbering (shipped series OP). Status starts as Prospecting; shipped business rules move it to Appointment/Quote when a quote, demo or appointment exists and to Closed Won when an order, service order or partner application is linked. Partner Account and Branch are locked after the first save. The Quote action copies every line into a new quote each time it runs; the Order and Service Order actions release each line's pending quantity and can run again until nothing is pending. Step-by-step procedures are on the Opportunities page of the CRM documentation.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup → Account		The customer the deal is with. Only active customer accounts can be picked. When left empty it is filled from the selected asset's owner, from the originating lead, or from the account whose phone matches the opportunity's phone number. Choosing an account fills the names, phone, email, contact and both addresses from it.
`AccountName`	Account Name	Text		The customer's filing name, stored as text. It defaults to the business name, or to first and last name when there is no business name, and is copied to the orders raised from the deal.
`AdjustedAdvanceAmount`	Adjusted Advance Amount	Currency
`AdvanceAmount`	Advance Amount	Currency
`Amount`	Amount	Calculated (calculated)
`AppointmentDate`	Appointment Date	DateAndTime
`AppointmentTimeSlotId`	Appointment Time Slot	Lookup → BranchTimeSlot
`AssetId`	Asset	Lookup → Asset		The customer's asset for a service opportunity, required on the service form and limited to the account's assets. When the account is empty it is filled from the asset's owner, and open campaign items on the asset are added as lines.
`AssetServiceContractId`	Asset Service Contract	Lookup → AssetServiceContract		The asset's service contract; only contracts valid today can be picked.
`BillingAddress`	Billing Address	Text
`BillingAddressId`	Billing Address	Lookup → ContactAddress
`BillingCity`	Billing City	PickList		Values: Mumbai, Pune, Chandigarh.
`BillingCityPlaceId`	Billing City Place	Lookup → Place		Values: Pune, Mumbai, Chandigarh.
`BillingContactAddressId`	Billing Address	Lookup → ContactAddress
`BillingCountry`	Billing Country	PickList		Values: India.
`BillingPostalCode`	Billing Postal Code	Text		Entering a postal code fills the billing city, state, region and country from the postal-code master.
`BillingRegion`	Billing Region	Text
`BillingState`	Billing State	PickList		Values: Haryana, Maharashtra, New Delhi, Punjab.
`BillingStreet`	Billing Street	Text
`BranchId`	Branch	Lookup → Branch		The selling branch. It must belong to the partner account and be active, and it cannot be changed after the opportunity is saved.
`CancellationReason`	Cancellation Reason	PickList
`CaseId`	Case	Lookup → Case		The case the opportunity was converted from.
`ContactId`	Contact	Lookup → Contact		The contact person, limited to the account's contacts. It defaults to the account's most recently created contact or the lead's contact.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`CustomerVoice`	Customer Voice	Text
`DealerOnboardingId`	Dealer Onboarding	Lookup → DealerOnboarding
`Discount`	Discount	Number		A header discount percentage. Changing it on a saved opportunity applies it to every line. Not shown on the shipped layouts.
`DiscountGroupId`	Discount Group	Lookup → DiscountGroup		The discount group for the deal, set automatically on save. Not shown on the shipped layouts.
`DocumentDate`	Document Date	Date		The business date of the deal. Lead conversion and campaign runs set it to the current date. It is used as the price date for lines when no price-as-on date is set.
`DropOffAddressId`	Drop Off Address	Lookup → ContactAddress
`ExternalId`	External	Text
`FailureDate`	Failure Date	Date
`Id`	Id	Guid	Yes
`IsAppointmentGenerated`	Is Appointment Generated	Boolean		Calculated: true once the opportunity has at least one product demo or appointment.
`IsCancelled`	Cancelled	Boolean	Yes
`IsConfirmed`	Confirmed	Boolean	Yes
`IsDropOffRequired`	Drop Off Required	Boolean	Yes
`IsFieldService`	Field Service	Boolean	Yes
`IsKPICalculated`	KPI Calculated	Boolean	Yes	Set once the opportunity has been posted to performance KPIs.
`IsLinePopulated`	Line Populated	Boolean	Yes
`IsPickUpRequired`	Pick Up Required	Boolean	Yes
`IsQuoteGenerated`	Quote Generated	Boolean	Yes	Set when the Quote action raises a quote. It records that a quote exists but does not stop another one being raised.
`IsRepairOrderGenerated`	Repair Order Generated	Boolean	Yes
`IsSaleOrderGenerated`	Sale Order Generated	Boolean	Yes	Stamped by PerformGenerateOrder together with OrderId when the sales Order is created from this opportunity; generation is skipped when OrderId is already set.
`ItemServiceContractId`	Service Contract	Lookup → ItemServiceContract		Labelled Service Contract. Choosing it adds the pending lines of the asset's service contract, and the contract's usage band limits the usage readings.
`JobType`	Job Type	PickList
`LeadId`	Lead	Lookup → Lead		The lead the opportunity was converted from.
`LinesSubtotal`	Total Line Amount	Calculated (calculated)
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text	Yes	The opportunity's document number, generated on save from the Opportunity Name Setting. The shipped format is OP, the day, month and year, and a six-digit counter, joined by hyphens.
`OpenAmount`	Open Amount	Calculated (calculated)		Calculated: equal to Total Amount.
`OpportunityTimeSlotBookingId`	Opportunity Time Slot Booking	Lookup → BranchTimeSlotBooking
`OrderId`	Order	Lookup → Order		The first sales order raised from the opportunity. Further orders can be raised while lines have pending quantity; all of them link back to the opportunity.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PackageServiceId`	Package Service	Lookup → Item
`PartnerAccountId`	Partner Account	Lookup → Account		The selling company that owns the deal. Only active partner accounts can be picked. It is validated together with Branch on create and cannot be changed after the opportunity is saved; it is copied to every quote and order raised from it.
`PerformCancel`	Perform Cancel	Boolean	Yes
`PerformConfirm`	Perform Confirm	Boolean	Yes
`PerformGenerateQuote`	Perform Generate Quote	Boolean
`PerformGenerateRepairOrder`	Perform Generate Repair Order	Boolean	Yes
`PerformGenerateSaleOrder`	Perform Generate Sale Order	Boolean	Yes
`PerformKPICalculation`	Perform KPI Calculation	Boolean	Yes
`PerformPopulateLines`	Perform Populate Lines	Boolean	Yes
`PickUpAddressId`	Pick Up Address	Lookup → ContactAddress
`PickUpAssignedToId`	Executive	Lookup → Resource
`PopulateAssetMaintenance`	Populate Asset Maintenance	Boolean
`PriceAsOnDate`	Price As On Date	Date		The date prices are taken from. Changing it on a saved opportunity reprices every line from the price list. Not shown on the shipped layouts.
`PriceListId`	Price List	Lookup → PriceList		The sale price list for the deal, set automatically on save. Not shown on the shipped layouts.
`QuoteForServiceContractId`	Quote For Service Contract	Lookup → Quote
`RecordTypeId`	Record Type	Guid, hidden
`Remarks`	Remarks	Text
`RepairOrderId`	Repair Order	Lookup
`RoundOff`	Round Off	Currency
`SaleOrderId`	Order	Lookup → Order
`ServiceAddress`	Service Address	Text
`ServiceAdvisorId`	Executive	Lookup → Resource		Labelled Executive: the resource handling the deal. It must be active and authorized for the partner account and branch. It becomes the executive on a generated sales order and the service advisor on a quote or service order.
`CampaignBatchInstanceId`	Campaign Batch Instance	Text
`CampaignId`	Campaign	Lookup → Campaign		The campaign whose run created the opportunity; a campaign run raises one opportunity per campaign member with one line per campaign item.
`CampaignMemberId`	Campaign Member	Lookup → CampaignMember
`ServiceContractItemId`	Service Contract Item	Lookup → Item
`ServiceOrderId`	Service Order	Lookup → ServiceOrder		The first service order raised from the opportunity. Further service orders can be raised while lines have pending quantity.
`ServiceType`	Service Type	PickList		Kind of service requested. Shipped values: Accidental Repairs, PDI, Paid Repairs, Warranty Repair. Values: Paid Repairs.
`ServiceVanId`	Service Van	Lookup
`ShippingAddress`	Shipping Address	Text
`ShippingAddressId`	Shipping Address	Lookup → ContactAddress
`ShippingCity`	Shipping City	PickList		Values: Pune, Mumbai, Chandigarh.
`ShippingCityPlaceId`	Shipping City	Lookup → Place		Values: Pune, Mumbai, Chandigarh.
`ShippingContactAddressId`	Shipping Address	Lookup → ContactAddress
`ShippingCountry`	Shipping Country	PickList		Values: India.
`ShippingPostalCode`	Shipping Postal Code	Text
`ShippingRegion`	Shipping Region	Text
`ShippingState`	Shipping State	PickList		Values: Haryana, Maharashtra, Punjab, New Delhi, Delhi.
`ShippingStreet`	Shipping Street	Text
`Status`	Status	PickList		The deal's stage. Shipped values: Prospecting (the default), Appointment/Quote and Closed Won; a tenant may add more. Shipped business rules set Appointment/Quote when a quote, product demo or appointment exists and Closed Won when a sales order, service order or partner application is linked. A partner application can only be raised at Closed Won. Values: Prospecting, Appointment/Quote, Closed Won.
`Tax1`	Tax1	Currency
`Tax1Name`	TaxName1	Text
`Tax1Rate`	TaxRate1	Currency
`Tax1Type`	TaxType1	Text
`TaxGroupId`	Tax Group	Lookup → TaxGroup
`TaxId`	Tax	Lookup → Tax
`TaxSupplyType`	Tax Supply Type	PickList		Worked out on every save from the customer's address and the branch. Values: Within State.
`TCSEligibleAmount`	TCS Eligible Amount	Currency
`TotalAmount`	Total Amount	Calculated (calculated)		Calculated: total line amount plus total tax.
`TotalDiscountAmount`	Total Discount Amount	Calculated (calculated)
`TotalLineBaseAmount`	Total Line Base Amount	Calculated (calculated)		Calculated: quantity times unit price over the lines, before discounts, excluding discounted-item lines.
`TotalLineGrossAmount`	Total Line Gross Amount	Calculated (calculated)
`TotalLineTaxAmount`	Total Line Tax Amount	Calculated (calculated)
`TotalQuantity`	Total Quantity	Calculated (calculated)
`TotalTaxAmount`	Total Tax Amount	Calculated (calculated)
`TotalTaxPostingAmount`	Total Tax Posting Amount	Calculated (calculated)
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes
`UsageReading`	Usage Reading	Decimal		The asset's reading at intake. It cannot be lower than the asset's last recorded reading and must sit within the usage band of the service contract on the opportunity.
`UsageReadingHours`	Usage Reading Hours	Decimal		The asset's hours reading at intake, with the same checks as Usage Reading.

Actions

Action	Label	Type	What it does
`ApplyPackageConfiguration`	Apply Package Configuration	ServerAction (`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.
`BulkDelete`	Delete	Delete	Delete
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`Deletedoc`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete
`DeleteList`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit
`EditEntity`	Edit	Edit	Edit
`EditInLine`	Edit	EditInline	Edit
`EditRow`	Edit	EditInline	Edit
`GetConfigurableItems`	Get Configurable Items	ServerAction (`GetConfigurableItems`)	Read-only package-configurator query: returns the opportunity's lines that are configurable packages (ItemComponentService.GetConfigurableItemsForOpportunityAsync). No state change.
`GetPackageConfiguration`	Get Package Configuration	ServerAction (`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.
`New`	New	New	New
`PerformGenerateOrder`	Order	ServerAction (`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.
`PerformGenerateQuote`	Quote	ServerAction (`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.
`PerformGenerateServiceOrder`	Service Order	ServerAction (`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).
`ProductConfigurator`	Product Configurator	ServerAction (`ProductConfigurator`)	ProductConfigurator
`ProductDemo`	Book Appointment	ServerAction (`ProductDemo`)	ProductDemo

Validations

Validation	Applies to	Error message	Notes
Usage Reading blank	Error	Usage Reading Cannot be blank	Usage Reading Cannot be blank
Usage Reading Validation Rule	`UsageReading`, Error	Usage Reading Cannot be Negative	Usage Reading Cannot be Negative

Lookup filters

Filter	Lookup field	Notes
ASC for Asset filter	`AssetId` (inactive)
Asset Service Contract Filter	`AssetServiceContractId`	Asset
Branch for PA	`BranchId`	Branch
Branch For Partner Account	`BranchId`
Customer Account Filter	`AccountId`
Customer Account Filter	`AccountId`	Sales Opp
Executive Filter	`ServiceAdvisorId`
PA Filter	`PartnerAccountId`	PA
Partner Account Filter	`PartnerAccountId`

ContactAddress — looks up via ShippingAddressId
Resource — looks up via ServiceAdvisorId
ContactAddress — looks up via BillingContactAddressId
UserAccount — looks up via CreatedById
BranchTimeSlotBooking — looks up via OpportunityTimeSlotBookingId
DealerOnboarding — looks up via DealerOnboardingId
Contact — looks up via ContactId
AssetServiceContract — looks up via AssetServiceContractId
Campaign — looks up via CampaignId
Order — looks up via OrderId
BranchTimeSlot — looks up via AppointmentTimeSlotId
ContactAddress — looks up via BillingAddressId
Tax — looks up via TaxId
ContactAddress — looks up via PickUpAddressId
UserAccount — looks up via OwnerId
Place — looks up via BillingCityPlaceId
Lead — looks up via LeadId
TaxGroup — looks up via TaxGroupId
ServiceOrder — looks up via ServiceOrderId
Item — looks up via ServiceContractItemId
ContactAddress — looks up via DropOffAddressId
ItemServiceContract — looks up via ItemServiceContractId
Asset — looks up via AssetId
DiscountGroup — looks up via DiscountGroupId
Branch — looks up via BranchId
Account — looks up via PartnerAccountId
Case — looks up via CaseId
Item — looks up via PackageServiceId
Resource — looks up via PickUpAssignedToId
Order — looks up via SaleOrderId
ContactAddress — looks up via ShippingContactAddressId
Account — looks up via AccountId
CampaignMember — looks up via CampaignMemberId
UserAccount — looks up via ModifiedById
Place — looks up via ShippingCityPlaceId
PriceList — looks up via PriceListId
DealerOnboarding — referenced by via DealerOnboardingId
OpportunityLine — referenced by via OpportunityId
SchemeLedger — referenced by via OpportunityId
CheckInInspection — referenced by via OpportunityId
Quote — referenced by via OpportunityId
Lead — referenced by via OpportunityId
ServiceOrder — referenced by via OpportunityId
ProductDemo — referenced by via OpportunityId
Order — referenced by via OpportunityId

Opportunity — entity reference

Fields

Actions

Validations

Lookup filters

Related entities

Related topics