Crm.Pos.Devices Entity
Namespace: Crm.Pos
Represents one POS device, attached to a POS terminal. Entity: Pos_Devices (Introduced in version 19.1)
Default Visualization
Default Display Text Format:
{PosTerminal.PosTerminalName:T}
Default Search Members:
PosTerminal.PosTerminalName
Name Data Member:
PosTerminal.PosTerminalName
Category: Definitions
Show in UI: ShownByDefault
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Parent:
Crm.Pos.Terminals
Aggregate Root:
Crm.Pos.Terminals
Attributes
| Name | Type | Description |
|---|---|---|
| DeviceRegistrationNo | string (32) nullable | The unique registration number of the device, assigned by the manufacturer. null means the number is unknown or N/A. Filter(multi eq;like) |
| DeviceType | DeviceType | Type of the POS device. PAY=Payment Terminal; CSH=Cash Drawer; FIP=Fiscal Printer; OTH=Other. Required Default("OTH") Filter(multi eq) |
| DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
| ElectronicAddress | string (254) nullable | The absolute address (Internet or other) which can be used for electronic communication with the device. The address should contain communication protocol/type, colon, space, then the actual address. Addresses, which are local to a specific computer, should also include the computer name. For example: "COM: PC_WORK1:COM1", "HTTP: https://<addr>", etc. Filter(multi eq;like) |
| Id | guid | |
| IsActive | boolean | Indicates whether the device is currently active and can be choosen from drop-downs in 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. |
| ProtocolName | ProtocolName nullable | The name of the protocol, which can be used to communicate with the device. null means that the protocol is unknown and programmatic communication with the device would not be performed. |
| SettingsJson | string (max) nullable | Settings and operator access codes for the POS device. The data is stored as Json, encrypted for the current application server instance. null means that there are no settings for this device. |
References
| Name | Type | Description |
|---|---|---|
| PosTerminal | Terminals | The POS terminal, to which this device is attached. Required Filter(multi eq) Owner |
Attribute Details
DeviceRegistrationNo
The unique registration number of the device, assigned by the manufacturer. null means the number is unknown or N/A. Filter(multi eq;like)
Type: string (32) nullable
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 32
Show in UI: ShownByDefault
DeviceType
Type of the POS device. PAY=Payment Terminal; CSH=Cash Drawer; FIP=Fiscal Printer; OTH=Other. Required Default("OTH") Filter(multi eq)
Type: DeviceType
Category: System
Allowed values for the DeviceType(Crm.Pos.Devices.md#devicetype) data attribute
Allowed Values (Crm.Pos.DevicesRepository.DeviceType Enum Members)
| Value | Description |
|---|---|
| PaymentTerminal | PaymentTerminal value. Stored as 'PAY'. Database Value: 'PAY' Model Value: 0 Domain API Value: 'PaymentTerminal' |
| CashDrawer | CashDrawer value. Stored as 'CSH'. Database Value: 'CSH' Model Value: 1 Domain API Value: 'CashDrawer' |
| FiscalPrinter | FiscalPrinter value. Stored as 'FIP'. Database Value: 'FIP' Model Value: 2 Domain API Value: 'FiscalPrinter' |
| Other | Other value. Stored as 'OTH'. Database Value: 'OTH' Model Value: 3 Domain API Value: 'Other' |
Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: Other
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
ElectronicAddress
The absolute address (Internet or other) which can be used for electronic communication with the device. The address should contain communication protocol/type, colon, space, then the actual address. Addresses, which are local to a specific computer, should also include the computer name. For example: "COM: PC_WORK1:COM1", "HTTP: https://<addr>", etc. Filter(multi eq;like)
Type: string (254) nullable
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 254
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 device is currently active and can be choosen from drop-downs in 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
ProtocolName
The name of the protocol, which can be used to communicate with the device. null means that the protocol is unknown and programmatic communication with the device would not be performed.
Type: ProtocolName nullable
Category: System
Allowed values for the ProtocolName(Crm.Pos.Devices.md#protocolname) data attribute
Allowed Values (Crm.Pos.DevicesRepository.ProtocolName Enum Members)
| Value | Description |
|---|---|
| ERPNETFP | ErpNet.FP. Stored as 'ERPNET_FP'. Database Value: 'ERPNET_FP' Model Value: 0 Domain API Value: 'ERPNETFP' |
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault
SettingsJson
Settings and operator access codes for the POS device. The data is stored as Json, encrypted for the current application server instance. null means that there are no settings for this device.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
Reference Details
PosTerminal
The POS terminal, to which this device is attached. Required Filter(multi eq) Owner
Type: Terminals
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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
Creates a notification and sends 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 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/Crm_Pos_Devices?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Pos_Devices?$top=10