Skip to content

Latest commit

 

History

History
238 lines (169 loc) · 8.49 KB

Crm.Pricing.PricingModelCosts.md

File metadata and controls

238 lines (169 loc) · 8.49 KB
uid
Crm.Pricing.PricingModelCosts

Crm.Pricing.PricingModelCosts Entity

Namespace: Crm.Pricing

List of costs, associated with a pricing model. Entity: Crm_Pricing_Model_Costs

Default Visualization

Default Display Text Format:
{PricingModel.Name}
Default Search Members:
PricingModel.Name
Name Data Member:
PricingModel.Name
Category: Definitions
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Crm.Pricing.PricingModels
Aggregate Root:
Crm.Pricing.PricingModels

Attributes

Name Type Description
AmountPercent decimal (6, 5) nullable Used when the cost is calculated as percent of the amount. null when the cost is calculated in a different way.
AmountPerUnit Amount (9, 2) nullable Used when the cost is calculated as amount per unit of the product. The unit is defined in Measurement_Unit_Id. null when the cost is calculated in a different way. Currency: PricingModel.Currency
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
LineNo int32 The consequtive number of the cost within the pricing model. 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.

References

Name Type Description
CostType CostTypes The cost type, which is listed for the pricing model. Required Filter(multi eq)
MeasurementUnit MeasurementUnits (nullable) The measurement unit for which the Amount_Per_Unit is defined. null when the cost is calculated in a different way. Filter(multi eq)
PricingModel PricingModels Pricing model, for which the cost is defined. Required Filter(multi eq) Owner

Attribute Details

AmountPercent

Used when the cost is calculated as percent of the amount. null when the cost is calculated in a different way.

Type: decimal (6, 5) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

AmountPerUnit

Used when the cost is calculated as amount per unit of the product. The unit is defined in Measurement_Unit_Id. null when the cost is calculated in a different way. Currency: PricingModel.Currency

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

LineNo

The consequtive number of the cost within the pricing model. Required

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

Back-End Default Expression:
( obj.PricingModel.Costs.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.PricingModel.Costs.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

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 Details

CostType

The cost type, which is listed for the pricing model. Required Filter(multi eq)

Type: CostTypes
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

MeasurementUnit

The measurement unit for which the Amount_Per_Unit is defined. null when the cost is calculated in a different way. Filter(multi eq)

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

PricingModel

Pricing model, for which the cost is defined. Required Filter(multi eq) Owner

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

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: Users

  • notificationClass
    The notification class.
    Type: string

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

[!list limit=1000 erp.entity=Crm.Pricing.PricingModelCosts erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Crm.Pricing.PricingModelCosts erp.type=front-end-business-rule default-text="None"]

API

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

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