Logistics.Wms.WarehouseOrderLines Entity

A planned task (operation) in a warehouse order. Entity: Wms_Warehouse_Order_Lines (Introduced in version 20.1)

Default Visualization

Default Display Text Format:
{LineNo}. {WarehouseOrder.DocumentNo} {WarehouseOrder.DocumentType.TypeName:T}
Default Search Members:
WarehouseOrder.DocumentNo
Category: Definitions
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Logistics.Wms.WarehouseOrders
Aggregate Root:
Logistics.Wms.WarehouseOrders

Attributes

Name	Type	Description
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.
Id	guid
LineGroupNo	int32	Line group number. Indicates which lines are part of the same group e.g. group of components of the same composite product. `Required` `Default(1)` `Filter(eq;ge;le)` `Introduced in version 23.1.0.67`
LineNo	int32	Unique consecutive line number within the order. `Required` `Filter(eq)`
Notes	string (max) nullable	Notes for this WarehouseOrderLine.
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.
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 another line. `Filter(multi eq)` `Introduced in version 22.1.4.26`
Quantity	Quantity (12, 3)	The quantity of the product, which should be processed. `Unit: QuantityUnit` `Required` `Default(0)` `Filter(eq;ge;le)`
QuantityBase	Quantity (12, 3)	Quantity in the base measurement unit of the product. `Unit: Product.BaseMeasurementCategory.BaseUnit` `Required` `Filter(multi eq;ge;le)` `Introduced in version 22.1.4.41`
StandardQuantity	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: Product.BaseMeasurementCategory.BaseUnit` `Required` `Introduced in version 22.1.4.42`
TaskType	TaskType	The type of the task (operation), which should be performed. REC=Receive; DIS=Dispatch; MOV=Move; LBL=Label; INS=Inspect; PCK=Pack; UPK=Unpack; KIT=Kit; DKT=Dekit; CNT=Count; TSK=User task; CDP=Component dispatch; CRC=Component receive; ASM=Assemble; DSM=Disassemble. `Required` `Filter(multi eq)`

References

Name	Type	Description
Document	WarehouseOrders	The to which this WarehouseOrderLine belongs. `Required` `Filter(multi eq)`
LogisticUnit	LogisticUnits (nullable)	Logistic unit, which should be used in the operation. `Filter(multi eq)` `Introduced in version 21.1.1.18`
Lot	Lots (nullable)	The lot of the product, which should be used. null for operations, which are not lot-specific, or when any lot can be used. `Filter(multi eq)`
ParentDocument	WarehouseRequisitions (nullable)	The document, which the current line executes. null when the current line does not execute another line. `Filter(multi eq)` `Introduced in version 22.1.4.26`
Product	Products (nullable)	The product, which should be used for the operation. `Filter(multi eq)`
ProductVariant	ProductVariants (nullable)	The product variant, which should be used. `Filter(multi eq)` `Introduced in version 21.1.1.18`
QuantityUnit	MeasurementUnits (nullable)	The measurement unit of Quantity. null for operations, which are not quantity-related. `Filter(multi eq)`
SerialNumber	SerialNumbers (nullable)	The serial number of the product, which should be used. null for operations, which are not serial number-specific, or when any serial number can be used. `Filter(multi eq)`
ToWarehouseLocation	WarehouseLocations (nullable)	Destination warehouse location. null for operations, which do not specify destination location. `Filter(multi eq)`
WarehouseLocation	WarehouseLocations (nullable)	Location, where the opeartion should be performed. null for operations, which do not require location. `Filter(multi eq)`
WarehouseOrder	WarehouseOrders	The to which this WarehouseOrderLine belongs. `Required` `Filter(multi eq)` `Owner`
WarehouseWorker	WarehouseWorkers (nullable)	Human or robot worker, which should execute the operation. null means that the line is shared among all workers, assigned to the order. `Filter(multi eq)`
WarehouseZone	WarehouseZones (nullable)	The warehouse zone, in which the operation should be performed. null for operations which do not require specific zone. `Filter(multi eq)`

Attribute Details

CurrentBalanceBase

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

DisplayText

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

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

LineGroupNo

Line group number. Indicates which lines are part of the same group e.g. group of components of the same composite product. Required Default(1) Filter(eq;ge;le) Introduced in version 23.1.0.67

Type: int32
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: 1
Show in UI: HiddenByDefault

LineNo

Unique consecutive line number within the order. Required Filter(eq)

Type: int32
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.WarehouseOrder.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
( obj.WarehouseOrder.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

Notes

Notes for this WarehouseOrderLine.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: HiddenByDefault

ObjectVersion

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

ParentLineNo

The number of the line within the parent document, which the current line executes. null when the current line does not execute another line. Filter(multi eq) Introduced in version 22.1.4.26

Type: int32 nullable
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: HiddenByDefault

Quantity

The quantity of the product, which should be processed. Unit: QuantityUnit Required Default(0) Filter(eq;ge;le)

Type: Quantity (12, 3)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

QuantityBase

Quantity in the base measurement unit of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required Filter(multi eq;ge;le) Introduced in version 22.1.4.41

Type: Quantity (12, 3)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
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))

StandardQuantity

The theoretical quantity in base measurement unit according to the current measurement dimensions for the product. Used to measure the execution. Unit: Product.BaseMeasurementCategory.BaseUnit Required Introduced in version 22.1.4.42

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.StandardQuantity, 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.StandardQuantity, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

TaskType

The type of the task (operation), which should be performed. REC=Receive; DIS=Dispatch; MOV=Move; LBL=Label; INS=Inspect; PCK=Pack; UPK=Unpack; KIT=Kit; DKT=Dekit; CNT=Count; TSK=User task; CDP=Component dispatch; CRC=Component receive; ASM=Assemble; DSM=Disassemble. Required Filter(multi eq)

Type: TaskType
Category: System
Allowed values for the TaskType(Logistics.Wms.WarehouseOrderLines.md#tasktype) data attribute
Allowed Values (Logistics.Wms.WarehouseOrderLinesRepository.TaskType Enum Members)

Value	Description
Receive	Receive value. Stored as 'REC'. Database Value: 'REC' Model Value: 0 Domain API Value: 'Receive'
Dispatch	Dispatch value. Stored as 'DIS'. Database Value: 'DIS' Model Value: 1 Domain API Value: 'Dispatch'
Move	Move value. Stored as 'MOV'. Database Value: 'MOV' Model Value: 2 Domain API Value: 'Move'
Label	Label value. Stored as 'LBL'. Database Value: 'LBL' Model Value: 3 Domain API Value: 'Label'
Inspect	Inspect value. Stored as 'INS'. Database Value: 'INS' Model Value: 4 Domain API Value: 'Inspect'
Pack	Pack value. Stored as 'PCK'. Database Value: 'PCK' Model Value: 5 Domain API Value: 'Pack'
Unpack	Unpack value. Stored as 'UPK'. Database Value: 'UPK' Model Value: 6 Domain API Value: 'Unpack'
Kit	Kit value. Stored as 'KIT'. Database Value: 'KIT' Model Value: 7 Domain API Value: 'Kit'
Dekit	Dekit value. Stored as 'DKT'. Database Value: 'DKT' Model Value: 8 Domain API Value: 'Dekit'
Count	Count value. Stored as 'CNT'. Database Value: 'CNT' Model Value: 9 Domain API Value: 'Count'
UserTask	UserTask value. Stored as 'TSK'. Database Value: 'TSK' Model Value: 10 Domain API Value: 'UserTask'
ComponentDispatch	ComponentDispatch value. Stored as 'CDP'. Database Value: 'CDP' Model Value: 11 Domain API Value: 'ComponentDispatch'
ComponentReceive	ComponentReceive value. Stored as 'CRC'. Database Value: 'CRC' Model Value: 12 Domain API Value: 'ComponentReceive'
Assemble	Assemble value. Stored as 'ASM'. Database Value: 'ASM' Model Value: 13 Domain API Value: 'Assemble'
Disassemble	Disassemble value. Stored as 'DSM'. Database Value: 'DSM' Model Value: 14 Domain API Value: 'Disassemble'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: HiddenByDefault

Reference Details

Document

The to which this WarehouseOrderLine belongs. Required Filter(multi eq)

Type: WarehouseOrders
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

LogisticUnit

Logistic unit, which should be used in the operation. Filter(multi eq) Introduced in version 21.1.1.18

Type: LogisticUnits (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Lot

The lot of the product, which should be used. null for operations, which are not lot-specific, or when any lot can be used. Filter(multi eq)

Type: Lots (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

ParentDocument

The document, which the current line executes. null when the current line does not execute another line. Filter(multi eq) Introduced in version 22.1.4.26

Type: WarehouseRequisitions (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Product

The product, which should be used for the operation. Filter(multi eq)

Type: Products (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ProductVariant

The product variant, which should be used. Filter(multi eq) Introduced in version 21.1.1.18

Type: ProductVariants (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

QuantityUnit

The measurement unit of Quantity. null for operations, which are not quantity-related. Filter(multi eq)

Type: MeasurementUnits (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Front-End Recalc Expressions:
obj.Product.MeasurementUnit

SerialNumber

The serial number of the product, which should be used. null for operations, which are not serial number-specific, or when any serial number can be used. Filter(multi eq)

Type: SerialNumbers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

ToWarehouseLocation

Destination warehouse location. null for operations, which do not specify destination location. Filter(multi eq)

Type: WarehouseLocations (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

WarehouseLocation

Location, where the opeartion should be performed. null for operations, which do not require location. Filter(multi eq)

Type: WarehouseLocations (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

WarehouseOrder

The to which this WarehouseOrderLine belongs. Required Filter(multi eq) Owner

Type: WarehouseOrders
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

WarehouseWorker

Human or robot worker, which should execute the operation. null means that the line is shared among all workers, assigned to the order. Filter(multi eq)

Type: WarehouseWorkers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.WarehouseOrder.WarehouseWorker

Front-End Recalc Expressions:
obj.WarehouseOrder.WarehouseWorker

WarehouseZone

The warehouse zone, in which the operation should be performed. null for operations which do not require specific zone. Filter(multi eq)

Type: WarehouseZones (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
IIF( ( obj.WarehouseLocation != null), obj.WarehouseLocation.WarehouseZone, obj.WarehouseZone)

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

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

CreateNotification

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST