Crm.Pos.ExecutionStatuses Entity

Namespace: Crm.Pos

Defines user-configurable status values that describe sub-stages within a broader, system-defined execution stage (ExecutionStage). This allows businesses to model their unique operational workflows — such as food prep steps, service sessions, or treatment progress. Entity: Pos_Execution_Statuses (Introduced in version 25.1.3.45)

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault
API access: ReadWrite

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

Crm.Pos.ExecutionStatuses

Attributes

Name	Type	Description
Code	string (16)	Unique short descriptive code of the user status. Used for display constrained devices, import/export matching, etc. `Required` `Filter(eq;like)` `ORD`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExecutionStage	ExecutionStage	The system-defined stage under which is the current status. `Required` `Default("PND")`
Id	guid
IsActive	boolean	Indicates whether the POS execution status is currently active. `Required` `Default(true)` `Filter(eq)`
Name	MultilanguageString (254)	Name of the execution status. Should be action-oriented, e.g. reflect the NEXT action which should be taken (and not what is completed). For example, "Scheduled", "Ready-to-serve", etc. `Required`
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.
Ord	int32	The sort order of the status within the stage. `Required` `Filter(eq;ge;le)`

References

Name	Type	Description
EnterpriseCompany	EnterpriseCompanies (nullable)	When specified, means that the status applies only to the specified enterprise company. null means the status is applicable to all enterprise companies. `Filter(multi eq)`
Location	Locations (nullable)	When specified, means that the status applies only to the specified location. null means the status is applicable to all locations. `Filter(multi eq)`

Attribute Details

Code

Unique short descriptive code of the user status. Used for display constrained devices, import/export matching, etc. Required Filter(eq;like) ORD

Type: string (16)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
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

ExecutionStage

The system-defined stage under which is the current status. Required Default("PND")

Type: ExecutionStage
Category: System
Allowed values for the ExecutionStage(Crm.Pos.ExecutionStatuses.md#executionstage) data attribute
Allowed Values (Crm.Pos.ExecutionStatusesRepository.ExecutionStage Enum Members)

Value	Description
Pending	Pending. Stored as 'PND'. Database Value: 'PND' Model Value: 0 Domain API Value: 'Pending'
Prepare	Prepare. Stored as 'PRP'. Database Value: 'PRP' Model Value: 1 Domain API Value: 'Prepare'
Deliver	Deliver. Stored as 'DEL'. Database Value: 'DEL' Model Value: 2 Domain API Value: 'Deliver'
Finalize	Finalize. Stored as 'FIN'. Database Value: 'FIN' Model Value: 3 Domain API Value: 'Finalize'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: Pending
Show in UI: ShownByDefault

Id

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

IsActive

Indicates whether the POS execution status is currently active. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Name

Name of the execution status. Should be action-oriented, e.g. reflect the NEXT action which should be taken (and not what is completed). For example, "Scheduled", "Ready-to-serve", etc. Required

Type: MultilanguageString (254)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
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

Ord

The sort order of the status within the stage. Required Filter(eq;ge;le)

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

Reference Details

EnterpriseCompany

When specified, means that the status applies only to the specified enterprise company. null means the status is applicable to all enterprise companies. Filter(multi eq)

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

Location

When specified, means that the status applies only to the specified location. null means the status is applicable to all locations. Filter(multi eq)

Type: Locations (nullable)
Indexed: True
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: 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

Parameters

user
The user.
Type: Users
notificationClass
The notification class.
Type: string
subject
The notification subject.
Type: string

priority
The notification priority.
Type: Systems.Core.NotificationsRepository.Priority
Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

Value	Description
Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

Optional: True
Default Value: Normal

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/Crm_Pos_ExecutionStatuses?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Pos_ExecutionStatuses?$top=10

Table of Contents

Crm.Pos.ExecutionStatuses Entity

Default Visualization

Track Changes

Aggregate

Attributes

References

Attribute Details

Code

DisplayText

ExecutionStage

Id

IsActive

Name

ObjectVersion

Ord

Reference Details

EnterpriseCompany

Location

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API