Crm.DiscountTypes Entity

Namespace: Crm

Contains the different types of discounts, which can be applied to sales lines. Different types of discounts can be combined for a single sales line. Entity: Crm_Discount_Types

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Settings
Show in UI: CannotBeShown

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 Tree

Crm.DiscountTypes

Attributes

Name	Type	Description
ActionType	ActionType	Specifies the way the discount is applied over the previous discounts. `Required` `Default("A")` `Filter(multi eq)`
CalculationMethod	CalculationMethod	Specifies whether the calculation method of the discount is based on a standard discount, promotional package, bonus program, etc. `Required` `Filter(multi eq)`
Code	string (32)	The unique code of the DiscountType. `Required` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsSystem	boolean	Specifies whether this discount type is created and managed by the system. `Required` `Default(false)` `Filter(multi eq)`
Name	string (254)	The name of this DiscountType. `Required` `Filter(like)`
Notes	string (max) nullable	Notes for this DiscountType.
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.
Ord	int32	Determines the order in which the discounts are applied. The discounts with smaller Ord are applied first. `Required` `Default(1)` `Filter(ge;le)`

Attribute Details

ActionType

Specifies the way the discount is applied over the previous discounts. Required Default("A") Filter(multi eq)

Type: ActionType
Category: System
Allowed values for the ActionType(Crm.DiscountTypes.md#actiontype) data attribute
Allowed Values (Crm.DiscountTypesRepository.ActionType Enum Members)

Value	Description
Add	Add value. Stored as 'A'. Database Value: 'A' Model Value: 0 Domain API Value: 'Add'
Replace	Replace value. Stored as 'R'. Database Value: 'R' Model Value: 1 Domain API Value: 'Replace'
MarkDown	MarkDown value. Stored as 'M'. Database Value: 'M' Model Value: 2 Domain API Value: 'MarkDown'

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

CalculationMethod

Specifies whether the calculation method of the discount is based on a standard discount, promotional package, bonus program, etc. Required Filter(multi eq)

Type: CalculationMethod
Category: System
Allowed values for the CalculationMethod(Crm.DiscountTypes.md#calculationmethod) data attribute
Allowed Values (Crm.DiscountTypesRepository.CalculationMethod Enum Members)

Value	Description
StandardDiscount	StandardDiscount value. Stored as 'S'. Database Value: 'S' Model Value: 0 Domain API Value: 'StandardDiscount'
PromotionalPackage	PromotionalPackage value. Stored as 'P'. Database Value: 'P' Model Value: 1 Domain API Value: 'PromotionalPackage'
BonusProgram	BonusProgram value. Stored as 'B'. Database Value: 'B' Model Value: 2 Domain API Value: 'BonusProgram'

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

Code

The unique code of the DiscountType. Required Filter(eq)

Type: string (32)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 32
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: ShownByDefault

IsSystem

Specifies whether this discount type is created and managed by the system. Required Default(false) Filter(multi eq)

Type: boolean
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Name

The name of this DiscountType. Required Filter(like)

Type: string (254)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Notes

Notes for this DiscountType.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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

Ord

Determines the order in which the discounts are applied. The discounts with smaller Ord are applied first. Required Default(1) Filter(ge;le)

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