Order Line — entity reference

One item or one charge on a sales order: what is sold, how much, at what price, discount and tax, and how far that quantity has got through fulfilment, allocation, picking, delivery and invoicing. Lines are added from the order's Lines tab (Quick Add, Product Catalogue, Barcode Scanner or Import), copied from a quote or an opportunity, or created from another organization's purchase order. On creation xMatix checks the order's partner account and branch, swaps a superseded item for its successor, defaults invoice group and subscription details from the item, prices the line from the price list unless a price was typed, resolves the tax group and taxes, applies the discount group, copies the header discount, explodes package components, finds the stock record and evaluates automatic schemes. Each stage keeps a counter maintained from the documents raised against the line, and every pending quantity is the line quantity less that counter and the cancelled quantity. Saving a line does not reserve stock; the shipped soft-commit ledger rule is switched off. Lines have no list of their own in any app.

Fields

Field	Label	Type	Required	What it does
`AllocatedInvoicedQuantity`	Allocated Invoiced Quantity	Number		The part of Invoice Quantity invoiced from allocated stock, that is, from invoice lines raised against an allocation line.
`Amount`	Amount	Calculated (calculated)		Calculated: Base Amount less the scheme discount, the net discount and the line's share of any discount lines on the order. With Apply Post Tax Discount ticked, Amount is the base and the discounts come off Gross Amount instead.
`ApplyPostTaxDiscount`	Apply Post Tax Discount	Boolean		When ticked, discounts are worked out on the base plus tax and come off after tax, instead of before.
`BaseAmount`	Base Amount	Calculated (calculated)		Calculated: (Quantity minus Cancelled Quantity) times the unit price, using Unit Price 2 when it is above zero. Cancelling part of a line therefore lowers its value.
`BenefitIndex`	Benefit Index	Number		Positional selector for the applied benefit when a scheme line offers several; it is passed to ApplyScheme as benefitIndex and cleared again by ResetScheme.
`BillingFrequency`	Billing Frequency	Text		Subscription billing frequency. Defaulted from the item when the line leaves it blank.
`BillingType`	Billing Type	PickList		Subscription billing in Advance or Arrears. Defaulted from the item when the line leaves it blank. Values: Advance, Arrears.
`BranchId`	Branch	Text		Not maintained on order lines; the branch is the order's Branch.
`CancelledQuantity`	Cancelled Quantity	Number		Quantity that will not be supplied. Cancel Order adds each line's quantity not yet released to fulfilment. It can also be edited on the line's record page, but cannot exceed Quantity. It comes off every pending quantity and off Base Amount.
`ChargeType`	Charge Type	PickList		Subscription charge type: One Time, Recurring or Usage. Defaulted from the item when the line leaves it blank. Values: One Time, Recurring, Usage.
`ContractDiscount`	Contract Discount	Percent		Contract discount percentage written from the matching discount-group rule for the line's item, SKU or item group.
`ContractDiscountAmount`	Contract Discount Amount	Currency		Contract discount as a value, from a fixed-amount discount-group rule or copied from a quote or opportunity line. When above zero it is used instead of the Contract Discount percentage.
`ConversionRatio`	Conversion Ratio	Number		Conversion factor of the first unit, copied from the item's unit definition.
`ConversionRatio1`	Conversion Ratio 1	Number		Conversion factor of the second unit, copied from the item's unit definition.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DeliveryQuantity`	Delivery Quantity	Number		Quantity delivered, maintained from delivery order lines.
`Discount`	Discount	Percent		Regular discount percentage. A non-zero header Discount on the order is copied here when the line is created. Discount Amount, when above zero, wins over it.
`Discount2`	Discount2	Decimal	Yes	Cash discount percentage, the second discount pair. Cash Discount Amount, when above zero, wins over it.
`DiscountAmount`	Discount Amount	Currency		Regular discount as a value. When above zero it is used instead of the Discount percentage.
`DiscountAmount2`	Cash Discount Amount	Currency		Cash discount as a value, labelled Cash Discount Amount. When above zero it is used instead of the Discount2 percentage.
`DiscountGroupRuleId`	Discount Group Rule	Lookup → DiscountGroupRule		The discount-group rule that supplied the contract discount. Set by the platform.
`ExcludeInAutoOrder`	Exclude In Auto Order	Boolean		When ticked, the line's pending invoice quantity is not counted as open demand by auto order.
`ExternalId`	External	Text, unique
`FulfilmentAllocatedQuantity`	Fulfilment Allocated Quantity	Number		Quantity reserved by allocation lines, maintained from them.
`FulfilmentOrderQuantity`	Fulfilment Order Quantity	Number		Quantity released to fulfilment documents, maintained from their lines. Any value above zero stops the line from being deleted.
`GrossAmount`	Gross Amount	Calculated (calculated)		Calculated: Amount plus Tax Amount, less the discounts when Apply Post Tax Discount is ticked. Shown as the total of the line's Amounts panel.
`Id`	Id	Guid	Yes
`InventoryLedgerId`	Inventory Ledger	Lookup → InventoryLedger		The inventory-ledger entry for the line. Empty out of the box, because the soft-commit ledger rule for order lines is shipped switched off.
`InventoryStockId`	Stock	Lookup → InventoryStock		The stock record for the line's item, SKU, lot type and storage location. Found when the line is created and again when any of those change.
`InvoiceGroup`	Invoice Group	PickList		Splits invoicing: lines with different values go onto separate invoices, and lines with no value share one. Defaulted from the item's Invoice Group when the line leaves it blank. Values: Product, Part, Insurance.
`InvoiceQuantity`	Invoice Quantity	Decimal		Quantity invoiced, maintained from invoice lines and split into Allocated Invoiced Quantity and OTC Invoiced Quantity.
`IsILPosted`	IL Posted	Boolean		Not used on order lines.
`IsILPostingApproved`	IL Posting Approved	Boolean		Not used on order lines.
`IsPriceBundled`	Price Bundled	Boolean		The line is priced inside its package. Such a line cannot be saved with a unit price.
`IsSchemeGenerated`	Scheme Generated	Boolean		Ticked on lines a scheme created, such as free items, rather than lines a user entered.
`ItemAliasId`	Item Alias	Lookup → ItemAlias		A customer- or partner-specific product code. It must belong to the order's partner account, or the save is refused with Item Alias is not valid.
`ItemAlternateId`	Item Alternate	Lookup → ItemAlternate
`ItemComponentId`	Item Component	Lookup → ItemComponent		The package component this line was created from. Set on component lines; their quantity is checked against the component's minimum, maximum and whether it may be changed.
`ItemId`	Item	Lookup → Item	Yes	The item sold on the line. Optional when the line carries a Description instead, for a charge such as freight. Must be active when the line is created and needs a valid SKU when the item requires one. If the item has a Superseded alternate in force today, the line is switched to the successor and the original is kept in Original Item. On a package line or a package component line it cannot be changed after save.
`ItemLotId`	Item Lot	Lookup → ItemLot		A specific lot named on the line. The picker lists lots of the line's item and SKU at the order's partner account and branch. Copied to the fulfilment document line when the order is released to fulfilment, and to delivery order lines created from the order.
`ItemLotTypeId`	Item Lot Type	Lookup → ItemLotType		The lot category to sell from. The picker lists only the item's lot types. Used to match price-list and tax rules, to choose lots, and to find the stock record.
`ItemName`	Item Name	Text
`ItemServiceContractId`	Item Service Contract	Lookup → ItemServiceContract		Not filled on order lines by the platform.
`LimitExpiryDays`	Limit Expiry Days	LargeNumber		Shelf-life limit: when set, allocation uses only lots that expire at least this many days from today. Schemes that add free items set it from the benefit.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text		The line's own document number, generated on save from the Order Line Document Name Setting (series SOL, a date part and a six-digit counter).
`NetDiscount`	Net Discount	Calculated (calculated)		Calculated total of the regular, cash and contract discounts. In each pair an amount above zero wins over the percentage.
`NetSchemeDiscount`	Net Scheme Discount	Calculated (calculated)		Calculated scheme discount: Scheme Discount Amount when set, otherwise Scheme Discount as a percentage of the base.
`OpportunityLineId`	Opportunity Line	Lookup → OpportunityLine		The opportunity line this line was released from. Adding, changing or deleting the line updates the opportunity line's ordered quantity.
`OrderDiscount`	Order Discount	Calculated (calculated)		Calculated copy of the order's header Discount percentage.
`OrderId`	Order	Lookup → Order		The sales order the line belongs to. A new line, or a line moved to another order, is checked against that order's partner account and branch.
`OriginalItemId`	Original Item	Lookup		The item the line carried before it was replaced by its superseding item. Set by the platform.
`OTCInvoicedQuantity`	OTC Invoiced Quantity	Number		The part of Invoice Quantity invoiced over the counter, from invoice lines with no allocation line behind them.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PackageOrderLineId`	Order Line	Lookup → OrderLine		On a component line, the package line it belongs to. Changing the package line's quantity rescales its components, changing its item replaces them, and deleting it removes them.
`PartnerAccountId`	Partner Account	Calculated		Not maintained on order lines; the selling company is the order's Partner Account.
`PendingAllocatedInvoicedQuantity`	Pending Allocated Invoiced Quantity	Calculated (calculated)		Calculated: for a stock-tracked item, allocated quantity not yet invoiced; for other items, the pending invoice quantity.
`PendingDeliveryQuantity`	Pending Delivery Quantity	Calculated (calculated)		Calculated: Quantity minus Delivery Quantity minus Cancelled Quantity. What can still be delivered.
`PendingFulfilmentAllocationQuantity`	Pending Fulfilment Allocation Quantity	Calculated (calculated)		Calculated: Quantity minus Fulfilment Allocated Quantity minus Cancelled Quantity. What can still be allocated.
`PendingFulfilmentOrderQuantity`	Pending Fulfilment Order Quantity	Calculated (calculated)		Calculated: Quantity minus Fulfilment Order Quantity minus Cancelled Quantity. What can still be released to fulfilment or cancelled with Cancel Order.
`PendingInvoiceQuantity`	Pending Invoice Quantity	Calculated (calculated)		Calculated: Quantity minus Cancelled Quantity minus Invoice Quantity. What can still be invoiced; also counted as open demand by auto order unless Exclude In Auto Order is ticked.
`PendingPickingQuantity`	Pending Picking Quantity	Calculated (calculated)		Calculated: allocated quantity less quantity requested for picking, plus picking cancellations and returns, less quantity delivered.
`PickedQuantity`	Picked Quantity	Number		Quantity picked, maintained from the picking lines.
`PickingCancelQuantity`	Picking Cancel Quantity	Number		Quantity cancelled on picking lines, maintained from them.
`PickingRequestedQuantity`	Picking Requested Quantity	Number		Quantity requested on picking lines, maintained from them.
`PickingReturnQuantity`	Picking Return Quantity	Number		Quantity returned from picking, maintained from the picking lines.
`PriceAsOnDate`	Price As On Date	Date		The line's pricing date. It wins over the order's Price As On Date, and changing it re-prices the line.
`PriceListId`	Price List	Lookup → PriceList		The price list the line is priced from, ahead of the order's price list. Changing it re-prices the line.
`PriceListRuleId`	Price List Rule	Lookup → PriceListRule		Optional pointer to a price-list rule. Changing it re-prices the line; normal pricing writes the price without filling it.
`PurchaseOrderLineId`	Purchase Order Line	Lookup → PurchaseOrderLine		The purchase order line of another organization this line was created from by Dealer Order. Adding, changing or deleting the line updates that line's ordered quantity.
`Quantity`	Quantity	Number	Yes	The ordered quantity and the base of every pending quantity. Must be above zero. Once part of the line is released to fulfilment, cancelled or returned, it cannot be reduced below that total. On a package line, changing it rescales the component lines.
`QuoteLineId`	Quote Line	Lookup → QuoteLine		The quote line this line was copied from when the order was raised from a quote.
`RecordTypeId`	Record Type	Guid, hidden
`RequestedQuantity`	Requested Quantity	Decimal		Not stored. The per-line quantity you enter in the dialog of a Selective action on the order.
`ReturnedQuantity`	Returned Quantity	Number		Quantity returned on credit notes against the line. It does not reopen any pending quantity.
`RNAExternalId`	RNA External	Text
`RNAOrderExternalId`	RNA Order External	Text
`SchemeBenefitId`	Scheme Benefit	Lookup → SchemeBenefit		The scheme benefit that produced the line's scheme effect. Written by the scheme engine.
`SchemeDiscount`	Scheme Discount	Percent		Scheme discount percentage written by the scheme engine for a percentage benefit.
`SchemeDiscountAmount`	Scheme Discount Amount	Currency		The line's share of an amount-type scheme benefit, written by the scheme engine.
`SchemeLineId`	Scheme Line	Lookup → SchemeLine		The scheme line applied to this order line. Written by the scheme engine.
`SchemeRewardPoints`	Scheme Reward Points	LargeNumber		Reward points earned on this line from an applied scheme benefit. They are stamped onto the document's non-generated lines and are what the scheme ledger reads as its RewardPoints when the benefit is recorded.
`SkipScheme`	Skip Scheme	Boolean		Leaves this one line out of scheme evaluation; the rest of the order is still evaluated. Changing it evaluates the schemes again.
`SKUId`	SKU	Lookup → SKU		The variant of the item. Required when the item requires a SKU, and must belong to the item; the picker lists only the item's SKUs. Used to match price, discount and tax rules and to find the stock record. Cannot be changed on a package or component line.
`StockAvailable`	Stock Available	Calculated (calculated)		Free stock of the item, SKU, lot type and storage location at the order's branch, read from the line's stock record. Read-only.
`StockInHand`	Stock In Hand	Calculated (calculated)		Physical stock held for the line's stock record, including stock reserved for other demand. Read-only.
`StorageLocationId`	Storage Location	Lookup → StorageLocation		The location the line draws from. Used to find the stock record, and copied to the fulfilment document line and to delivery order lines created from the order.
`Tax1`	Tax 1	Currency
`Tax1Name`	Tax Name 1	Text
`Tax1Rate`	Tax Rate 1	Currency
`Tax1Type`	Tax Type 1	Text
`Tax2`	Tax 2	Currency
`Tax2Name`	Tax Name 2	Text
`Tax2Rate`	Tax Rate 2	Currency
`Tax2Type`	Tax Type 2	Text
`Tax3`	Tax 3	Currency
`Tax3Name`	Tax Name 3	Text
`Tax3Rate`	Tax Rate 3	Currency
`Tax3Type`	Tax Type 3	Text
`Tax4`	Tax 4	Currency
`Tax4Name`	Tax Name 4	Text
`Tax4Rate`	Tax Rate 4	Currency
`Tax4Type`	Tax Type 4	Text
`Tax5`	Tax 5	Currency
`Tax5Name`	Tax Name 5	Text
`Tax5Rate`	Tax Rate 5	Currency
`Tax5Type`	Tax Type 5	Text
`Tax6`	Tax 6	Currency
`Tax6Name`	Tax Name 6	Text
`Tax6Rate`	Tax Rate 6	Currency
`Tax6Type`	Tax Type 6	Text
`TaxAmount`	Tax Amount	Currency		Total of the line's tax components, worked out from the tax group. Maintained by the platform.
`TaxGroupId`	Tax Group	Lookup → TaxGroup		The tax group whose taxes are worked out on the line, resolved from the tax rules when the line is created. Changing it, or the item, SKU or quantity, works out the taxes again.
`UIProps`	UI Props	Text
`UnitPrice`	Unit Price	Currency	Yes	Price per unit. Filled from the matching price-list rule when the line is created; a non-zero price typed on a new line is kept. A bundled package component cannot carry a price.
`UnitPrice2`	Unit Price 2	Currency		An alternate unit price filled from the price-list rule. When it is above zero it replaces Unit Price in Base Amount.
`UOM`	UOM	PickList		The first unit the quantity is entered in. Must be one of the item's units. Quantity is worked out from UOM Quantity times its conversion ratio, plus the second unit. Values: Pack, Each, Box, Barrel, Litres, MB, Minutes, Messages, kWh.
`UOM1`	UOM 1	PickList		The second unit, so a quantity can be entered as, for example, cases plus pieces. Must be one of the item's units. Values: Pack, Each, Box, Barrel, Litres, MB, Minutes, Messages, kWh.
`UOMQuantity`	UOM Quantity	Decimal		Quantity in the first unit.
`UOMQuantity1`	UOM Quantity 1	Decimal		Quantity in the second unit.
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`BarcodeQuickAdd`	Barcode Scanner	UIAction	Scan barcodes to add order lines
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete in a list page
`Edit`	Edit	Edit	Edit
`EditHeader`	Edit	EditInline	Edit
`EditListRow`	Edit	Edit	EditListRow
`Import`	Import	UIAction	List-header action that opens the ImportSO layout to bring order lines in from a file rather than entering them one by one. It is a client-side layout action with no server action behind it; the imported rows go through the normal order-line save path.
`NewInLine`	Quick Add	NewInline	Labelled 'Quick Add': adds an order line inline in the grid rather than through the full line form. The line handler still applies all its defaults on save — item alias, unit conversion, prices, taxes, discounts, stock resolution, package explosion and scheme processing — exactly as for a full-form insert.
`ProductCatalogue`	Product Catalogue	UIAction	List-header button that opens the product catalogue layout for adding lines to the order. It names no server action, so pressing it runs nothing on the server.

Validations

Validation	Applies to	Error message	Notes
Quantity Cancelled Rule Validation	`CancelledQuantity`, Error	Quantity cancelled cannot be greater than Quantity.	Quantity cancelled cannot be greater than Quantity.
Quantity Rule Validation	`Quantity`, Error	Quantity should not be less than 0	Quantity should not be less than 0
Track Asset Quantity Validation	`Quantity`, Error, inactive	Quantity cannot be greater than 1 for asset-tracked items.	When Track Asset is enabled on the Item, quantity cannot exceed 1.
Unit Price Rule Validation	`UnitPrice`, Error	Unit Price can not be less than 0	Unit Price can not be less than 0
Validate On Incorrect Item Alias	`ItemAliasId`, Error	Item Alias is not valid.	Item Alias is not valid.

Lookup filters

Filter	Lookup field	Notes
Lot for Partner and Branch	`ItemLotId`
Lot Type for Item	`ItemLotTypeId`
Sku For Item	`SKUId`

ItemLotType — looks up via ItemLotTypeId
UserAccount — looks up via CreatedById
ItemComponent — looks up via ItemComponentId
UserAccount — looks up via OwnerId
SKU — looks up via SKUId
PriceListRule — looks up via PriceListRuleId
OpportunityLine — looks up via OpportunityLineId
PurchaseOrderLine — looks up via PurchaseOrderLineId
OrderLine — looks up via PackageOrderLineId
ItemAlternate — looks up via ItemAlternateId
DiscountGroupRule — looks up via DiscountGroupRuleId
StorageLocation — looks up via StorageLocationId
PriceList — looks up via PriceListId
Item — looks up via ItemId
TaxGroup — looks up via TaxGroupId
QuoteLine — looks up via QuoteLineId
InventoryLedger — looks up via InventoryLedgerId
InventoryStock — looks up via InventoryStockId
ItemAlias — looks up via ItemAliasId
UserAccount — looks up via ModifiedById
SchemeBenefit — looks up via SchemeBenefitId
ItemLot — looks up via ItemLotId
ItemServiceContract — looks up via ItemServiceContractId
Order — looks up via OrderId
Item — looks up via OriginalItemId
SchemeLine — looks up via SchemeLineId
InvoiceLine — referenced by via OrderLineId
InventoryFulfilmentOrderLine — referenced by via OrderLineId
CreditNoteLine — referenced by via OrderLineId
SchemeLedger — referenced by via OrderLineId
InventoryFulfilmentAllocationLine — referenced by via OrderLineId
InventoryFulfilmentPickingLine — referenced by via OrderLineId
OrderLine — referenced by via PackageOrderLineId
KYCDocument — referenced by via OrderLineId
DeliveryOrderLine — referenced by via OrderLineId
InvoiceLine — referenced by via PackageOrderLineId
Subscription — referenced by via OrderLineId

Order Line — entity reference

Fields

Actions

Validations

Lookup filters

Related entities

Related topics