Crm.Sales.SalesOrdersOptions Entity

Namespace: Crm.Sales

Options for sales orders of specific user defined document type. Entity: Crm_Sales_Orders_Options

Default Visualization

Default Display Text Format:
{DocumentType.EntityName}
Default Search Members:
DocumentType.EntityName
Name Data Member:
DocumentType.EntityName
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.DocumentTypes
Aggregate Root:
Systems.Documents.DocumentTypes

Attributes

Name	Type	Description
AllowedDirections	AllowedDirections	Allowed directions (return or normal sale) for the sales orders of this document type. 'S' = Normal sale, 'R' = Sales return, '*' = No limit, 'A' = Allow any, but not both (default). `Required` `Default("A")` `Filter(multi eq)`
AvailableQuantityOnly	boolean	When true indicates that the sales order can be released only if there is sufficient available quantity (by ATP). `Required` `Default(false)` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
MinimumAmount	Amount (14, 2) nullable	When not null, specifies minimal total amount of the sales order, which is required for order releasing. `Currency: MinimumAmountCurrency`
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.
ShipmentAllowance	ShipmentAllowance	Terms on which the shipment of the products in the sales order is allowed. `Required` `Default("A")`

References

Name	Type	Description
DealDocumentType	DocumentTypes (nullable)	If filled then new opportunities (deals) from the specified type are created automatically by the sales orders that aren't assigned to existing opportunities. `Filter(multi eq)`
DocumentType	DocumentTypes	The document type for which the sales order option applies. `Required` `Filter(multi eq)` `Owner`
MinimumAmountCurrency	Currencies (nullable)	The currency of Minimal Amount. `Filter(multi eq)`
VATDeviationDocument AmountType	DocumentAmountTypes (nullable)	Document amount that contains the difference between the total amount of the sales order formed by unit prices with VAT and the amount formed by unit prices without VAT. `Filter(multi eq)`

Attribute Details

AllowedDirections

Allowed directions (return or normal sale) for the sales orders of this document type. 'S' = Normal sale, 'R' = Sales return, '*' = No limit, 'A' = Allow any, but not both (default). Required Default("A") Filter(multi eq)

Type: AllowedDirections
Category: System
Allowed values for the AllowedDirections(Crm.Sales.SalesOrdersOptions.md#alloweddirections) data attribute
Allowed Values (Crm.Sales.SalesOrdersOptionsRepository.AllowedDirections Enum Members)

Value	Description
NormalSale	NormalSale value. Stored as 'S'. Database Value: 'S' Model Value: 0 Domain API Value: 'NormalSale'
SalesReturn	SalesReturn value. Stored as 'R'. Database Value: 'R' Model Value: 1 Domain API Value: 'SalesReturn'
NoLimit	NoLimit value. Stored as ''. Database Value: '' Model Value: 2 Domain API Value: 'NoLimit'
AllowAnyButNotBoth	AllowAnyButNotBoth value. Stored as 'A'. Database Value: 'A' Model Value: 3 Domain API Value: 'AllowAnyButNotBoth'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: AllowAnyButNotBoth
Show in UI: ShownByDefault

AvailableQuantityOnly

When true indicates that the sales order can be released only if there is sufficient available quantity (by ATP). Required Default(false) Filter(eq)

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

MinimumAmount

When not null, specifies minimal total amount of the sales order, which is required for order releasing. Currency: MinimumAmountCurrency

Type: Amount (14, 2) nullable
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

ShipmentAllowance

Terms on which the shipment of the products in the sales order is allowed. Required Default("A")

Type: ShipmentAllowance
Category: System
Allowed values for the ShipmentAllowance(Crm.Sales.SalesOrdersOptions.md#shipmentallowance) data attribute
Allowed Values (Crm.Sales.SalesOrdersOptionsRepository.ShipmentAllowance Enum Members)

Value	Description
AlwaysAllow	AlwaysAllow value. Stored as 'A'. Database Value: 'A' Model Value: 0 Domain API Value: 'AlwaysAllow'
WaitForAnyPayment	WaitForAnyPayment value. Stored as 'P'. Database Value: 'P' Model Value: 1 Domain API Value: 'WaitForAnyPayment'
WaitForFullPayment	WaitForFullPayment value. Stored as 'W'. Database Value: 'W' Model Value: 2 Domain API Value: 'WaitForFullPayment'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: AlwaysAllow
Show in UI: ShownByDefault

Reference Details

DealDocumentType

If filled then new opportunities (deals) from the specified type are created automatically by the sales orders that aren't assigned to existing opportunities. Filter(multi eq)

Type: DocumentTypes (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

DocumentType

The document type for which the sales order option applies. Required Filter(multi eq) Owner

Type: DocumentTypes
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

MinimumAmountCurrency

The currency of Minimal Amount. Filter(multi eq)

Type: Currencies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

VATDeviationDocumentAmountType

Document amount that contains the difference between the total amount of the sales order formed by unit prices with VAT and the amount formed by unit prices without VAT. Filter(multi eq)

Type: DocumentAmountTypes (nullable)
Category: System
Supported Filters: Equals, EqualsIn
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