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/Purchase Order Line — entity reference
REFERENCE · Last reviewed

Purchase Order Line — entity reference

One position on a purchase order: an item (or a free-text charge), the quantity ordered and the buy price, numbered from document numbering (shipped series PL). When the line is added it is priced from the purchase price list, given a contract discount from the order's discount group and a tax group from the tax group rules, and its taxes are copied onto it. Three independent counters track what happened downstream against the same ordered quantity: Receipt Quantity (released to goods receipts), Invoice Quantity (billed) and Order Quantity (sent as dealer orders); Pending Quantity, Pending Invoice Quantity and Pending Order Quantity are what is left for each. Quantity cannot be lowered below what has been received and returned, and a line with receipt quantity cannot be deleted.

Fields

FieldLabelTypeRequiredWhat it does
AmountAmountCalculated (calculated)Calculated taxable value of the line: Base Amount less Net Scheme Discount and Net Discount. When the partner account takes discounts after tax, discounts are not deducted here but from Gross Amount. The order's Total Line Amount is the sum of this field.
ApplyPostTaxDiscountApply Post Tax DiscountBooleanYesWhether the line's discounts are taken after tax. Copied from the order's partner account when the line's taxes are calculated; not entered on the line.
AutoPurchaseOrderLineIdAuto Purchase Order LineLookup → AutoPurchaseOrderLineThe auto order suggestion line this order line was generated from. Its quantity counts against that suggestion, so a partly accepted suggestion shows what is still pending.
BaseAmountBase AmountCalculated (calculated)Calculated: Quantity times Unit Cost 2 when that is greater than zero, otherwise Quantity times Unit Cost. The line value before discounts and tax.
BenefitIndexBenefit IndexNumberSet by the scheme engine to group benefit lines; cleared when schemes are re-applied.
BranchIdBranchCalculated (calculated)Calculated text copy of the order's branch, for filtering and grouping lines. Not a link to the branch.
CancelledQuantityCancelled QuantityDecimalQuantity you no longer expect from the supplier. It reduces Pending Quantity, Pending Invoice Quantity, the most that may be received against the line and the taxable value, but not Base Amount. Not on the shipped line forms: an administrator adds it to the line's record layout so that users can enter it.
ContractDiscountContract DiscountPercentContract discount percentage, filled from the order's discount group when the line is added (not on description-only lines). Part of Net Discount.
ContractDiscountAmountContract Discount AmountCurrencyA fixed contract discount amount, filled from the discount group when it defines an amount instead of a percentage. When greater than zero it replaces Contract Discount in Net Discount.
ConversionRatioConversion RatioNumberConversion ratio from the first unit of measure to the item's base unit.
ConversionRatio1Conversion Ratio 1NumberConversion ratio from the second unit of measure to the item's base unit.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DiscountDiscountPercentTrade discount percentage (0 to 100). Ignored when Discount Amount is greater than zero. Part of Net Discount.
Discount2Cash DiscountPercentCash discount percentage (0 to 100). Ignored when Cash Discount Amount is greater than zero. Part of Net Discount.
DiscountAmountDiscount AmountCurrencyA fixed trade discount amount. When greater than zero it replaces the Discount percentage in Net Discount.
DiscountAmount2Cash Discount AmountCurrencyA fixed cash discount amount. When greater than zero it replaces the Cash Discount percentage in Net Discount.
ExcludeInAutoOrderExclude In Auto OrderBooleanYesLeaves the line's pending quantity out of the inbound supply used by auto order and replenishment projections.
ExternalIdExternalText, unique
GrossAmountGross AmountCalculated (calculated)Calculated all-in value of the line: Amount plus Tax Amount, less the discounts when they are taken after tax. Shown as the total of the line's Amounts panel.
IdIdGuidYes
InventoryFulfilmentOrderLineIdInventory Fulfillment Order LineLookup → InventoryFulfilmentOrderLineThe fulfilment order line this purchase is meant to cover, set by the back order flow through auto order. The line's quantity counts as back-ordered against it.
InventoryStockIdStockLookup → InventoryStockThe stock row (item, SKU, branch and storage location) matched to the line when it is added. The order itself never changes stock; goods receipts do.
InvoiceQuantityInvoice QuantityNumberHow much of the line has been billed: the sum of the quantity on the bill lines linked to it. Maintained by the system.
IsSchemeGeneratedIs Scheme GeneratedBooleanYesSet on a line the scheme engine added as a scheme benefit. Such lines are removed and rebuilt whenever schemes are re-applied or reset.
ItemAliasIdItem AliasLookup → ItemAliasThe item alias picked on the shipped create form, which the Lines tab does not use.
ItemAlternateIdItem AlternateLookup → ItemAlternateThe item alternate applied when the line was added; alternates are applied before pricing and taxes.
ItemComponentIdItem ComponentLookup → ItemComponentOn a component line, the package component it represents. Its minimum, maximum and mandatory settings limit the quantity you may enter, and a mandatory component cannot be removed.
ItemIdItemLookup → ItemThe item being bought. Optional when the line carries a Description instead, for a charge such as freight; a line needs one or the other. Only active items can be picked; discontinued items and discount items are refused. Locked when the line came from a requisition line, and once returns exist against it.
ItemLotTypeIdItem Lot TypeLookup → ItemLotTypeShown on the shipped line forms but not stored on purchase order lines: a value entered here is not saved.
ItemNameItemNameTextNot shown on the shipped line forms.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextThe line number, generated on save from document numbering (shipped series PL, the date as DDMMYYYY and a six-digit counter).
NetDiscountNet DiscountCalculated (calculated)Calculated: the trade, cash and contract discounts added together, each taken as its amount when one is set and otherwise as its percentage of the line value. The order's Total Discount Amount is the sum of this field.
NetSchemeDiscountNet Scheme DiscountCalculated (calculated)Calculated: Scheme Discount Amount when set, otherwise Base Amount times the Scheme Discount percentage. The order's Total Scheme Discount Amount is the sum of this field.
OrderQuantityOrder QuantityNumberHow much of the line has been sent to an on-platform supplier as a dealer order: the sum of the quantity on the sale order lines created from it. Not the ordered quantity, which is Quantity.
OriginalItemIdOriginal ItemLookup → ItemThe item originally asked for when the line was substituted with an alternate item.
OwnerIdOwnerLookup → UserAccountYes
PackagePurchaseOrderLineIdPurchase Order LineLookup → PurchaseOrderLineOn a component line, the package line it was added under. Adding a package item adds its purchase components as their own lines; deleting the package line removes them. Component lines are received and billed in their own right.
PartnerAccountIdPartner AccountCalculatedText field, not a link to an account. Read the partner account from the purchase order.
PendingInvoiceQuantityPending Invoice QuantityCalculated (calculated)Calculated: Quantity minus Invoice Quantity minus Cancelled Quantity. What is still to be billed; the invoice releases draw on it.
PendingOrderQuantityPending Order QuantityCalculated (calculated)Calculated: Quantity minus Order Quantity. What is still to be sent as a dealer order.
PendingQuantityPending QuantityCalculated (calculated)Calculated: Quantity minus Receipt Quantity minus Cancelled Quantity. What is still to be released for receipt; shipment and receipt releases draw on it. The order's Total Pending Quantity is the sum of this field.
PriceAsOnDatePrice As On DateDateThe date this line is priced on. Empty means the header's Price As On Date, then the order's Document Date, then today. Changing it re-prices the line.
PriceListIdPrice ListLookup → PriceListThe price list for this line. Empty means the order's price list, then the default purchase price list. Changing it on the line re-prices the line.
PriceListRuleIdPrice List RuleLookup → PriceListRuleA price list rule to price this line from. Changing it re-prices the line. It is not filled in automatically when the line is priced.
PurchaseOrderIdPurchase OrderLookup → PurchaseOrderThe purchase order the line belongs to. Required, and cannot be changed once the line is saved.
PurchaseOrderLineNumberPurchaseOrderLineNumberNumberNot shown on the shipped forms and not filled in by the system.
PurchaseRequisitionIdPurchase RequisitionLookup → RequisitionThe requisition the line was created from, by Add Requisition, Selective Requisition Lines or a release on the requisition. Filled automatically.
QuantityQuantityNumberYesThe quantity ordered. Must be greater than zero. When the item has planning attributes it must respect the minimum and maximum order quantity and be a multiple of the lot quantity. It cannot be lowered below the quantity already received plus returned. On a package line, changing it rescales the component lines.
ReceiptQuantityReceipt QuantityNumberHow much of the line has been released to goods receipts: the sum of the ordered quantity on the goods receipt lines linked to it. It counts what was released for receipt, not what was physically counted in. Maintained by the system.
RecordTypeIdRecord TypeGuid, hidden
RequestedQuantityRequested QuantityNumberNot stored. The quantity you type for a line in a selective release dialog (receipt, invoice, shipment or dealer order); it must be greater than zero and no more than the line's pending quantity for that release.
RequisitionLineIdRequisition LineLookup → RequisitionLineThe requisition line this order line was created from. Its quantity counts against that requisition line so it is not ordered twice. While it is set, the line's Item and SKU cannot be changed.
ReturnedQuantityReturned QuantityNumberQuantity returned to the supplier on bill returns against this line. Maintained by the system and not editable. Once it is greater than zero, the line's Item and SKU are locked.
SchemeBenefitIdScheme BenefitLookup → SchemeBenfitThe scheme benefit that produced this line, on scheme-generated lines.
SchemeDiscountScheme DiscountPercentScheme discount percentage, written by the scheme engine when a supplier scheme applies. Cleared when schemes are re-applied or reset.
SchemeDiscount1Scheme DiscountPercentShown on the shipped create form but not stored on purchase order lines: a value entered here is not saved. Use Scheme Discount.
SchemeDiscountAmountScheme Discount AmountCurrencyA fixed scheme discount amount, written by the scheme engine. When greater than zero it replaces the Scheme Discount percentage.
SchemeLineIdScheme LineLookup → SchemeLineThe scheme line that discounted or produced this line. Set by the scheme engine.
SchemeRewardPointsScheme Reward PointsNumber
ServiceOrderLineIdService Order LineLookup → ServiceOrderLineThe service order line the part was ordered for (VOR ordering). The line's quantity counts as allocated against that service order line.
SkipSchemeSkip SchemeBooleanYesLeaves this line out of scheme evaluation. Changing it re-runs schemes on the order.
SKUIdSKULookup → SKUThe item variant. Required when the item requires a SKU, and limited to the item's SKUs. Locked under the same conditions as Item. Changing it re-prices and re-taxes the line.
Tax1Tax 1CurrencyAmount of the tax in the line's tax group whose posting field is Tax 1. Tax Name 1, Tax Rate 1 and Tax Type 1 describe that tax. The six tax slots are a copy taken when the line is saved, so later rate changes do not alter saved lines.
Tax1NameTax Name 1Text
Tax1RateTax Rate 1Currency
Tax1TypeTax Type 1Text
Tax2Tax 2CurrencyAmount of the tax whose posting field is Tax 2, described by Tax Name 2, Tax Rate 2 and Tax Type 2.
Tax2NameTax Name 2Text
Tax2RateTax Rate 2Currency
Tax2TypeTax Type 2Text
Tax3Tax 3CurrencyAmount of the tax whose posting field is Tax 3, described by Tax Name 3, Tax Rate 3 and Tax Type 3.
Tax3NameTax Name 3Text
Tax3RateTax Rate 3Currency
Tax3TypeTax Type 3Text
Tax4Tax 4CurrencyAmount of the tax whose posting field is Tax 4, described by Tax Name 4, Tax Rate 4 and Tax Type 4.
Tax4NameTax Name 4Text
Tax4RateTax Rate 4Currency
Tax4TypeTax Type 4Text
Tax5Tax 5CurrencyAmount of the tax whose posting field is Tax 5, described by Tax Name 5, Tax Rate 5 and Tax Type 5.
Tax5NameTax Name 5Text
Tax5RateTax Rate 5Currency
Tax5TypeTax Type 5Text
Tax6Tax 6CurrencyAmount of the tax whose posting field is Tax 6, described by Tax Name 6, Tax Rate 6 and Tax Type 6.
Tax6NameTax Name 6Text
Tax6RateTax Rate 6Currency
Tax6TypeTax Type 6Text
TaxAmountTax AmountCurrencyThe line's total tax, calculated from the taxes in its tax group on the taxable value (net of discounts and of any cancelled quantity). Re-calculated when the item, SKU, quantity, amount or tax group changes.
TaxGroupIdTax GroupLookup → TaxGroupThe line's tax group. Filled from the tax group rules (partner, branch, item, SKU and item group) when the line is added, or picked by you. Changing it re-calculates the line's taxes. Discount items get no tax group.
UIPropsUI PropsText
UnitCostUnit CostCurrencyThe buy price per unit. Taken from the purchase price list rule in force on the pricing date when the line is added, unless you type one. Re-resolved when the line's price list, price list rule or price date changes, or when the header Price As On Date changes. Copied to shipment and goods receipt lines on release.
UnitCost2Unit Cost 2CurrencyA second price taken from the price list rule's second price. When it is greater than zero it is used instead of Unit Cost to calculate Base Amount.
UOMUOMPickListUnit of measure the quantity was entered in. With UOM Quantity and Conversion Ratio, Quantity is derived from it and rounded to the item's precision.
UOM1UOM 1PickListSecond unit of measure. Values: Each, kWh.
UOMQuantityUOM QuantityNumberQuantity entered in the first unit of measure; converted into Quantity with Conversion Ratio.
UOMQuantity1UOM Quantity1NumberQuantity entered in the second unit of measure.
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditEntityEditEditEditEntity
EditInLineEditEditInlineEdit
HeaderEditHeaderEditEditInlineEdit
ImportImportUIActionA layout-driven bulk load of order lines from a file rather than a server action; the lines it produces go through the ordinary line save pipeline, so minimum, maximum and lot-multiple order-quantity rules and price resolution all still apply to each imported row.
MainNewNewNewNew
NewQuick AddNewInlineNew
ProductCatalogueProduct CatalogueUIActionProductCatalogue

Validations

ValidationApplies toError messageNotes
Item Required ValidationItemId, ErrorItem is Required.Item is Required.
Tax Group ValidationError, inactiveTax Group Type must be "Line Level".Ensures tax group type is 'Line Level' for purchase order lines

Lookup filters

FilterLookup fieldNotes
Active ItemItemId
Sku For ItemSKUId