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

Shipment Line — entity reference

One item line of an inbound shipment, carrying the quantity on its way for one item. It posts to the receiving branch's in-transit (pipeline) stock only when the shipment's Post Inventory action runs, and goods receipts released from the shipment draw on its pending quantity.

Fields

FieldLabelTypeRequiredWhat it does
AmountTotal AmountCalculated (calculated)Unit Price times Quantity.
CancelledQuantityCancelled QuantityNumberQuantity written off by Cancel Shipment or Selective Cancel Shipment. Reduces Pending Quantity but does not reverse in-transit stock that was already posted. It is also editable on the line's record page; a hand-typed value is not checked against the pending quantity and does not change stock.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DeliveryOrderLineIdDelivery Order LineLookup → DeliveryOrderLineNot filled by the delivery order's Release Shipment action, and not read by anything.
ExcludeInAutoOrderExclude In Auto OrderBooleanYesLeaves this line's pending quantity out of the in-transit supply that auto orders count. Not on the standard line forms.
ExternalIdExternalText, unique
IdIdGuidYes
InventoryLedgerIdInventory LedgerLookup → InventoryLedgerSet when Post Inventory posts the line to in-transit stock. Receiving a posted line moves the quantity from in-transit into inward stock. Must be empty when a line is created.
InvoiceLineIdInvoice LineLookup → InvoiceLineThe invoice line this line was created from; its quantity counts toward that invoice line's shipped quantity. Lines split off for the Maximum Lot Quantity do not carry it, so their quantity is not counted.
IsILPostedIL PostedBooleanYesNot used; posting is recorded in Inventory Ledger.
IsILPostingApprovedIL Posting ApprovedBooleanYesNot used by the standard screens. Must be off when a line is created; switching it on later is refused while Receipt Quantity is zero.
ItemIdItemLookup → ItemThe item on its way. Must be active when the line is created, otherwise the line is refused with "Item is Inactive." It can still be changed after saving, but changing it does not re-post an in-transit entry that was already posted.
ItemLotIdItem LotLookup → ItemLotNot allowed on shipment lines; a line with an item lot is refused. Lots are chosen on the goods receipt.
ItemLotTypeIdItem Lot TypeLookup → ItemLotTypeThe kind of lot the goods belong to. Recorded on the in-transit ledger entry, but not copied to the goods receipt line, and not carried to the extra lines created when a long line is split.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextThe line's number, set from the Shipment Line Name Setting numbering series when the line is created.
OwnerIdOwnerLookup → UserAccountYes
PendingQuantityPending QuantityCalculated (calculated)Quantity minus Receipt Quantity minus Cancelled Quantity: what release and cancel can still act on.
PurchaseOrderDatePurchase Order DateDateThe purchase order's document date, copied when the line is released from the order. Reference only.
PurchaseOrderIdPurchase OrderLookup → PurchaseOrderThe purchase order the line was released from. Set by Release Shipment on the order; shown under Related Sources on the line's record page.
PurchaseOrderLineIdPurchase Order LineLookup → PurchaseOrderLineThe purchase order line this line was released from. Carried to the goods receipt line.
QuantityQuantityDecimalYesThe quantity dispatched; must be above zero. A new line above the SKU's or item's Maximum Lot Quantity is split into lines within the cap; the extra lines carry the item, SKU, purchase order links and unit price, but not the invoice line link or lot type. Changing it on a posted line re-posts its in-transit entry.
ReceiptQuantityReceipt QuantityNumberTotal of the Supplier Quantity on goods receipt lines released from this line, recalculated whenever one of those receipt lines is added, changed or deleted. Must be empty or zero when a line is created. It is editable on the line's record page, but a hand-typed value is replaced the next time a linked receipt line changes; while it is above zero the line cannot be deleted.
RecordTypeIdRecord TypeGuid, hidden
RequestedQuantityRequested QuantityNumberNot stored. The quantity entered per line in the selective release and cancel dialogs.
ShipmentIdShipmentLookup → ShipmentYesThe shipment the line belongs to. Required; filled in automatically when the line is added from the shipment's Lines tab.
SKUIdSKULookup → SKUThe variant of the item. Required when the item requires a SKU, and must be one of the item's SKUs; the picker lists only the selected item's SKUs. Checked when the line is created.
StorageLocationIdStorage LocationLookup → StorageLocationNot allowed on shipment lines; a line with a storage location is refused. Bins are chosen on the goods receipt.
UIPropsUI PropsText
UnitPriceUnit PriceCurrencyPrice per unit; must be above zero when entered. Becomes the unit cost of the goods receipt line.
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