Crm.Pos.Terminals Entity

Namespace: Crm.Pos

Represents a POS workplace for 1 person, with all the attached devices. (Not to be confused with Payment Terminal, which is specific POS device). Entity: Pos_Terminals (Introduced in version 19.1)

Default Visualization

Default Display Text Format:
{PosTerminalName:T}
Default Search Members:
PosTerminalCode; PosTerminalName
Code Data Member:
PosTerminalCode
Name Data Member:
PosTerminalName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 2 - Track object 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.Terminals
- Crm.Pos.Devices

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	Represents whether the POS terminal is active and can be chosen from drop-downs for new records. `Required` `Default(true)` `Filter(multi 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.
PosTerminalCode	string (16)	Unique (within the location) code of the POS terminal. `Required` `Filter(eq;like)`
PosTerminalName	MultilanguageString (254)	The multi-language name of the terminal, like "Cash 1", "Self-checkout 5", etc. `Required` `Filter(multi eq;like)`

References

Name	Type	Description
DefaultFiscalPrinter PosDevice	Devices (nullable)	The POS Fiscal Device which is set by default in documents when the POS Terminal is selected. `Filter(multi eq)` `Introduced in version 20.1`
PosLocation	Locations	The POS location, where the terminal is located. `Required` `Filter(multi eq)`

Child Collections

Name	Type	Description
Devices	Devices	List of `Device`(Crm.Pos.Devices.md) child objects, based on the `Crm.Pos.Device.PosTerminal`(Crm.Pos.Devices.md#posterminal) back reference

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

Represents whether the POS terminal is active and can be chosen from drop-downs for new records. Required Default(true) Filter(multi eq)

Type: boolean
Category: System
Supported Filters: Equals, EqualsIn
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

PosTerminalCode

Unique (within the location) code of the POS terminal. Required Filter(eq;like)

Type: string (16)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

PosTerminalName

The multi-language name of the terminal, like "Cash 1", "Self-checkout 5", etc. Required Filter(multi eq;like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

DefaultFiscalPrinterPosDevice

The POS Fiscal Device which is set by default in documents when the POS Terminal is selected. Filter(multi eq) Introduced in version 20.1

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

PosLocation

The POS location, where the terminal is located. Required Filter(multi eq)

Type: Locations
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