Shipment — entity reference

An inbound shipment: goods that have left the sender but have not yet reached the receiving branch. It is always the receiving side's document: Branch is the destination, Partner Account the receiving company and Supplier Account the sender. It is released from a purchase order (Release Shipment), created for a branch in the same tenant by an invoice's Create Shipment or a delivery order's Release Shipment, or entered by hand. Post Inventory adds its lines to the branch's in-transit (pipeline) stock; Release Receipt creates the goods receipt that books the arrival; Cancel Shipment and Selective Cancel Shipment write off quantity that will never arrive.

Fields

Field	Label	Type	Required	What it does
`BranchId`	Branch	Lookup → Branch		The receiving branch, whose in-transit (pipeline) stock Post Inventory fills. Required when the partner account has branches; locked after creation.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DeliveryOrderDate`	Delivery Order Date	Date		The date on the sender's delivery order, kept for reference.
`DeliveryOrderNumber`	Delivery Order Number	Text		Not stored: there is no database column behind it, so a value typed here is not kept.
`DocumentDate`	Document Date	Calculated (calculated)		The same value as Shipment Date.
`ExternalId`	External	Text
`Id`	Id	Guid	Yes
`InvoiceId`	Invoice	Lookup → Invoice		The invoice whose Create Shipment action created this shipment, when it came from a company in the same tenant.
`IsDealerShipmentCreated`	Is Dealer Shipment Created	Boolean		Ticked on shipments created from an invoice's Create Shipment action.
`IsInJobQueue`	In Job Queue	Boolean	Yes
`IsInventoryPosted`	Inventory Posted	Boolean	Yes	Not set by Post Inventory. Posting is recorded on each line instead.
`IsReceiptReleased`	Receipt Released	Boolean	Yes	Ticked by the Recieved status rule when no quantity is pending on any line. Release Receipt itself does not set it.
`JobInterfaceQueueId`	Job Queue	Lookup → InterfaceQueue
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		The company that receives the goods. Validated against Branch when the shipment is created and locked afterwards.
`PerformInventoryPosting`	Perform Inventory Posting	Boolean	Yes	Unused flag; posting is done by the Post Inventory action.
`PerformReleaseReceipt`	Perform Release Receipt	Boolean	Yes	Unused flag; receipts are released by the Release Receipt action.
`PurchaseOrderId`	Purchase Order	Lookup → PurchaseOrder		The purchase order the shipment answers, set by the order's Release Shipment action. On a hand-made shipment it is a link only and copies no lines.
`RecordTypeId`	Record Type	Guid, hidden
`ResourceId`	Executive	Lookup → Resource		The executive responsible for the shipment.
`ShipmentDate`	Shipment Date	Date		The date the goods left the sender. It is also the shipment's Document Date.
`Status`	Status	PickList		Stage shown on the stepper, set by three seeded business rules when the shipment is saved: Recieved when no line has pending quantity, Cancelled when every line is fully cancelled, Partially Cancelled when some quantity is cancelled (this rule runs last and wins). Defaults to Draft and can be moved by hand. Values: Draft, Interface, Recieved, Partially Cancelled, Cancelled.
`SupplierAccountId`	Supplier Account	Lookup → Account		The party sending the goods. Defaults from the branch's Default Supplier Account when left empty. On shipments created by a delivery order or invoice in the same tenant it is the sending company.
`SupplierInvoiceDate`	Supplier Invoice Date	Date		The date of the sender's invoice. Copied to the goods receipt.
`SupplierInvoiceNumber`	Supplier Invoice Number	Text		The sender's invoice or dispatch document number. Copied to the goods receipt; not matched automatically to a bill.
`TotalPendingQuantity`	Total Pending Quantity	Calculated (calculated)		Header total that the shipped configuration does not calculate; read the lines' Pending Quantity instead.
`TransporterName`	Transporter Name	Text		The carrier. Copied to the goods receipt.
`TransporterReferenceNo`	Transporter Reference No	Text		The carrier's consignment or docket number. Not copied to the goods receipt.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete the selected records.
`CancelShipment`	Cancel Shipment	ServerAction (`CancelShipment`)	Cancel Shipment: adds each line's pending quantity to its Cancelled Quantity. Does not reverse in-transit stock already posted.
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete in a list page
`Edit`	Edit	Edit	Edit
`EditEntity`	Edit	Edit	EditEntity
`EditInDetail`	Edit	EditInline	edit
`EditInList`	Edit	EditInline	Edit
`Import`	Import	UIAction	Import Shipment
`New`	New	New	New
`PerformInventoryPosting`	Post Inventory	ServerAction (`PerformInventoryPosting`)	Post Inventory: adds every line not yet posted to the receiving branch's in-transit (pipeline) stock at Quantity minus Cancelled Quantity and marks the line posted. Refused when every line is already posted.
`PerformReleaseReceipt`	Release Receipt	ServerAction (`PerformReleaseReceipt`)	Release Receipt: creates one goods receipt for every line with pending quantity, whichever lines are ticked in its dialog, with Supplier Quantity equal to the pending quantity and the line's unit price as unit cost.
`SelectiveCancelShipment`	Selective Cancel Shipment	ServerAction (`SelectiveCancelShipment`)	Selective Cancel Shipment: cancels the Requested Quantity on each ticked line (above zero, at most the pending quantity).
`SelectiveGRN`	Selective Release Receipt	ServerAction (`SelectiveReleaseReceipt`)	A second Selective Release Receipt entry point with the same behaviour. Not on the shipped record page.
`SelectiveReleaseReceipt`	Selective Release Receipt	ServerAction (`SelectiveReleaseReceipt`)	Selective Release Receipt: creates a goods receipt for the ticked lines only, each for its Requested Quantity (above zero, at most the pending quantity). Not on the shipped record page.

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`
Only Partner Account	`PartnerAccountId`
Only sSupplier	`SupplierAccountId`

Account — looks up via PartnerAccountId
Branch — looks up via BranchId
PurchaseOrder — looks up via PurchaseOrderId
InterfaceQueue — looks up via JobInterfaceQueueId
Resource — looks up via ResourceId
UserAccount — looks up via OwnerId
Invoice — looks up via InvoiceId
Account — looks up via SupplierAccountId
UserAccount — looks up via CreatedById
UserAccount — looks up via ModifiedById
PurchaseOrder — referenced by via PurchaseOrderShipmentId
ShipmentAssetLine — referenced by via ShipmentId
ShipmentLine — referenced by via ShipmentId
InventoryLedger — referenced by via ParentRecordId
GoodsReceipt — referenced by via ShipmentId

Shipment — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics