Crm.Sales.SalesOrderPaymentOrdersTemplates Entity

Namespace: Crm.Sales

Contains options for generation of payment orders. Each option set is assigned to specific generation route. Entity: Crm_Sales_Order_Payment_Orders_Templates

Default Visualization

Default Display Text Format:
{Route.ProcedureName}
Default Search Members:
Route.ProcedureName
Name Data Member:
Route.ProcedureName
Category: Definitions
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:
Systems.Documents.Routes
Aggregate Root:
Systems.Documents.DocumentTypes

Attributes

Name	Type	Description
CreateForInvoicedAmounts	boolean	True to add to the payment order, the part of the amount of the sales order, which is invoiced. Required
CreateForNotInvoiced Amounts	boolean	True to add to the payment order, the part of the amount of the sales order, which is not included in any invoice. Required
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsAmountWithVAT	boolean	True to indicate that the parent document includes VAT and the generated the payment order should be with Is Amount With VAT = 1. This setting DOES NOT affect whether the generated amount should include VAT or not, it simply sets the flag in the generated order. Required
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.
UpdateForInvoices	boolean	Update the payment order when invoices are issued for any of the sales orders lines. Required

References

Name	Type	Description
Route	Routes	The route to which the current option set is assigned. Required Filter(multi eq) Owner

Attribute Details

CreateForInvoicedAmounts

True to add to the payment order, the part of the amount of the sales order, which is invoiced. Required

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

CreateForNotInvoicedAmounts

True to add to the payment order, the part of the amount of the sales order, which is not included in any invoice. Required

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
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
Default Value: NewGuid
Show in UI: CannotBeShown

IsAmountWithVAT

True to indicate that the parent document includes VAT and the generated the payment order should be with Is Amount With VAT = 1. This setting DOES NOT affect whether the generated amount should include VAT or not, it simply sets the flag in the generated order. Required

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
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

UpdateForInvoices

Update the payment order when invoices are issued for any of the sales orders lines. Required

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

Route

The route to which the current option set is assigned. Required Filter(multi eq) Owner

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

Parameters

• user
  The user.
  Type: Users

• notificationClass
  The notification class.
  Type: string

• subject
  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

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Crm_Sales_SalesOrderPaymentOrdersTemplates?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Sales_SalesOrderPaymentOrdersTemplates?$top=10