Production.ShopFloor.ConsumptionOrderLines Entity

Detail lines of orders for material consumption. Entity: Prd_Consumption_Order_Lines

Default Visualization

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

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

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

Aggregate Parent:
Production.ShopFloor.ConsumptionOrders
Aggregate Root:
Production.ShopFloor.ConsumptionOrders

Attributes

Name	Type	Description
ConsumedQuantity	Quantity (18, 3)	Requested quantity of the material. `Unit: ConsumedQuantityUnit` `Required` `Filter(ge;le)`
ConsumedQuantityBase	Quantity (18, 3)	The requested quantity equivalence in the base measurement category of the requested material. `Unit: Product.BaseMeasurementCategory.BaseUnit` `Required` `ReadOnly`
ConsumedStandard QuantityBase	Quantity (18, 3)	The theoretical quantity in base measurement unit according to the current measurement dimensions for the product. Used to measure the execution. null means to convert the value from Quantity using the measurement ratios. `Unit: Product.BaseMeasurementCategory.BaseUnit` `Required` `ReadOnly` `Introduced in version 18.2`
ConsumptionType	ConsumptionType	Determines whether the material cost is distributed among all produced products, or only one (specified in the Work Order Item Ingredient). `Required` `Filter(eq)` `ReadOnly`
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
LineOrd	int32	Non-unique line number within the order. `Required`
Notes	string (max) nullable	Notes for this ConsumptionOrderLine.
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.
ScheduledDateTime	datetime nullable	The scheduled date, when the material is needed. `Filter(ge;le)`

References

Name	Type	Description
ConsumedQuantityUnit	MeasurementUnits	Measurement unit of the requested quantity. `Required` `Filter(multi eq)`
ConsumptionOrder	ConsumptionOrders	The to which this ConsumptionOrderLine belongs. `Required` `Filter(multi eq)` `Owner`
Document	ConsumptionOrders	The to which this ConsumptionOrderLine belongs. `Required` `Filter(multi eq)`
Lot	Lots (nullable)	If not null, specifies that the material has to be consumed from specific lot. `Filter(multi eq)`
Product	Products	The requested material. `Required` `Filter(multi eq)`
SerialNumber	SerialNumbers (nullable)	If not null, specifies that the material has to be consumed with specific serial number. `Filter(multi eq)`
Store	Stores (nullable)	The store, from which the material is requested. `Filter(multi eq)`
StoreBin	StoreBins (nullable)	If not null, specifies that the material has to be consumed from specific store bin. `Filter(multi eq)`
WorkOrderItemIngredient	WorkOrderItemIngredients	The Work Order Item Ingredient for which we are ordering materials. `Required` `Filter(multi eq)`

Attribute Details

ConsumedQuantity

Requested quantity of the material. Unit: ConsumedQuantityUnit Required Filter(ge;le)

Type: Quantity (18, 3)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( obj.ConsumedQuantityUnit == null), null, IIF( ( obj.WorkOrderItemIngredient != null), obj.WorkOrderItemIngredient.GetSumConsumedQuantity( obj.ConsumedQuantityUnit), obj.ConsumedQuantity))

ConsumedQuantityBase

The requested quantity equivalence in the base measurement category of the requested material. Unit: Product.BaseMeasurementCategory.BaseUnit Required ReadOnly

Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
IIF( ( ( ( obj.ConsumedQuantity == null) OrElse ( obj.ConsumedQuantityUnit == null)) OrElse ( obj.Product == null)), obj.ConsumedQuantityBase, obj.ConsumedQuantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

Front-End Recalc Expressions:
IIF( ( ( ( obj.ConsumedQuantity == null) OrElse ( obj.ConsumedQuantityUnit == null)) OrElse ( obj.Product == null)), obj.ConsumedQuantityBase, obj.ConsumedQuantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

ConsumedStandardQuantityBase

The theoretical quantity in base measurement unit according to the current measurement dimensions for the product. Used to measure the execution. null means to convert the value from Quantity using the measurement ratios. Unit: Product.BaseMeasurementCategory.BaseUnit Required ReadOnly Introduced in version 18.2

Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Back-End Default Expression:
IIF( ( ( ( obj.ConsumedQuantity == null) OrElse ( obj.ConsumedQuantityUnit == null)) OrElse ( obj.Product == null)), obj.ConsumedStandardQuantityBase, obj.ConsumedQuantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

Front-End Recalc Expressions:
IIF( ( ( ( obj.ConsumedQuantity == null) OrElse ( obj.ConsumedQuantityUnit == null)) OrElse ( obj.Product == null)), obj.ConsumedStandardQuantityBase, obj.ConsumedQuantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

ConsumptionType

Determines whether the material cost is distributed among all produced products, or only one (specified in the Work Order Item Ingredient). Required Filter(eq) ReadOnly

Type: ConsumptionType
Category: System
Allowed values for the ConsumptionType(Production.ShopFloor.ConsumptionOrderLines.md#consumptiontype) data attribute
Allowed Values (Production.ShopFloor.ConsumptionOrderLinesRepository.ConsumptionType Enum Members)

Value	Description
ForSpecifiedItem	ForSpecifiedItem value. Stored as 'S'. Database Value: 'S' Model Value: 0 Domain API Value: 'ForSpecifiedItem'
ForAllItems	ForAllItems value. Stored as 'A'. Database Value: 'A' Model Value: 1 Domain API Value: 'ForAllItems'

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

Front-End Recalc Expressions:
IIF( ( ( obj.WorkOrderItemIngredient != null) AndAlso ( obj.WorkOrderItemIngredient.WorkOrderItem != null)), ForSpecifiedItem, ForAllItems)

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

LineOrd

Non-unique line number within the order. Required

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

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

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

Notes

Notes for this ConsumptionOrderLine.

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

ScheduledDateTime

The scheduled date, when the material is needed. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Reference Details

ConsumedQuantityUnit

Measurement unit of the requested quantity. Required Filter(multi eq)

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

Front-End Recalc Expressions:
obj.Product.MeasurementUnit

ConsumptionOrder

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

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

Document

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

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

Lot

If not null, specifies that the material has to be consumed from specific lot. Filter(multi eq)

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

Product

The requested material. Required Filter(multi eq)

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

Front-End Recalc Expressions:
obj.WorkOrderItemIngredient.Material

SerialNumber

If not null, specifies that the material has to be consumed with specific serial number. Filter(multi eq)

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

Store

The store, from which the material is requested. Filter(multi eq)

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

Back-End Default Expression:
obj.ConsumptionOrder.Store

Front-End Recalc Expressions:
obj.ConsumptionOrder.Store

StoreBin

If not null, specifies that the material has to be consumed from specific store bin. Filter(multi eq)

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

WorkOrderItemIngredient

The Work Order Item Ingredient for which we are ordering materials. Required Filter(multi eq)

Type: WorkOrderItemIngredients
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

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

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST