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

Allocation Line — entity reference

A reservation of real stock: one allocation line per item lot or stock record that an allocation drew from, listed in the Allocation Line grid on the fulfilment's record page (and on the sales order, service order and their lines) and numbered from the FA series. Lines are created by the Allocation actions on a fulfilment, a sales order or a service order, by Fulfilment and Auto Allocate, by Manual Allocation and by releasing back orders from a goods receipt; there is no New button. Lots are taken oldest first and lots with a hold code are skipped. Each line posts its Quantity to the stock record's Allocation bucket when it is saved (releasing SoftCommit when the order line had already soft-committed it), and recounts the allocated quantity on its fulfilment order line, sales order line or service order line. Picking, Allocation Delivery and invoicing from allocations consume the line through its pending quantities. Cancel Allocation never edits a line: it writes a cancellation row with a negative Quantity that points to the original. The line has no list of its own in any app.

Fields

FieldLabelTypeRequiredWhat it does
AllocatedByIdAllocated ByLookupNot stored, so it always reads empty.
AllocatedByResourceIdAllocated ByLookup → ResourceMeant to name who allocated, but no action fills it.
AllocatedQuantityAllocated QuantityCalculated (calculated)Quantity still reserved: Quantity less Returned Quantity, so cancellations bring it down.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DeliveredInvoicedQuantityDelivered Invoiced QuantityDecimalThe part of the invoiced quantity that was delivered before it was invoiced, totalled from the invoice lines raised from this allocation.
DeliveryQuantityDelivery QuantityDecimalQuantity delivered straight from this line by Allocation Delivery, net of returns. Deliveries through a picking line are counted in Picked Delivered Quantity instead.
DeliveryReturnQuantityDelivery Return QuantityDecimalNot written by any action; it stays 0. Delivery returns are netted inside Delivery Quantity.
DocumentDateDocument DateDate
EligibleReturnQuantityEligible Return QuantityCalculated (calculated)Quantity that can still be cancelled: Allocated Quantity less what is delivered, invoiced or still on a picking line. Selective Cancel Allocation accepts no more than this. The whole-document Cancel Allocation stops with 'A positive decimal number is expected for the field: Quantity.' when any line with allocated quantity has 0 here, so use Selective Cancel Allocation on such documents.
ExternalIdExternalText
FulfillmentNumberFulfillment NumberNumber, uniqueNot stored, so it always reads empty.
IdIdGuidYes
InventoryFulfilmentIdInventory FulfilmentLookup → InventoryFulfilmentThe fulfilment the reservation belongs to. Empty on lines allocated directly from a sales order or service order.
InventoryFulfilmentOrderLineIdFulfillment Order LineLookup → InventoryFulfilmentOrderLineThe fulfilment order line this reservation covers. One fulfilment order line often has several allocation lines, one per lot or stock record used.
InventoryLedgerIdInventory LedgerLookup → InventoryLedgerThe inventory ledger entry the line posted to the Allocation bucket. Filled when the line posts.
InventoryStockIdStockLookup → InventoryStockThe stock record a non-lot reservation is booked against.
InvoiceQuantityInvoice QuantityDecimalQuantity invoiced straight from this line, without a delivery or a pick in between.
IsClosedClosedBooleanNot written by any action. Judge whether a reservation is finished from its pending quantities.
IsILPostedIL PostedBoolean
IsILPostingApprovedIL Posting ApprovedBooleanSet by the actions that create lines, but the ledger posting does not read it: every allocation line posts when saved.
ItemIdItemLookup → Item
ItemLotIdItem LotLookup → ItemLotThe lot reserved, for a lot-tracked item; empty when the line reserves a stock record. Locked once the line has a positive quantity.
ItemLotTypeIdItem Lot TypeLookup → ItemLotTypeThe type of the reserved lot, taken from the lot.
LastModifiedByIdLastModifiedByGuid
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextAllocation line number, from the FA series of the allocation line numbering setting.
OrderIdOrderLookup → Order
OrderLineIdSale Order LineLookup → OrderLineThe sales order line the reservation answers. Allocated and cancelled quantities are counted into its Fulfilment Allocated Quantity.
OwnerIdOwnerLookup → UserAccountYes
ParentFulfillmentAllocationLineIdParent Inventory Fulfillment Allocation LineLookup → InventoryFulfilmentAllocationLineSet on a cancellation row: the allocation line whose reservation it released.
PendingDeliveryQuantityPending Delivery QuantityCalculated (calculated)Reserved quantity not yet delivered: Allocated Quantity less Delivery Quantity and Picked Delivered Quantity.
PendingInvoiceQuantityPending Invoice QuantityCalculated (calculated)Reserved quantity not yet invoiced: Allocated Quantity less all three invoiced quantities. Invoicing from allocations takes this amount.
PendingPickingQuantityPending Picking QuantityCalculated (calculated)Reserved quantity not yet on a picking line. Picking and Selective Picking take from it; at zero the line can only be delivered through Picked Delivery.
PickedDeliveredQuantityPicked Delivered QuantityNumberQuantity delivered through picking lines raised from this line.
PickedInvoiceQuantityPicked Invoice QuantityNumberThe part of the invoiced quantity that was picked before it was invoiced.
PickedQuantityPicked QuantityDecimalTotal quantity on this line's picking lines, net of cancelled picks.
PickingCancelQuantityPicking Cancel QuantityNumberQuantity cancelled on this line's picking lines; it is added back to Pending Picking Quantity.
PickingRequestedQuantityPicking Requested QuantityNumberTotal requested quantity on this line's picking lines.
PickingReturnQuantityPicking Return QuantityNumberQuantity returned to this reservation by cancelled picks; it is added back to Pending Picking Quantity.
QuantityQuantityNumberThe quantity reserved and posted to the Allocation bucket. Negative on a cancellation row. Editing it re-posts the ledger and recounts the order counters without checking what is already picked or delivered, so correct a reservation by cancelling and allocating again.
RecordTypeIdRecord TypeGuid, hidden
RequestedQuantityRequested QuantityNumberNot stored: the quantity entered for this line in a selective picking, delivery or cancel action.
ReturnedQuantityReturned QuantityNumberQuantity released by cancellation rows that point to this line.
ServiceOrderIdService OrderLookup → ServiceOrderThe service order, on lines allocated for a service order.
ServiceOrderLineIdService Order LineLookup → ServiceOrderLineThe service order line the reservation answers; its Allocated Quantity is the total of these lines.
SKUIdSKULookup → SKUThe SKU reserved, matched exactly by allocation. Locked once the line has a positive quantity.
SoftCommittedQuantitySoft Committed QuantityCalculated (calculated)Equals Quantity when the line answers a sales order line or service order line, otherwise 0.
StorageLocationIdStorage LocationLookup → StorageLocationWhere the reserved goods are, taken from the lot or stock record. Picking copies it to the pick list.
UIPropsUI PropsText
UnitCostUnit CostCurrencyThe lot's unit cost for a lot reservation. For a stock-record reservation it is the order line's Unit Price, a selling price rather than a cost.
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDelete, inactiveDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteBlocked once the line has a non-zero quantity — reservations are reversed with CancelAllocation on the fulfilment, which writes a negative line, rather than deleted.
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditInLineEditEditInlineEdit
EditListRowEditEditEditListRow
HeaderEditEditEditInline, inactiveHeaderEdit
NewNewNew, inactive

Validations

ValidationApplies toError messageNotes
Quantity Rule ValidationQuantity, Error, inactiveQuantity shouldn't be less than zero.Quantity shouldn't be less than zero.
Unit Cost Rule ValidationUnitCost, Error, inactiveUnit Cost can't be less than zero.Unit Cost can't be less than zero.