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

Shipment Line — entity reference

One item line of a Shipment, carrying the in-transit quantity for a single item. Its one seeded ledger rule adds Quantity minus CancelledQuantity to the InventoryStock Pipeline bucket when the shipment is posted - not when the line is created - and stamps InventoryLedgerId, which is exactly what the goods-receipt ledger rules test to decide whether receiving converts pipeline stock or adds fresh inward stock. PendingQuantity is calculated as Quantity minus ReceiptQuantity minus CancelledQuantity and is the gate the release-receipt and cancel actions check. Unlike a delivery order line it may not carry lot or storage-location detail: the handler rejects a non-empty ItemLotId or StorageLocationId outright, so lot assignment happens at goods receipt instead.

Fields

FieldLabelTypeRequiredWhat it does
AmountTotal AmountCalculated (calculated)
CancelledQuantityCancelled QuantityNumberQuantity written off by the cancel-shipment actions - goods that were dispatched but will never be received. It reduces PendingQuantity and is subtracted from the quantity posted to Pipeline, but only on the next posting pass, since a cancellation alone does not re-post the line.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DeliveryOrderLineIdDelivery Order LineLookup → DeliveryOrderLineA lookup back to the delivery order line that caused this shipment line.
ExcludeInAutoOrderExclude In Auto OrderBooleanYesOpts this in-transit line out of the automatic replenishment calculation. Auto-ordering counts shipment lines with pending quantity as incoming supply, so setting this makes the planner ignore the line and potentially reorder the same goods.
ExternalIdExternalText, unique
IdIdGuidYes
InventoryLedgerIdInventory LedgerLookup → InventoryLedgerStamped when the line posts its quantity into the Pipeline bucket. Downstream it is a discriminator rather than mere provenance: the goods-receipt ledger rules test whether the source shipment line has one to choose between converting pipeline stock and adding fresh inward stock. It is a system field and cannot be set by hand.
InvoiceLineIdInvoice LineLookup → InvoiceLine
IsILPostedIL PostedBooleanYesA per-line inventory-posted flag that no code writes; InventoryLedgerId is the marker that actually records posting. It is nonetheless treated as a system field, so it cannot be set on insert.
IsILPostingApprovedIL Posting ApprovedBooleanYesAn approval gate for posting this line. The service that would set it in bulk is never called, but the handler does enforce a rule when it is switched to true on an update: the line is checked as postable against its ReceiptQuantity.
ItemIdItemLookup → Item
ItemLotIdItem LotLookup → ItemLotNot usable on this entity: the handler rejects any shipment line with a lot set, with 'Storage Location and Item Lot is not supported for Shipment Lines'. Lot assignment happens at goods receipt, on the receipt line, not while the goods are in transit.
ItemLotTypeIdItem Lot TypeLookup → ItemLotType
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberText
OwnerIdOwnerLookup → UserAccountYes
PendingQuantityPending QuantityCalculated (calculated)Calculated as Quantity minus ReceiptQuantity minus CancelledQuantity: how much of the dispatched line is neither received nor written off. Both the release-receipt and cancel actions refuse to run unless at least one line still has some, and the selective variants cap each requested quantity against it.
PurchaseOrderDatePurchase Order DateDate
PurchaseOrderIdPurchase OrderLookup → PurchaseOrder
PurchaseOrderLineIdPurchase Order LineLookup → PurchaseOrderLine
QuantityQuantityDecimalYesThe quantity dispatched on this line. Posting adds Quantity minus CancelledQuantity to the Pipeline bucket, and editing Quantity (or UnitPrice) is what re-posts the line's ledger movement - changing other fields does not.
ReceiptQuantityReceipt QuantityNumberA live roll-up of GoodsReceiptLine.SupplierQuantity over the receipt lines pointing at this shipment line, reconciled for added, edited and deleted receipt lines alike. It is a system field: it cannot be edited directly, and a line with a non-zero value cannot be deleted.
RecordTypeIdRecord TypeGuid, hidden
RequestedQuantityRequested QuantityNumberA virtual, non-stored argument field: the selective release-receipt and selective cancel actions pass a per-line quantity through it, validated against PendingQuantity. It is never persisted and means nothing when read back from a saved row.
ShipmentIdShipmentLookup → ShipmentYes
SKUIdSKULookup → SKU
StorageLocationIdStorage LocationLookup → StorageLocationNot usable on this entity: the handler rejects any shipment line that carries a storage location, for the same reason it rejects a lot - in-transit stock has not reached a bin yet. The destination bin is chosen on the goods receipt.
UIPropsUI PropsText
UnitPriceUnit PriceCurrency
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditInLineEditEditInlineEdit
EditInListEditEditInlineEdit
HeaderEditHeaderEditEditInlineedit
ImportImportUIActionshipment Import
MainNewNewNewNew
NewQuick AddNewInlineNew

Validations

ValidationApplies toError messageNotes
Quantity Rule ValidationQuantity, ErrorQuantity can't be zeroPrevents zero or negative quantity on shipment lines
Unit Price Rule ValidationUnitPrice, ErrorUnit Price can't be negativePrevents zero or negative unit price on shipment lines

Lookup filters

FilterLookup fieldNotes
Sku For ItemSKUId