| uid |
|---|
Logistics.Shipment.ShipmentOrderLines |
Namespace: Logistics.Shipment
Represents detail lines of orders for shipment of sales orders to customers. Each line orders the shipment of one product. Entity: Log_Shipment_Order_Lines
Default Display Text Format:
{LineNo}. {ShipmentOrder.DocumentNo} {ShipmentOrder.DocumentType.TypeName:T}
Default Search Members:
ShipmentOrder.DocumentNo
Category: Definitions
Show in UI: ShownByDefault
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Parent:
Logistics.Shipment.ShipmentOrders
Aggregate Root:
Logistics.Shipment.ShipmentOrders
| Name | Type | Description |
|---|---|---|
| BoxCount | int32 nullable | The count of boxes in which the goods are packaged. null means unknown. |
| CurrentBalanceBase | Quantity | The current balance of the product in the selected store and enterprise company. If lot, serial number or product variant are specified the quantity is calculated accordingly. |
| DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
| Finished | boolean | True if this shipment should prohibit further shipments for the sales order line. Required Default(false) Filter(eq) |
| GrossWeightkg | decimal (12, 3) nullable | The gross weight of the whole line in kilogramms. null means unknown. |
| GuaranteePeriodDays | int32 nullable | Guarantee period in days for the offered product. null for non-serviced products. |
| Heightm | decimal (12, 3) nullable | The height of the package in meters. null means unknown. |
| Id | guid | |
| Lengthm | decimal (12, 3) nullable | The length of the package in meters. null means unknown. |
| LineNo | int32 | Line number, unique for the shipment. Required |
| NetWeightkg | decimal (12, 3) nullable | The net weight of the entire batch of goods in kilograms. null means unknown. |
| Notes | string (max) nullable | Specific notes for this line. |
| ObjectVersion | int32 | The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking. |
| PalletNo | int32 nullable | The number of the pallet in which the goods are packaged. null means unknown. |
| ParentLineNo | int32 nullable | The number of the line within the parent document, which the current line executes. null when the current line does not execute parent line. |
| PersistLot | boolean | If checked specifies that the lot in the line cannot be changed in the sub-documents created by the current document. Required Default(false) Filter(eq) |
| Quantity | Quantity (12, 3) | The quantity to be shipped. Unit: QuantityUnit Required Default(1) |
| QuantityBase | Quantity (12, 3) | The equivalence of Quantity in the base measurement category of the product. Unit: ParentSalesOrderLine.Product.BaseMeasurementCategory.BaseUnit Required |
| StandardQuantityBase | Quantity (12, 3) | The theoretical quantity in base measurement unit according to the current measurement dimensions for the product. Used to measure the execution. Unit: ParentSalesOrderLine.Product.BaseMeasurementCategory.BaseUnit Required ReadOnly Introduced in version 18.2 |
| Volumel | decimal (12, 3) nullable | The volume in litres of the whole batch. null means unknown. |
| Widthm | decimal (12, 3) nullable | The width of the package in meters. null means unknown. |
| Name | Type | Description |
|---|---|---|
| Document | ShipmentOrders | The to which this ShipmentOrderLine belongs. Required Filter(multi eq) |
| Lot | Lots (nullable) | The store lot from which to take the goods. Filter(multi eq) |
| ParentDocument | Documents (nullable) | The document, which the current line executes. null when the current line does not execute another line. Filter(multi eq) |
| ParentSalesOrderLine | SalesOrderLines | Sales order line which is shipped. Required Filter(multi eq) |
| QuantityUnit | MeasurementUnits | The measurement unit of Quantity. Required Filter(multi eq) |
| SerialNumber | SerialNumbers (nullable) | The serial number of the shipped product. null means that serial number is unknown or not applicable. Filter(multi eq) |
| ShipmentOrder | ShipmentOrders | The to which this ShipmentOrderLine belongs. Required Filter(multi eq) Owner |
| StoreBin | StoreBins (nullable) | The store bin from which to take the goods. Filter(multi eq) |
The count of boxes in which the goods are packaged. null means unknown.
Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
The current balance of the product in the selected store and enterprise company. If lot, serial number or product variant are specified the quantity is calculated accordingly.
Type: Quantity
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
True if this shipment should prohibit further shipments for the sales order line. Required Default(false) Filter(eq)
Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: HiddenByDefault
The gross weight of the whole line in kilogramms. null means unknown.
Type: decimal (12, 3) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
Guarantee period in days for the offered product. null for non-serviced products.
Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
Front-End Recalc Expressions:
IIF( obj.ParentSalesOrderLine.Product.ProductType.IsServiced, obj.ParentSalesOrderLine.Product.GuaranteePeriodDays, null)
The height of the package in meters. null means unknown.
Type: decimal (12, 3) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
The length of the package in meters. null means unknown.
Type: decimal (12, 3) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
Line number, unique for the shipment. Required
Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault
Back-End Default Expression:
( obj.ShipmentOrder.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)
Front-End Recalc Expressions:
( obj.ShipmentOrder.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)
The net weight of the entire batch of goods in kilograms. null means unknown.
Type: decimal (12, 3) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
Specific notes for this line.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: HiddenByDefault
The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
The number of the pallet in which the goods are packaged. null means unknown.
Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
The number of the line within the parent document, which the current line executes. null when the current line does not execute parent line.
Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
If checked specifies that the lot in the line cannot be changed in the sub-documents created by the current document. Required Default(false) Filter(eq)
Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: HiddenByDefault
The quantity to be shipped. Unit: QuantityUnit Required Default(1)
Type: Quantity (12, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
Front-End Recalc Expressions:
new Quantity( obj.ParentSalesOrderLine.Quantity.Value, obj.QuantityUnit)
The equivalence of Quantity in the base measurement category of the product. Unit: ParentSalesOrderLine.Product.BaseMeasurementCategory.BaseUnit Required
Type: Quantity (12, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
Back-End Default Expression:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.QuantityBase, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))
Front-End Recalc Expressions:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.QuantityBase, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))
The theoretical quantity in base measurement unit according to the current measurement dimensions for the product. Used to measure the execution. Unit: ParentSalesOrderLine.Product.BaseMeasurementCategory.BaseUnit Required ReadOnly Introduced in version 18.2
Type: Quantity (12, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
Back-End Default Expression:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.StandardQuantityBase, IIF( obj.Product.AllowVariableMeasurementRatios, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product), obj.QuantityBase))
Front-End Recalc Expressions:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.StandardQuantityBase, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))
The volume in litres of the whole batch. null means unknown.
Type: decimal (12, 3) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
The width of the package in meters. null means unknown.
Type: decimal (12, 3) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
The to which this ShipmentOrderLine belongs. Required Filter(multi eq)
Type: ShipmentOrders
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
The store lot from which to take the goods. Filter(multi eq)
Type: Lots (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault
Front-End Recalc Expressions:
obj.ParentSalesOrderLine.Lot
The document, which the current line executes. null when the current line does not execute another line. Filter(multi eq)
Type: Documents (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault
Sales order line which is shipped. Required Filter(multi eq)
Type: SalesOrderLines
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault
The measurement unit of Quantity. Required Filter(multi eq)
Type: MeasurementUnits
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Front-End Recalc Expressions:
obj.ParentSalesOrderLine.QuantityUnit
The serial number of the shipped product. null means that serial number is unknown or not applicable. Filter(multi eq)
Type: SerialNumbers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault
The to which this ShipmentOrderLine belongs. Required Filter(multi eq) Owner
Type: ShipmentOrders
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault
The store bin from which to take the goods. Filter(multi eq)
Type: StoreBins (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault
Methods that can be invoked in public APIs.
Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET
Parameters
-
customPropertyCode
The code of the custom property
Type: string -
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null -
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False -
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False -
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10 -
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0
Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST
Parameters
-
user
The user.
Type: Users -
notificationClass
The notification class.
Type: string -
subject
The subject.
Type: string
Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST
[!list limit=1000 erp.entity=Logistics.Shipment.ShipmentOrderLines erp.type=business-rule default-text="None"]
[!list limit=1000 erp.entity=Logistics.Shipment.ShipmentOrderLines erp.type=front-end-business-rule default-text="None"]
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Logistics_Shipment_ShipmentOrderLines?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Logistics_Shipment_ShipmentOrderLines?$top=10