Crm.Pos.FiscalReceiptTemplates Entity
Namespace: Crm.Pos
Templates for customizing the printouts of fiscal receipts. Entity: Pos_Fiscal_Receipt_Templates (Introduced in version 24.1.1.50)
Default Visualization
Default Display Text Format:
{TemplateName}
Default Search Members:
TemplateName
Name Data Member:
TemplateName
Category: Settings
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 |
---|---|---|
CustomFooter | string (256) nullable | User-defined footer printed at the end of the document (interpolated string). |
CustomHeader | string (256) nullable | User-defined header printed at the beginning of the document (interpolated string). |
CustomRowFooter | string (256) nullable | User-defined footer printed after each row (interpolated string). |
CustomRowHeader | string (256) nullable | User-defined header printed before each row (interpolated string). |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
Id | guid | |
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. |
PrintSystemHeader | boolean | Denotes whether to print the system-defined header for the document. Required Default(true) Filter(eq) |
PrintSystemRowHeader | boolean | Denotes whether to print the system-defined header for each row. Required Default(true) Filter(eq) |
TemplateName | string (64) | The unique name of the printing template. Required Filter(eq;like) ORD |
Attribute Details
CustomFooter
User-defined footer printed at the end of the document (interpolated string).
Type: string (256) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault
CustomHeader
User-defined header printed at the beginning of the document (interpolated string).
Type: string (256) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault
CustomRowFooter
User-defined footer printed after each row (interpolated string).
Type: string (256) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault
CustomRowHeader
User-defined header printed before each row (interpolated string).
Type: string (256) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 256
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
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown
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
PrintSystemHeader
Denotes whether to print the system-defined header for the document. Required
Default(true)
Filter(eq)
Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault
PrintSystemRowHeader
Denotes whether to print the system-defined header for each row. Required
Default(true)
Filter(eq)
Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault
TemplateName
The unique name of the printing template. Required
Filter(eq;like)
ORD
Type: string (64)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 64
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_FiscalReceiptTemplates?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Pos_FiscalReceiptTemplates?$top=10