Crm.Pos.Sequences Entity
Namespace: Crm.Pos
Stores the last issued fiscal sales number for each POS device. Entity: Pos_Sequences (Introduced in version 19.1)
Default Visualization
Default Display Text Format:
{Id}: {PosDeviceId}
Default Search Members:
__
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
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 | Indicates whether this sequence is active. Required Default(true) Filter(multi eq) |
MaxNo | string (16) nullable | Specifies the maximum number allowed in the sequence. null means that the sequence will grow unlimited. Filter(multi eq;ge;le) |
NextNo | string (16) | The next consecutive number which will be assigned on the next request. Required Filter(multi eq;ge;le) |
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. |
References
Name | Type | Description |
---|---|---|
PosDevice | Devices | The POS device, for which the sequence is defined. 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 this sequence is active. 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
MaxNo
Specifies the maximum number allowed in the sequence. null means that the sequence will grow unlimited. Filter(multi eq;ge;le)
Type: string (16) nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault
NextNo
The next consecutive number which will be assigned on the next request. Required
Filter(multi eq;ge;le)
Type: string (16)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Maximum Length: 16
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
Reference Details
PosDevice
The POS device, for which the sequence is defined. Required
Filter(multi eq)
Type: Devices
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown
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
- R29681 PosSequence - Only One Pos Sequence Per Pos Device
- R29685 PosSequence - Next No Cannot Be Changed
- R29688 PosSequence - Pos Device Cannot Be Changed
- R29689 PosSequence - Max No Greater Than Next No
- R29690 PosSequence - Next No Requirements For Fiscal Printers
- R29692 PosSequence - Max No Requirements For Fiscal Printers
- R29992 PosSequence - Deleting Is Not Allowed
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Crm_Pos_Sequences?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Pos_Sequences?$top=10