Logistics.Procurement.PurchaseProductPrices Entity

Namespace: Logistics.Procurement

Contains purchase prices of the products. Used for automatically loading unit prices in the purchase documents. Entity: Scm_Purchase_Product_Prices

Default Visualization

Default Display Text Format:
{Price} - {FromDate}
Default Search Members:
__
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 Tree

Logistics.Procurement.PurchaseProductPrices

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate	datetime nullable	Starting date of validity of the price. `Filter(eq;ge;le)`
Id	guid
MaxQuantity	Quantity (18, 3) nullable	Maximum quantity for which this price is valid in the Price_Quantity_ Measurement_Unit. `Unit: PriceQuantityMeasurement<br />Unit` `Filter(eq)`
MinQuantity	Quantity (18, 3) nullable	Minimal quantity required to use this price (in the Price_Quantity_Measurement_Unit). `Unit: PriceQuantityMeasurement<br />Unit` `Filter(eq)`
Notes	string (254) nullable	Notes for this PurchaseProductPrice.
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.
Price	Amount (13, 5)	Price in the specified currency and for the specified quantity. `Currency: Currency` `Required` `Default(0)`
PriceQuantity	Quantity (10, 3)	The quantity of the product for which the price is specified. `Unit: PriceQuantityMeasurement<br />Unit` `Required` `Default(1)`
Priority	Priority	Priority of the price comparative to other prices. `Required` `Default(2)` `Filter(multi eq)`
ThruDate	datetime nullable	Ending date (inclusive) of the validity of the price. `Filter(eq;ge;le)`

References

Name	Type	Description
Currency	Currencies	The currency of the price. `Required` `Filter(multi eq)`
EnterpriseCompany	EnterpriseCompanies (nullable)	Determines for which enterprise company this price is used. If not specified the price is used for all enterprise companies. `Filter(multi eq)`
EnterpriseCompanyLocation	CompanyLocations (nullable)	Specifies the Enterprise Company Location for which the price is valid for. If the field is blank, the price is valid for all Enterprise Company Locations. `Filter(multi eq)` `Introduced in version 24.1.4.35`
PriceQuantityMeasurement Unit	MeasurementUnits	The measurement unit of Price_Quantity. `Required` `Filter(multi eq)`
Product	Products	The product for which a purchase price will be defined. `Required` `Filter(multi eq)`
PurchasePriceList	PurchasePriceLists (nullable)	When not null, specifies that this price is valid only when the purchase document is set to work with the specified price list. `Filter(multi eq)`
Supplier	Suppliers (nullable)	When not null, specifies that the price is valid only for the specified supplier. `Filter(multi eq)`

Attribute Details

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

FromDate

Starting date of validity of the price. Filter(eq;ge;le)

Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

MaxQuantity

Maximum quantity for which this price is valid in the Price_Quantity_Measurement_Unit. Unit: PriceQuantityMeasurementUnit Filter(eq)

Type: Quantity (18, 3) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: HiddenByDefault

MinQuantity

Minimal quantity required to use this price (in the Price_Quantity_Measurement_Unit). Unit: PriceQuantityMeasurementUnit Filter(eq)

Type: Quantity (18, 3) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: HiddenByDefault

Notes

Notes for this PurchaseProductPrice.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: HiddenByDefault

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

Price

Price in the specified currency and for the specified quantity. Currency: Currency Required Default(0)

Type: Amount (13, 5)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

PriceQuantity

The quantity of the product for which the price is specified. Unit: PriceQuantityMeasurementUnit Required Default(1)

Type: Quantity (10, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: HiddenByDefault

Priority

Priority of the price comparative to other prices. Required Default(2) Filter(multi eq)

Type: Priority
Category: System
Allowed values for the Priority(Logistics.Procurement.PurchaseProductPrices.md#priority) data attribute
Allowed Values (Logistics.Procurement.PurchaseProductPricesRepository.Priority Enum Members)

Value	Description
Lowest	Lowest value. Stored as 1. Database Value: 1 Model Value: 1 Domain API Value: 'Lowest'
Two	Two value. Stored as 2. Database Value: 2 Model Value: 2 Domain API Value: 'Two'
Three	Three value. Stored as 3. Database Value: 3 Model Value: 3 Domain API Value: 'Three'
Four	Four value. Stored as 4. Database Value: 4 Model Value: 4 Domain API Value: 'Four'
Highest	Highest value. Stored as 5. Database Value: 5 Model Value: 5 Domain API Value: 'Highest'

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

ThruDate

Ending date (inclusive) of the validity of the price. Filter(eq;ge;le)

Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

Reference Details

Currency

The currency of the price. Required Filter(multi eq)

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

EnterpriseCompany

Determines for which enterprise company this price is used. If not specified the price is used for all enterprise companies. Filter(multi eq)

Type: EnterpriseCompanies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

EnterpriseCompanyLocation

Specifies the Enterprise Company Location for which the price is valid for. If the field is blank, the price is valid for all Enterprise Company Locations. Filter(multi eq) Introduced in version 24.1.4.35

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

PriceQuantityMeasurementUnit

The measurement unit of Price_Quantity. Required Filter(multi eq)

Type: MeasurementUnits
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
obj.Product.BaseUnit.IfNullThen( obj.PriceQuantityMeasurementUnit)

Product

The product for which a purchase price will be defined. Required Filter(multi eq)

Type: Products
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PurchasePriceList

When not null, specifies that this price is valid only when the purchase document is set to work with the specified price list. Filter(multi eq)

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

Supplier

When not null, specifies that the price is valid only for the specified supplier. Filter(multi eq)

Type: Suppliers (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