Logistics.Inventory.RequisitionPlan Entity
Namespace: Logistics.Inventory
The current requisition (MRP) plan. The data is deleted and re-created upon each planning. Entity: Inv_Requisition_Plan
Default Visualization
Default Display Text Format:
{Id}: {FirmPlannedOrderReceiptsValue}
Default Search Members:
__
Category: Views
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 Tree
Attributes
Name | Type | Description |
---|---|---|
CalendarDate | datetime | The date for which we are planning. A record is created for each calendar date, on which there are events (orders, executions, planned events, etc.) for the product. Past events are stored on the current date of the planning. Required Filter(ge;le) |
CompletionDate | datetime nullable | The suggested by the program value equals Calendar_Date + Planning_Lead_Time_Days of the default product supply for this store; the completion date of the purchase orders to be generated. Filter(ge;le) |
ConfirmAction | boolean | True - generate firm planned orders for the current row; false- do not generate;. Required Default(false) Filter(eq) |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
ExplanationMessage | string (max) nullable | A message that explains why the program has generated the planned orders for this row. |
FirmPlannedOrderReceipts | Quantity (18, 3) | The quantity, which is expected to be received on the calendar date. The quantity is the same as the quantity, planned in Firm Planned Order Releases, but at a different calendar date - the expected receivement date. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
FirmPlannedOrderReleases | Quantity (18, 3) | The order releases which were manually confirmed for release on the specified calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
GenerationDate | datetime | Indicates the date on which the plan is generated. Required Default(Now) Filter(ge;le) |
GrossRequirements | Quantity (18, 3) | The gross requirements of the product on the specified calendar date. This is calculated as the unexecuted quantity of issue store orders, whose expected execution date is equal to the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
Id | guid | |
NetRequirements | Quantity (18, 3) | The net requirements for the date, which are in shortage for the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
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. |
PlannedOrderReceipts | Quantity (18, 3) | The planned by the calculation process order receipts on the calendar date. This is calculated by the MRP process as the quantity, which is expected to be received on the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
PlannedOrderReleases | Quantity (18, 3) | The planned by the calculation process order releases on the specified calendar date. This is calculated by the MRP process as the quantity, which should be released for purchasing, transfer or production on the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
ProjectedAvailableBalance | Quantity (18, 3) | Expected balance of the product for the calendar date. This is a calculation, based on the current physical inventory and expected future transactions. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
Quantity | Quantity (18, 3) | The Quantity of the purchase orders the program shall generate; the suggested value equals Planned_Order_Releases but can be changed by the user;. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
ReleaseDate | datetime nullable | The suggested by the program value equals Calendar_Date; the release date of the purchase orders to be generated. Filter(ge;le) |
ScheduledReceipts | Quantity (18, 3) | The scheduled receipts of the product on the specified calendar date. This is calculated as the unexecuted quantity of released receipt store orders, whose expected execution date is equal to the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) |
References
Name | Type | Description |
---|---|---|
EnterpriseCompany | EnterpriseCompanies (nullable) | The Enterprise Company to which this RequisitionPlan applies, or null if it is for all enterprise companies. Filter(multi eq) |
FromStore | Stores (nullable) | When the order is for transfer, this is the store from which we shall transfer the product. Filter(multi eq) |
Product | Products | The product, for which we are planning. Required Filter(multi eq) |
Store | Stores | The store, which is planned. Required Filter(multi eq) |
Supplier | Suppliers (nullable) | The default supplier in the default product supply for current store, if any. Filter(multi eq) |
Attribute Details
CalendarDate
The date for which we are planning. A record is created for each calendar date, on which there are events (orders, executions, planned events, etc.) for the product. Past events are stored on the current date of the planning. Required
Filter(ge;le)
Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault
CompletionDate
The suggested by the program value equals Calendar_Date + Planning_Lead_Time_Days of the default product supply for this store; the completion date of the purchase orders to be generated. Filter(ge;le)
Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault
ConfirmAction
True - generate firm planned orders for the current row; false- do not generate;. Required
Default(false)
Filter(eq)
Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault
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
ExplanationMessage
A message that explains why the program has generated the planned orders for this row.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
FirmPlannedOrderReceipts
The quantity, which is expected to be received on the calendar date. The quantity is the same as the quantity, planned in Firm Planned Order Releases, but at a different calendar date - the expected receivement date. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
FirmPlannedOrderReleases
The order releases which were manually confirmed for release on the specified calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
GenerationDate
Indicates the date on which the plan is generated. Required
Default(Now)
Filter(ge;le)
Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: CannotBeShown
GrossRequirements
The gross requirements of the product on the specified calendar date. This is calculated as the unexecuted quantity of issue store orders, whose expected execution date is equal to the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown
NetRequirements
The net requirements for the date, which are in shortage for the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
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
PlannedOrderReceipts
The planned by the calculation process order receipts on the calendar date. This is calculated by the MRP process as the quantity, which is expected to be received on the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
PlannedOrderReleases
The planned by the calculation process order releases on the specified calendar date. This is calculated by the MRP process as the quantity, which should be released for purchasing, transfer or production on the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
ProjectedAvailableBalance
Expected balance of the product for the calendar date. This is a calculation, based on the current physical inventory and expected future transactions. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
Quantity
The Quantity of the purchase orders the program shall generate; the suggested value equals Planned_Order_Releases but can be changed by the user;. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
ReleaseDate
The suggested by the program value equals Calendar_Date; the release date of the purchase orders to be generated. Filter(ge;le)
Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault
ScheduledReceipts
The scheduled receipts of the product on the specified calendar date. This is calculated as the unexecuted quantity of released receipt store orders, whose expected execution date is equal to the calendar date. Unit: Product.BaseMeasurementCategory.BaseUnit
Required
Default(0)
Type: Quantity (18, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault
Reference Details
EnterpriseCompany
The Enterprise Company to which this RequisitionPlan applies, or null if it is for all enterprise companies. Filter(multi eq)
Type: EnterpriseCompanies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault
FromStore
When the order is for transfer, this is the store from which we shall transfer the product. Filter(multi eq)
Type: Stores (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Product
The product, for which we are planning. Required
Filter(multi eq)
Type: Products
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Store
The store, which is planned. Required
Filter(multi eq)
Type: Stores
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Supplier
The default supplier in the default product supply for current store, if any. Filter(multi eq)
Type: Suppliers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
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: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
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
Parameters
user
The user.
Type: UsersnotificationClass
The notification class.
Type: stringsubject
The notification subject.
Type: string
CreateCopy
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
Business Rules
None
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Logistics_Inventory_RequisitionPlan?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Logistics_Inventory_RequisitionPlan?$top=10