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

Auto Purchase Order Line — entity reference

One suggestion line on an auto order: an item to buy, the quantity the order's rule suggested, your working quantity, its price, and a snapshot of the stock and pipeline figures the suggestion was built from. Lines are created by Generate Lines (Minimum Stock Level, Replenish, Forecasting, Back Order), by Order from Template, by the scheduled forecast job, when a basket is copied from a purchase order, or by hand with Quick Add. Purchase Order and Selective Order turn lines with pending quantity into purchase order lines that link back to the suggestion line, and each line's Purchase Order Quantity then rolls up what has been ordered from it. Generate Lines deletes and rebuilds every line on the order.

Fields

FieldLabelTypeRequiredWhat it does
AmountAmountCalculated (calculated)Quantity times Unit Cost. The auto order's Total Amount adds these up when lines are generated, copied or spawned. Lines with a zero amount are left out of the budget cap.
AutoOrderIdAuto OrderLookup → AutoOrderThe auto order (worksheet) the line belongs to. Set when the line is created; lines are always added from the auto order's Lines tab or by its actions.
AverageConsumptionAverage ConsumptionNumberForecasting only: average consumption from the matching planning rows, averaged and rounded to a whole number. Multiplied by lead time in the reorder point.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DerivedQuantityDerived QuantityCalculated (calculated)Suggested Quantity plus Open Order Quantity, calculated. This is the quantity Purchase Order puts on the purchase order line, and the upper limit for a Selective Order requested quantity. A line whose Derived Quantity is 0 is skipped without a message.
ExternalIdExternalText, unique
IdIdGuidYes
ItemIdItemLookup → ItemThe item to buy. On insert the item must be active, and a SKU must be given when the item requires one, otherwise the save, including Generate Lines, is refused with Item is Inactive. or SKU is required for this item. Copied onto the purchase order line.
ItemLotTypeIdItem Lot TypeLookup → ItemLotTypeThe lot type the suggestion is for. Filled on Back Order lines (from the fulfilment line) and on lines copied from a basket template; used to pick a lot-specific price rule. It is not copied onto the purchase order line.
LeadTimeLead TimeNumberForecasting only: the lead time from the matching planning rows, averaged and rounded to a whole number.
MaximumQuantityMaximum QuantityNumberForecasting only: the maximum order quantity from the matching planning rows, averaged. The suggestion tops projected stock back up to this figure.
MinimumQuantityMinimum QuantityNumberForecasting only: the minimum order quantity from the matching planning rows, averaged. Part of the reorder point (lead time times average consumption plus this).
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextYesThe line's number. Lines created on screen (Generate Lines, Order from Template, Quick Add) are numbered from the Auto Purchase Order Line document name setting, series APOL by default.
OpenOrderQuantityOpen Order QuantityNumberQuantity already on open purchase orders for the same partner account, branch, item and SKU, filled only on Minimum Stock Level and Replenish lines when the order's open-purchase-orders setting is on. It is added to Suggested Quantity in Derived Quantity. Always 0 on Forecasting, Back Order and basket lines.
OwnerIdOwnerLookup → UserAccountYes
PendingPurchaseOrderQuantityPending Purchase Order QuantityNumberQuantity on pending purchase orders counted for the item, on Forecasting and Back Order lines when the pending-purchase-orders setting is on. Kept for explanation only; it is not added to Derived Quantity, because it is already netted.
PendingQuantityPending QuantityCalculated (calculated)Quantity minus Purchase Order Quantity, calculated. Purchase Order and Selective Order only order lines whose pending quantity is above zero, and a Selective Order requested quantity may not exceed it.
PendingQuoteQuantityPending Quote QuantityNumberAlways 0. The High Probability Quotes setting is stored, but no quotation quantity is read.
PendingRequisitionQuantityPending Requisition QuantityNumberQuantity on open requisitions counted for the item when the requisitions setting is on. Forecasting subtracts it from projected stock; Back Order treats it as supply on its way.
PendingSaleOrderQuantityPending Sale Order QuantityNumberOn Forecasting lines, open sale order quantity subtracted from projected stock when that setting is on. On Back Order lines, what the fulfilment line still owes the customer (quantity minus allocated minus cancelled).
PendingShipmentQuantityPending Shipment QuantityNumberStock in transit counted for the item. Forecasting records the quantity it added to the projection; Back Order records the item's total in-transit supply netted against shortfalls. 0 when the in-transit setting is off.
PriceAsOnDatePrice As On DateDateThe date prices are looked up for on this line, overriding the auto order's Price As On Date. Copied on basket lines; not on the seeded line forms.
PriceListIdPrice ListLookup → PriceListA price list for this line only, overriding the auto order's. Not on the seeded line forms; basket copies take it from the source line. Changing it re-prices the line.
PriceListRuleIdPrice List RuleLookup → PriceListRuleThe price list rule behind the line's cost, when one is recorded. Not on the seeded line forms; changing it re-prices the line from that rule.
ProjectedQuantityProjected QuantityNumberForecasting only: available stock plus stock in transit and pending purchase orders, minus open requisitions and open sale orders, for the terms switched on. The suggestion is made only when this is at or below the reorder point.
PurchaseOrderQuantityPurchase Order QuantityNumberThe total Quantity of purchase order lines raised from this line. Recalculated when such a purchase order line is added, deleted or its Quantity changes; cancelling quantity on the purchase order line does not reduce it.
QuantityQuantityNumberYesYour working quantity. It starts equal to the suggestion (Replenish uses 1 when the allocated total is 0), is scaled down by the budget cap, and sets Amount and Pending Quantity. It must be at least 1: any save with a smaller value, including a budget cap that scales a line below 1, is refused with Quantity cannot be less than 1. Changing it does not change what Purchase Order orders, which follows Derived Quantity.
QuantityAvailableQuantity AvailableNumberAvailable stock for the item and SKU at the order's branch and partner account when a Forecasting line was built. A frozen snapshot; 0 on other line types.
RecordTypeIdRecord TypeGuid, hidden
ReorderQuantityReorder QuantityNumberForecasting only: the reorder quantity from the matching planning rows, averaged, recorded for explanation. Forecasting does not order it; Minimum Stock Level orders the planning row's reorder quantity but leaves this field 0.
RequestedQuantityRequested QuantityNumberEntered only in the Selective Order dialog: the quantity to order from this line. Must be greater than zero and no more than Pending Quantity; the purchase order line gets the smaller of it and Derived Quantity. Not stored on the line.
SKUIdSKULookup → SKUThe item variant to buy. Minimum Stock Level takes it from the stock record that fell below the minimum, Forecasting from the planning row (empty when the row has no SKU), Back Order from the fulfilment line. Must belong to the item. Copied onto the purchase order line.
SuggestedQuantitySuggested QuantityNumberWhat the order's rule computed: the reorder quantity or shortfall (Minimum Stock Level), the quantity allocated since the last Replenish order (Replenish), maximum order quantity minus projected stock (Forecasting), or what the fulfilment line still owes after inbound supply (Back Order). Scaled down by the budget cap. Together with Open Order Quantity it makes up Derived Quantity, which is what Purchase Order orders. A Quick Add line has 0 until you set it.
UIPropsUI PropsText
UnitCostUnit CostCurrencyThe purchase cost per unit. After lines are generated or copied, it is set from the price list rule for the item, SKU and lot type on the line's price list, else the auto order's price list, else the default price list, for the line's or order's price date (or the document date). A line no rule matches keeps 0 (or, on a basket copy, the source cost). On Quick Add a cost you type is kept. Copied onto the purchase order line.
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
DeleteinRowDeleteDeleteDelete
EditEditEditEdit
EditinLineEditEditInlineEdit
EditPopUpEditEditEdit
NewNewNewNew
NewInLineQuick AddNewInlineNew

Validations

ValidationApplies toError messageNotes
Quantity Rule ValidationQuantity, ErrorQuantity cannot be less than 1.Quantity cannot be less than 1.
Unit Cost Rule ValidationUnitCost, Error, inactiveUnit cost cannot be negativeUnit cost cannot be negative