Opportunity Line — entity reference

One item or service on an opportunity: what is offered, how much, at what price, discount and tax, and how much of that quantity has already gone onto sales orders and service orders. Lines are added from the opportunity's Lines tab (Quick Add), or created automatically from a converted lead's interested item, a campaign run, open campaign maintenance on the asset, the opportunity's service contract, accepted service recommendations and package components. On a new line the item must be active with a valid SKU where needed; the line is priced from the sale price list unless a price was typed, given a tax group, discounts and taxes, and numbered OPL-DDMMYYYY-nnnnnn. The item cannot change once the line is saved, and Quantity must be more than zero. Order and Service Order on the opportunity copy each line's Pending Quantity; Quote copies every line in full and does not count as a release. Description is not copied onto quotes or orders. A line can be deleted even after it has been released.

Fields

Field	Label	Type	Required	What it does
`AlternateItemId`	Alternate Item	Lookup → ItemAlternate		The alternate item that replaced the requested item on this line. Original Item keeps the item first requested.
`Amount`	Amount	Calculated (calculated)		Line value after discount and before tax: Base Amount less Net Discount and less the line's share of discounted-item lines. With Apply Post Tax Discount it is the base, and the discount comes off Gross Amount instead. On a Discounted Item line it is 0, or the negated value when the item's Discount Tax Treatment is After Tax. Calculated.
`ApplyPostTaxDiscount`	Apply Post Tax Discount	Boolean	Yes	When ticked, discount percentages are worked out on base plus tax and taken off after tax, so tax is charged on the full base. Default off. Not on the shipped forms.
`AssetMaintenanceId`	Asset Maintenance	Lookup → AssetMaintenance		The open campaign maintenance item on the asset that this line was created from. Such lines are not added to the same opportunity twice.
`AssetServiceContractId`	Asset Service Contract	Lookup → AssetServiceContract		The service contract on the customer's asset that covers this line.
`AssetServiceContractLineId`	Asset Service Contract Line	Lookup → AssetServiceContractLine		The entitlement line of the asset's service contract that this line counts against. Set on lines created from the opportunity's service contract.
`BaseAmount`	BaseAmount	Calculated (calculated)		Quantity times the unit price, using the override Unit Price when it is above zero and the list Unit Price otherwise. Value before any discount. Calculated; not on the shipped forms.
`ContractDiscountAmount`	Contract Discount Amount	Currency		A fixed contract discount on the line. When above zero it is used instead of the contract discount percentage. Copied onto quotes and orders.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DiscountAmount`	Discount Amount	Currency		A fixed discount on the line. When above zero it wins over the discount percentage, which is cleared on save. Copied onto quotes and orders.
`DiscountAmount2`	Cash Discount Amount	Currency		Cash Discount Amount: a second fixed discount. When above zero the matching percentage is cleared on save. Not on the shipped forms.
`DiscountGroupRuleId`	Discount Group Rule	Lookup → DiscountGroupRule		The discount-group rule that gave the line its discount, set when the line is created.
`DurationInHours`	Duration In Hours	Decimal		Estimated labour time for the line. Default 0. Becomes the standard hours on a service order line; it does not affect the price.
`ExternalId`	External	Text		Identifier of the line in an external system, for lines created by integration.
`GrossAmount`	Gross Amount	Calculated (calculated)		Amount plus Tax Amount; with Apply Post Tax Discount the net discount is taken off after tax. Calculated; not on the shipped forms.
`Id`	Id	Guid	Yes
`IsCancelled`	Cancelled	Boolean	Yes	Not recorded on opportunity lines.
`IsConfirmed`	Confirmed	Boolean	Yes	Not recorded on opportunity lines.
`IsPackageComponent`	Package Component	Boolean	Yes	Not recorded on opportunity lines. A component line is one whose Package Opportunity Line is set.
`IsPackageService`	Package Service	Boolean	Yes	Not recorded on opportunity lines. A package line is one that other lines point to through Package Opportunity Line.
`IsPriceBundled`	Price Bundled	Boolean	Yes	Marks a package component whose price is included in the package price. Such a line is never repriced. Copied onto quotes and sales orders.
`IsCampaignMandatory`	Campaign Mandatory	Boolean	Yes	Campaign Mandatory: set on lines a campaign makes compulsory. The item, quantity and service contract of such a line cannot change, and the line cannot be deleted.
`ItemAliasId`	Item Alias	Lookup → ItemAlias		The item alias (for example a customer part number) by which the item was picked.
`ItemComponentId`	Item Component	Lookup → ItemComponent		The component definition of the package item that this line was created from. Copied onto quotes and sales orders.
`ItemId`	Item	Lookup → Item	Yes	The product or service offered. Must be active. It cannot be changed after the line is saved: delete the line and add a new one instead.
`ItemLotTypeId`	Item Lot Type	Lookup → ItemLotType		The lot or batch category for the item. The picker offers only the line item's lot types. Copied onto quotes and sales orders.
`ItemName`	Item Name	Text		Not recorded on opportunity lines; the item's name is read from the item.
`ItemServiceContract2`	Service Contract Split 2	Lookup → ItemServiceContract		Service Contract Split 2: a second service contract sharing the cost of the line.
`ItemServiceContractId`	Service Contract	Lookup → ItemServiceContract		The service contract covering the line. It must be active on the opportunity's asset, cover the item, have quantity left and not be a used single-use contract. It decides Posting Type.
`ItemServiceContractId3`	Service Contract Split 3	Lookup → ItemServiceContract		Service Contract Split 3: a third service contract sharing the cost of the line.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text	Yes	The line number, assigned on save from the Opportunity Line Name Setting: series OPL, the date as DDMMYYYY and a six-digit counter.
`NetDiscount`	Net Discount	Calculated (calculated)		Total discount on the line: the regular, cash and contract discounts, each as a fixed amount when one is above zero or else as a percentage. Zero on a Discounted Item line. Calculated.
`OpportunityDiscount`	Opportunity Discount	Calculated		The opportunity header's Discount percentage. It is copied onto the line's discount when the line is added; later header changes do not change the discount on saved lines.
`OpportunityId`	Opportunity	Lookup → Opportunity		The opportunity the line belongs to. Required, and cannot be changed.
`OriginalItemId`	Original Item	Lookup → Item		The item first requested on this line, kept when an alternate replaced it.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PackageClassification`	Package Classification	PickList		The component's role within its package: Packaged Item or Custom BOM Item. Descriptive only. Values: Packaged Item, Custom BOM Item.
`PackageOpportunityLineId`	Package Opportunity Line	Lookup → OpportunityLine		On a component line, the package line it belongs to. Changing the package line's quantity rescales its components, and deleting the package line deletes them.
`PostingType`	Posting Type	PickList		How the line's cost is to be borne. Set by xMatix from the posting treatment of the line's service contract when it covers the item; otherwise a blank value becomes Generate Invoices. Copied onto quotes and service orders.
`PriceAsOnDate`	Price As On Date	Date		The date the line is priced on. When empty, the opportunity's Price As On Date, then its Document Date, then today, is used. Changing it reprices the line.
`PriceListId`	Price List	Lookup → PriceList		The price list the line's price came from. The line's own list is used first, then the opportunity's, then the default. Changing it reprices the line.
`PriceListRuleId`	Price List Rule	Lookup → PriceListRule		The price-list rule behind the line's price.
`Quantity`	Quantity	Number		How much is offered. Must be more than zero. On a package line, changing it rescales the components. Order and Service Order release Quantity less what has already been released.
`RecordTypeId`	Record Type	Guid, hidden		Sales or Service. Generated lines take the record type whose name matches the opportunity's; it decides which line record page opens.
`SchemeBenefitId`	Scheme Benefit	Lookup → SchemeBenefit		Not recorded on opportunity lines.
`CampaignId`	Campaign	Lookup → Campaign		The campaign that added the line.
`CampaignItemId`	Campaign Item	Lookup → CampaignItem		The campaign item the line was created for.
`ServiceContractItemId`	Service Contract Item	Lookup → Item		The contract product the line relates to, filled for lines created from the asset's service contract.
`ServiceContractWeightage`	Service Contract Weightage	Calculated (calculated)		The share of the line borne by the first service contract when the line is split across contracts. Calculated.
`ServiceRecommendationId`	Service Recommendation	Lookup → ServiceRecommendation		The service recommendation this line was created from when it was accepted. Rejecting the recommendation removes the line.
`ServiceRequestDiscount`	Service Request Discount	Calculated (calculated)		Not recorded on opportunity lines.
`SKUId`	SKU	Lookup → SKU		The item variant. The picker offers only the line item's SKUs. Required when the item needs a SKU.
`Tax1`	Tax1	Currency
`Tax1Name`	TaxName1	Text
`Tax1Rate`	TaxRate1	Currency
`Tax1Type`	TaxType1	Text
`Tax2`	Tax2	Currency
`Tax2Name`	TaxName2	Text
`Tax2Rate`	TaxRate2	Currency
`Tax2Type`	TaxType2	Text
`Tax3`	Tax3	Currency
`Tax3Name`	TaxName3	Text
`Tax3Rate`	TaxRate3	Currency
`Tax3Type`	TaxType3	Text
`Tax4`	Tax4	Currency
`Tax4Name`	TaxName4	Text
`Tax4Rate`	TaxRate4	Currency
`Tax4Type`	TaxType4	Text
`Tax5`	Tax5	Currency
`Tax5Name`	TaxName5	Text
`Tax5Rate`	TaxRate5	Currency
`Tax5Type`	TaxType5	MultiLineText
`Tax6`	Tax6	Currency
`Tax6Name`	TaxName6	Text
`Tax6Rate`	TaxRate6	Currency
`Tax6Type`	TaxType6	Text
`TaxAmount`	Tax Amount	Currency		Tax on the line, worked out from the tax group on the value after discount. Default 0. Recalculated when the tax group, item, SKU, quantity or amount changes.
`TaxGroupId`	Tax Group	Lookup → TaxGroup		The tax group that decides the line's taxes. Picked from the tax rules when the line is created; changing it recalculates the tax.
`UIProps`	UI Props	Text
`UnitPrice`	Unit Price	Number		The list price per unit, filled from the sale price list when the line is created. A price typed on a new line is kept. On the record page this list price is not shown; the Unit Price there is the override.
`UnitPrice2`	Unit Price	Currency		The override unit price, labelled Unit Price on the line's record page. When above zero the line's value is worked out from it instead of the list price. Copied onto sales and service orders.
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteListRow`	Delete	Delete	DeleteListRow
`Edit`	Edit	Edit	Edit
`Edit1`	Edit	Edit	EditHeader
`Edit2`	Edit	EditInline	Edit
`New`	New	NewInline	New Opportunity Line

Validations

Validation	Applies to	Error message	Notes
Quantity Rule Validation	`Quantity`, Error	Quantity should not be less than 0	Quantity should not be less than 0
Unit Price Rule Validation	`UnitPrice`, Error	Unit Price can not be less than 0	Unit Price can not be less than 0

Item — looks up via OriginalItemId
SchemeBenefit — looks up via SchemeBenefitId
Item — looks up via ItemId
Opportunity — looks up via OpportunityId
AssetServiceContractLine — looks up via AssetServiceContractLineId
ItemAlternate — looks up via AlternateItemId
ServiceRecommendation — looks up via ServiceRecommendationId
UserAccount — looks up via ModifiedById
UserAccount — looks up via OwnerId
SKU — looks up via SKUId
DiscountGroupRule — looks up via DiscountGroupRuleId
ItemServiceContract — looks up via ItemServiceContractId
AssetMaintenance — looks up via AssetMaintenanceId
ItemServiceContract — looks up via ItemServiceContractId3
ItemLotType — looks up via ItemLotTypeId
OpportunityLine — looks up via PackageOpportunityLineId
ItemAlias — looks up via ItemAliasId
PriceList — looks up via PriceListId
Item — looks up via ServiceContractItemId
ItemComponent — looks up via ItemComponentId
UserAccount — looks up via CreatedById
PriceListRule — looks up via PriceListRuleId
TaxGroup — looks up via TaxGroupId
CampaignItem — looks up via CampaignItemId
ItemServiceContract — looks up via ItemServiceContract2
Campaign — looks up via CampaignId
AssetServiceContract — looks up via AssetServiceContractId
ServiceOrderLine — referenced by via OpportunityLineId
OrderLine — referenced by via OpportunityLineId
OpportunityLine — referenced by via PackageOpportunityLineId
QuoteLine — referenced by via OpportunityLineId

Opportunity Line — entity reference

Fields

Actions

Validations

Related entities

Related topics