xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse 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
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

A replenishment-planning header that first proposes what to buy and then generates the purchase order from the accepted proposal. AutoOrderType is the discriminator the engine branches on, and only four values are implemented: 'Minimum Stock Level' and 'Replenish' build proposal lines from stock settings and recent allocations, 'Forecasting' runs the projected-stock reorder-point calculation with pipeline netting, and 'Template' is a reusable configuration that spawns a fresh dated Forecasting order rather than holding lines of its own. GenerateAutoOrderLines builds (and on re-run replaces) the proposal, then prices it and applies the BudgetAmount cap; PerformOrderGeneration or SelectiveOrderGeneration turns accepted lines into a PurchaseOrder that links back through PurchaseOrder.PurchaseAutoOrderId. The Include and Exclude flags scope which items and which supply and demand sources the Forecasting calculation may see.

Fields

FieldLabelTypeRequiredWhat it does
AIRecommendationAI RecommendationPickListNothing in the platform reads or writes it, and no recommendation engine is wired to auto ordering; the suggested quantities come from the deterministic minimum-stock, replenish and forecasting calculations. Values: Einstein 1, DemandSense AI, Einstein 2, AutoProcure AI, SmartReplenish AI, Einstein 3, Einstein 4, InventoryPilot AI.
ApplyInventoryAttributeSettingsApply Inventory Attribute SettingsPickListValues: Auto Min Max Settings, Manual Min Max Settings, Average of Auto & Manual Settings, Prefer Auto.
AutoOrderTypeAuto Order TypePickListValues: Back Order, Minimum Stock Level, Forecasting, Template, Replenish.
AutoPurchaseOrderIdAuto Purchase OrderLookupOn an order spawned from a template, this points back at the template it was cloned from. The scheduled sweep uses exactly this link to decide whether a template has already produced its order for today, so it is what keeps template generation to one dated order per template per day.
BranchIdBranchLookup → Branch
BudgetAmountBudget AmountCurrencyA spend cap applied after the proposal lines are priced: when the priced total exceeds it, every line that carries a non-zero amount has its quantity, suggested, derived and pending quantities scaled down by the same factor so the order fits, with values rounded to two decimals. Empty or zero means no cap, and lines priced at zero (no applicable price rule found) are deliberately left untouched rather than trimmed.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
CreateTemplateCreate TemplateBooleanYesA flag with no code behind it anywhere in the platform. A reusable planning configuration is created by setting AutoOrderType to Template, not by ticking this.
DocumentDateDocument DateDate
ExcludeACategoryItemsExclude A Category ItemsBooleanYesExcludes items whose inventory attributes classify them in the A value band from the proposal, applied before any quantity is computed. The three ABC flags and the three fast/slow/non-moving flags are tested against the item's inventory-attribute row, and an item with no such row is never excluded.
ExcludeBCategoryItemsExclude B Category ItemsBooleanYes
ExcludeCCategoryItemsExclude C Category ItemsBooleanYes
ExcludeFastMovingItemsExclude Fast Moving ItemsBooleanYes
ExcludeNonMovingItemsExclude Non Moving ItemsBooleanYesDrops items classified as non-moving from the proposal. Because the movement category comes from the item's inventory-attribute row, an item that has never been classified is not excluded by this flag.
ExcludeSlowMovingItemsExclude Slow Moving ItemsBooleanYesDrops items classified as slow-moving from the proposal. The exclusion is applied by all three line-building engines, matching the item's movement category exactly, and an item with no inventory-attribute row has no category to test and so survives the filter.
ExternalIdExternalText, unique
IdIdGuidYes
IncludeHighProbabilityQuoteInclude High Probability QuoteBooleanYes
IncludeInTransitShipmentsInclude In-Transit ShipmentsBooleanYes
IncludeOpenSaleOrdersInclude Open Sale OrdersBooleanYesForecasting only: when set, committed outbound demand from open sale orders is subtracted when projecting stock forward, which lowers the projected quantity and makes replenishment more likely to trigger. Left off, open sale orders are invisible to the calculation.
IncludePendingPurchaseOrdersInclude Pending Purchase OrdersBooleanYes
IncludePurchaseRequisitionInclude Purchase RequisitionBooleanYes
IsOrderGeneratedIs Order GeneratedCalculated (calculated)YesMeant to be the one-shot latch that stops an auto order being converted twice: generation and line regeneration are both refused when it is true, and the scheduled forecast sweep skips orders carrying it. In practice no code path ever sets it to true, so the guard never actually fires and order generation can be re-run against the same auto order. Judge whether a purchase order already came out of it by looking for PurchaseOrder rows whose PurchaseAutoOrderId is this record.
LastAutoOrderDateLast Auto Order DateDateThe replenish engine does need a 'since last run' boundary, but it derives it independently as the latest document date among the branch's replenish auto orders rather than reading this field.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberText, unique
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → Account
PerformOpenOrderCalculationPerform Open Order CalculationBooleanYesSwitches on the on-order netting for the minimum-stock and replenish engines: with it set, each proposal line's OpenOrderQuantity is filled from the outstanding pending quantity of existing purchase-order lines for the same partner, branch, item and SKU. The forecasting engine does not use it - it nets pending purchase orders through its own include flag instead.
PerformOrderGenerationPerform Order GenerationBooleanYesA legacy trigger boolean.
PriceAsOnDatePrice As On DateDate
PriceListIdPrice ListLookup → PriceList
RecordTypeIdRecord TypeGuid, hidden
RemarksRemarksText
ResourceIdGenerated ByLookup → Resource
StatusStatusPickListCarries a seeded draft and generated vocabulary but is never assigned by code; the only place it moves at all is when a template clone copies the template's value verbatim. The meaningful state is held in IsOrderGenerated and in whether proposal lines exist. Values: Draft, Order Generated.
SupplierAccountIdSupplier AccountLookup → Account
TotalAmountTotal AmountCalculated (calculated)
TotalPendingQuantityTotal Pending QuantityCalculated (calculated)
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 AutoOrder Lines
GenerateTemplateOrderOrder from TemplateServerAction (GenerateTemplateOrder)Generate Order from Template
NewNewNewNew
PerformOrderGenerationPurchase OrderServerAction (PerformOrderGeneration)Generate Purchase Order
SelectiveOrderGenerationSelective OrderServerAction (SelectiveOrderGeneration)Selective Order Generation

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