Crm.Pos.Locations Entity
Namespace: Crm.Pos
Defines a company location as POS enabled location. Entity: Pos_Locations (Introduced in version 19.1)
Default Visualization
Default Display Text Format:
{PosLocationCode}
Default Search Members:
PosLocationCode
Code Data Member:
PosLocationCode
Category: Definitions
Show in UI: ShownByDefault
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
Attributes
Name | Type | Description |
---|---|---|
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
Id | guid | |
IsActive | boolean nullable | Indicates whether the POS location is currently active and can be chosen in drop-downs, etc. Default(true) Filter(eq) |
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. |
PosLocationCode | string (16) | Unique (with the enterprise company) code of this POS location. Required Filter(multi eq;like) |
References
Name | Type | Description |
---|---|---|
EnterpriseCompany | EnterpriseCompanies | The enterprise company of the POS location. Required Filter(multi eq) |
EnterpriseCompanyLocation | CompanyLocations | The enterprise company location of the POS location. Currently, only one POS location is allowed for each company location. Required Filter(multi eq) |
Attribute Details
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
IsActive
Indicates whether the POS location is currently active and can be chosen in drop-downs, etc. Default(true)
Filter(eq)
Type: boolean nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
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
PosLocationCode
Unique (with the enterprise company) code of this POS location. Required
Filter(multi eq;like)
Type: string (16)
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault
Reference Details
EnterpriseCompany
The enterprise company of the POS location. Required
Filter(multi eq)
Type: EnterpriseCompanies
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
EnterpriseCompanyLocation
The enterprise company location of the POS location. Currently, only one POS location is allowed for each company location. Required
Filter(multi eq)
Type: CompanyLocations
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: 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
- R29695 PosLocation - Valid Enterprise Company Location
- R29696 PosLocation - Only One Active Pos Location Per Enterprise Company Location
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Crm_Pos_Locations?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Pos_Locations?$top=10