Crm.Pos.SalePayments Entity
Namespace: Crm.Pos
Specified only when a POS sale has multiple payments. Entity: Pos_Sale_Payments (Introduced in version 25.1.3.46)
Default Visualization
Default Display Text Format:
{PosSale.DocumentNumber}
Default Search Members:
PosSale.DocumentNumber
Name Data Member:
PosSale.DocumentNumber
Category: Documents
Show in UI: ShownByDefault
Track Changes
Min level: 0 - Do not track 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 Parent:
Crm.Pos.Sales
Aggregate Root:
Crm.Pos.Sales
Attributes
Name | Type | Description |
---|---|---|
Amount | Amount (12, 2) | Amount paid (in Amount Currency). Currency: AmountCurrency Required Filter(eq;ge;le) |
AmountBase | Amount (12, 2) | Amount in base currency. Currency: PosSale.Location.EnterpriseCompany.BaseCurrency Required Filter(eq) |
CreatedAt | datetime | Timestamp of the payment event. Required Default(Now) Filter(eq;ge;le) |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
Id | guid | |
Notes | string (128) nullable | Notes for the sale payment. Filter(like) |
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. |
Reference | string (64) nullable | Optional external reference (e.g. card transaction ID). Filter(eq;like) |
References
Name | Type | Description |
---|---|---|
AmountCurrency | Currencies | The currency of Amount. Required Filter(multi eq) |
PaymentType | PaymentTypes | The payment type (method) for this payment. Required Filter(multi eq) |
PosSale | Sales | The POS sale to which this specifies a payment. Required Filter(multi eq) Owner |
Attribute Details
Amount
Amount paid (in Amount Currency). Currency: AmountCurrency
Required
Filter(eq;ge;le)
Type: Amount (12, 2)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault
AmountBase
Amount in base currency. Currency: PosSale.Location.EnterpriseCompany.BaseCurrency
Required
Filter(eq)
Type: Amount (12, 2)
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault
CreatedAt
Timestamp of the payment event. Required
Default(Now)
Filter(eq;ge;le)
Type: datetime
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
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
Notes
Notes for the sale payment. Filter(like)
Type: string (128) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 128
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
Optional external reference (e.g. card transaction ID). Filter(eq;like)
Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault
Reference Details
AmountCurrency
The currency of Amount. Required
Filter(multi eq)
Type: Currencies
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
PaymentType
The payment type (method) for this payment. Required
Filter(multi eq)
Type: PaymentTypes
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
PosSale
The POS sale to which this specifies a payment. Required
Filter(multi eq)
Owner
Type: Sales
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
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: stringpriority
The notification priority.
Type: Systems.Core.NotificationsRepository.Priority
Allowed values for thePriority
(Systems.Core.Notifications.md#priority) data attribute
Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)Value Description Background Background value. Stored as 1.
Model Value: 1
Domain API Value: 'Background'Low Low value. Stored as 2.
Model Value: 2
Domain API Value: 'Low'Normal Normal value. Stored as 3.
Model Value: 3
Domain API Value: 'Normal'High High value. Stored as 4.
Model Value: 4
Domain API Value: 'High'Urgent Urgent value. Stored as 5.
Model Value: 5
Domain API Value: 'Urgent'Optional: True
Default Value: Normal
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_SalePayments?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Pos_SalePayments?$top=10