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

Auto Order — entity reference

An auto order is a worksheet of purchase suggestions for one partner account, branch and supplier. Its Auto Order Type picks the rule that builds the lines: Minimum Stock Level, Replenish, Forecasting or Back Order are generated on demand with Generate Lines; a Template is a reusable configuration (or basket of items) that spawns dated orders with Order from Template or the scheduled job; a Template Order is a spawned order whose lines were copied from a basket template. Nothing is bought automatically: Purchase Order or Selective Order turns the reviewed lines into one purchase order for the branch and supplier.

Fields

FieldLabelTypeRequiredWhat it does
AIRecommendationAI RecommendationPickListStored only. No engine or action reads it; suggestions are always computed by the fixed rules. Values: Einstein 1, DemandSense AI, Einstein 2, AutoProcure AI, SmartReplenish AI, Einstein 3, Einstein 4, InventoryPilot AI.
ApplyInventoryAttributeSettingsApply Inventory Attribute SettingsPickListShown on the settings panel as the inventory attributes conflict choice. Stored and copied to spawned orders, but no engine reads it: where several planning rows match, Forecasting always averages them. Values: Auto Min Max Settings, Manual Min Max Settings, Average of Auto & Manual Settings, Prefer Auto.
AutoOrderTypeAuto Order TypePickListPicks the engine. Minimum Stock Level, Replenish, Forecasting and Back Order are generated with Generate Lines. Template is a reusable configuration that spawns dated orders. Template Order is set by the system on an order whose lines were copied from a basket template; Generate Lines refuses it. Values: Back Order, Minimum Stock Level, Forecasting, Template, Replenish.
AutoPurchaseOrderIdAuto Purchase OrderLookupOn an order spawned from a template, the template it came from. The scheduled job uses this link to spawn at most one dated order per template per day. Not on the seeded create form.
BranchIdBranchLookup → BranchThe branch whose stock, planning rows and documents the engines read, and the branch of the purchase order generated from the worksheet. Must belong to the partner account; cannot be changed after the order is created.
BudgetAmountBudget AmountCurrencyFit to budget. After the lines are priced, if the total exceeds this amount every line with a non-zero amount has its quantities scaled down by the same factor (rounded to two decimals). Zero or empty means no cap. Applied by Generate Lines, Order from Template and when a basket is copied in, but not by the scheduled job. Cannot be negative.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
CreateTemplateCreate TemplateBooleanYesNot used. Make a template by choosing Template as the Auto Order Type.
DocumentDateDocument DateDateSet to today when the order is created. Cannot be changed afterwards. Replenish uses the latest Replenish document date for the branch as its start date.
ExcludeACategoryItemsExclude A Category ItemsBooleanYesLeaves out items whose planning row has the ABC category A Category. Applied by every engine.
ExcludeBCategoryItemsExclude B Category ItemsBooleanYesLeaves out items whose planning row has the ABC category B Category. Applied by every engine.
ExcludeCCategoryItemsExclude C Category ItemsBooleanYesLeaves out items whose planning row has the ABC category C Category. Applied by every engine.
ExcludeFastMovingItemsExclude Fast Moving ItemsBooleanYesLeaves out items whose planning row has the FSN category Fast-Moving. Applied by every engine; an item with no planning row is never excluded.
ExcludeNonMovingItemsExclude Non Moving ItemsBooleanYesLeaves out items whose planning row has the FSN category Non-Moving. Applied by every engine.
ExcludeSlowMovingItemsExclude Slow Moving ItemsBooleanYesLeaves out items whose planning row has the FSN category Slow-Moving. Applied by every engine.
ExternalIdExternalText, unique
IdIdGuidYes
IncludeHighProbabilityQuoteInclude High Probability QuoteBooleanYesStored and copied to spawned orders, but no engine reads it; the quote term in the projection is always zero.
IncludeInTransitShipmentsInclude In-Transit ShipmentsBooleanYesCounts pending quantity on inbound shipment lines as supply. Read by the Forecasting and Back Order engines.
IncludeOpenSaleOrdersInclude Open Sale OrdersBooleanYesForecasting only: subtracts open sale-order quantity as committed demand when projecting stock.
IncludePendingPurchaseOrdersInclude Pending Purchase OrdersBooleanYesCounts pending quantity on open purchase-order lines as supply. Read by the Forecasting and Back Order engines.
IncludePurchaseRequisitionInclude Purchase RequisitionBooleanYesForecasting: subtracts open requisition quantity as demand. Back Order: counts it as supply already requested, so the shortfall is not bought twice.
IsOrderGeneratedIs Order GeneratedCalculated (calculated)YesNever set by the platform. The checks that refuse Generate Lines and Purchase Order when it is on therefore never fire; a purchase order raised from the worksheet does not lock it.
LastAutoOrderDateLast Auto Order DateDateNot read by any engine; Replenish works out its own start date from the branch's latest Replenish auto order. A seeded validation refuses today's date or any earlier date in this field, so leave it empty.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberText, uniqueThe document number, numbered by the Auto Order document name setting (default series APO). Spawned orders are named after their template with the date appended.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountThe company the worksheet buys for. Copied to the generated purchase order. Cannot be changed after creation.
PerformOpenOrderCalculationPerform Open Order CalculationBooleanYesMinimum Stock Level and Replenish: fills each line's Open Order Quantity with the quantity still pending on purchase orders for the same partner, branch, item and SKU. That quantity is added to the line's Derived Quantity, which is what the purchase order takes.
PerformOrderGenerationPerform Order GenerationBooleanYesNot used. Purchase orders are raised with the Purchase Order and Selective Order actions.
PriceAsOnDatePrice As On DateDateThe date prices are looked up for. Copied from the template or source purchase order when one is used.
PriceListIdPrice ListLookup → PriceListThe purchase price list used to price the lines. Defaults to the default purchase price list when the order is created; copied from the template or source purchase order when one is used.
RecordTypeIdRecord TypeGuid, hidden
RemarksRemarksTextFree text. Filled with the source purchase order's number when an order is created from a marked purchase order and left empty.
ResourceIdGenerated ByLookup → ResourceThe resource recorded as having generated the order. Copied from the template when one is used.
StatusStatusPickListNot set by the generation actions. A seeded business rule sets Order Generated when the auto order is saved and its lines show purchase-order quantity with no pending purchase-order snapshot, so it can lag or never change. Spawned orders copy the template's value. Values: Draft, Order Generated.
SupplierAccountIdSupplier AccountLookup → AccountThe supplier the generated purchase order is raised on. Cannot be changed after creation.
TotalAmountTotal AmountCalculated (calculated)Sum of the line amounts, recalculated whenever lines are generated, copied or spawned.
TotalPendingQuantityTotal Pending QuantityCalculated (calculated)Sum of the lines' pending quantity at the time the lines were generated, copied or spawned.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditInlineEdit
EditInListEditEditInlineEdit
EditPopUpEditEditEdit
GenerateForecastLinesLinesServerAction (GenerateAutoOrderLines)Generate Lines. Deletes the existing lines and builds new ones with the engine for the Auto Order Type (Minimum Stock Level, Replenish, Forecasting or Back Order), then prices them, applies the budget cap and totals the header. Refused on Template and Template Order types.
GenerateTemplateOrderOrder from TemplateServerAction (GenerateTemplateOrder)Order from Template. Template only. Creates a new dated auto order linked to the template: a Forecasting order whose lines are generated now, or, when the template carries lines, a Template Order holding a copy of them. The template itself is not changed.
NewNewNewNew
PerformOrderGenerationPurchase OrderServerAction (PerformOrderGeneration)Purchase Order. Creates one purchase order for the auto order's partner, branch and supplier from every line with pending quantity, each line taking its Derived Quantity. Refused when no line has pending quantity.
SelectiveOrderGenerationSelective OrderServerAction (SelectiveOrderGeneration)Selective Order. Opens the lines in an editable table; the purchase order takes only the lines you give a Requested Quantity. Each requested quantity must be greater than zero and not more than the line's pending quantity, and is capped at its Derived Quantity.

Validations

ValidationApplies toError messageNotes
Budget Amount Rule ValidationBudgetAmount, ErrorBudgeted Amount Can not be Less than 0Budgeted Amount Can not be Less than 0
Last Auto Order Date ValidationLastAutoOrderDate, ErrorLast auto order date cannot go beyond today's dateLast auto order date cannot go beyond today's date

Lookup filters

FilterLookup fieldNotes
Branch For Partner AccountBranchId
Only Partner AccountPartnerAccountId
Only SupplierSupplierAccountId