Table of Contents

General.Products.Products Entity

Namespace: General.Products

Products are the different items in the enterprise, which can be purchased, stored, sold and depreciated. Entity: Gen_Products

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
PartNumber; Name
Code Data Member:
PartNumber
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault
Layout category attribute: ProductTypeId

Track Changes

Min level: 2 - Track object 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

Attributes

Name Type Description
ABCClass ABCClass Product importance classification, where A are the most important and C - the least important products. Usually used as user filtering condition when previewing results of the procurement planning process. Required Default("B ") Filter(eq)
Active boolean True if the product is active, false - not to list in combo boxes for choosing in new documents. Required Default(true) Filter(eq)
AllowVariableMeasurement
Ratios		 boolean Allow variable (dynamic) measurement ratios for each transaction. If specified, each store transaction could specify different measurement ratio between the used measurement unit and the base measurement unit. Required Default(false) Filter(eq)
CatalogDescriptionHtml string (max) nullable Full HTML description of the product. Usually used for display on product catalogs, web pages, etc.
CostingMethod CostingMethod nullable Specifies the costing method for the product. null means to use the Enterprise Company default. Currently supported methods are: EXP - Explicitly specify lot; AVG - Average cost.
CreationTime datetime nullable Date and time when the Product was created. Filter(ge;le) ReadOnly
CreationUser string (64) nullable Login name of the user, who created the Product. Filter(like) ReadOnly
Description MultilanguageString (max) nullable The description of the product.
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExpiryPeriodDays int32 nullable Total default expiry period for the product (in days) from the date of production to the date of expiry.
FlushingMethod FlushingMethod Consumption method for work orders. M=Manual, using Consuption Journals, F=Forward (on release), B=Backward (on finish). Required Default("M")
GuaranteePeriodDays int32 nullable Default guarantee period length in days. 0 means no guarantee. Should be non-null for serviced products and null for the others.
Id guid
IsFeatured boolean Specifies whether the product should be presented at the title space in promotional materials, web pages, etc. Required Default(false) Filter(eq)
IsSerialized boolean True if the parts use/require serial numbers. Required Default(false) Filter(eq)
LotsIssue LotsIssue nullable Determines the method by which the lots are automatically issued. The method determines the sequence of the lots: in the order of receipt (FIFO), in the order inverse of receipt (LIFO) or in the order of expiration (FEFO).
ManufacturingPolicy string (3) Manufacturing policy controls the procurement planing system actions for this product. Allowed values are MTS=Make-To-Stock; MTO=Make-To-Order; ATO=Assemble-To-Order. Required Default("MTS")
MinimalSalesPricePerLot Amount (18, 4) nullable Minimal allowed price for sales of this product. The price is for one standard lot and in the costing currency of the product. The minimum is enforced upon planning and/or releasing a document. null means that there is no minimal sales price enforcement. Currency: CostingCurrency
MinimalSalesQuantityBase decimal (18, 3) nullable Minimal base quantity of this product that has to be specified in any sale.
Name MultilanguageString (254) Name of the item. Required Filter(eq;like)
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.
PartNumber string (32) Unique part number of the product. Required Filter(multi eq;like) ORD
PlanningDemand
TimeFenceDays		 int32 nullable Period in the future, in which changes to the MPS are not accepted due to the high cost of changing. Demand for the period is calculated based entirely on the customer orders. Abbr. - DTF (null = Default of 30 days).
PlanningHorizonDays int32 nullable Number of days in the future for which to plan the demand and supply (null = Default of 180 days).
PlanningTimeFenceDays int32 nullable Period in the future inside of which changes to the MPS are carefully evaluated to prevent costly schedule disruption. Demand for the period between DTF and PTF is calculated as the bigger of customer orders and sales forecast. Abbr. - PTF. (null = Default of 90 days).
ScrapRate decimal (7, 6) Default scrap rate for the recipe, when this product is used as ingredient. Required Default(0)
ShortName MultilanguageString (128) nullable Short name of the product. Used for space-constrained devices, like mobile phones, fiscal printers, etc. Filter(eq;like)
ShowInCatalog boolean Specifies whether to show the product in catalogs, referring to the product group of the product. false=Do not show; true=Show. Required Default(false) Filter(multi eq)
StandardCostPerLot Amount (18, 4) Standard cost for one standard lot of the product in the currency, specified by Costing_Currency_Id. Currency: ProductCurrency Required Default(0)
StandardLotSizeBase Quantity (18, 3) The size of a standard lot, expressed in the base measurement unit of the product. Used for Standard_Cost and Standard_Price. Unit: BaseMeasurementCategory.BaseUnit Required Default(1)
StandardPricePerLot Amount (18, 4) Standard sales price (used if no special price is defined) for one standard lot of the product in the currency, specified by Costing_Currency_Id. Currency: ProductCurrency Required Default(0)
SupplySchemaId guid nullable The supply schema to use for the distribution of the product among warehouses. Filter(multi eq)
UpdateTime datetime nullable Date and time when the Product was last updated. Filter(ge;le) ReadOnly
UpdateUser string (64) nullable Login name of the user, who last updated the Product. Filter(like) ReadOnly
UseLots UseLots Specifies whether the use of lots for this product in store documents is required or is unallowed or is allowed while not required. Required Default("A")

References

Name Type Description
BaseMeasurementCategory MeasurementCategories The base measurement category for quantities of this product. Required Filter(multi eq)
CargoType CargoTypes (nullable) Specifies what type of cargo this product is. Required when generating transportation requisitions. null means unspecified. Filter(multi eq)
CostingCurrency Currencies (nullable) Specifies the currency to use for cost calculations for the product. When null, the base currency for the enterprise company should be used. Filter(multi eq)
EnterpriseCompany EnterpriseCompanies (nullable) When not null, specifies that the product is specific to a given enterprise company and may be used only in documents from this enterprise company. Filter(multi eq)
ExciseProductType ExciseProductTypes (nullable) Specifies the basic excise attributes of the product. Filter(multi eq) Introduced in version 22.1.6.45
IntrastatCommodityCode CommodityCodes (nullable) Code from The Combined Nomenclature used within the European Union countries. Used when reporting Intrastat and Excise. Filter(multi eq)
IntrastatSupplementaryUnit MeasurementUnits (nullable) Additional measurement unit from the Intrastat Combined nomenclature. Used when creating Intrastat declarations. Filter(multi eq)
MeasurementUnit MeasurementUnits Default measurement unit, when creating new documents with this product. Required Filter(multi eq)
OriginCountry Countries (nullable) Country from which the product originates (in which the product is produced/cultivated ...). Primarily used for Intrastat reporting. Filter(multi eq)
ProductGroup ProductGroups The product group, under which the product is categorized. Required Filter(multi eq)
ProductType ProductTypes The type of the product. This also defines whether the product is stocked. null=no specific product type and the product is stocked. Required Filter(multi eq)
PurchaseMeasurementUnit MeasurementUnits (nullable) Default measurement unit to use, when creating new purchase documents with this product. Filter(multi eq)
ValuationGroup ProductValuationGroups (nullable) Valuation group of the product. Used in reconciliations when compensating pluses and minuses. Equal plus and minus amounts within a valuation group are allowed to be compensated with each other for zero net fiscal effect. Filter(multi eq)

Child Collections

Name Type Description
Codes ProductCodes List of ProductCode(General.Products.ProductCodes.md) child objects, based on the General.Products.ProductCode.Product(General.Products.ProductCodes.md#product) back reference
CompositeProductComponents CompositeProductComponents List of CompositeProduct<br />Component(General.Products.CompositeProductComponents.md) child objects, based on the General.Products.CompositeProductComponent.CompositeProduct(General.Products.CompositeProductComponents.md#compositeproduct) back reference
DefaultStoreBins ProductDefaultStoreBins List of ProductDefaultStoreBin(Logistics.Inventory.ProductDefaultStoreBins.md) child objects, based on the Logistics.Inventory.ProductDefaultStoreBin.Product(Logistics.Inventory.ProductDefaultStoreBins.md#product) back reference
Dimensions ProductDimensions List of ProductDimension(General.Products.ProductDimensions.md) child objects, based on the General.Products.ProductDimension.Product(General.Products.ProductDimensions.md#product) back reference
DistributionChannels ProductDistributionChannels List of ProductDistribution<br />Channel(Crm.Marketing.ProductDistribution
Channels.md) child objects, based on the Crm.Marketing.ProductDistributionChannel.Product(Crm.Marketing.ProductDistribution
Channels.md#product) back reference
DocumentAmounts ProductDocumentAmounts List of ProductDocumentAmount(General.Products.ProductDocumentAmounts.md) child objects, based on the General.Products.ProductDocumentAmount.Product(General.Products.ProductDocumentAmounts.md#product) back reference
LineDiscounts LineDiscounts List of LineDiscount(Crm.Pricing.LineDiscounts.md) child objects, based on the Crm.LineDiscount.Product(Crm.Pricing.LineDiscounts.md#product) back reference
Lots Lots List of Lot(Logistics.Inventory.Lots.md) child objects, based on the Logistics.Inventory.Lot.Product(Logistics.Inventory.Lots.md#product) back reference
Pictures ProductPictures List of ProductPicture(General.Products.ProductPictures.md) child objects, based on the General.Products.ProductPicture.Product(General.Products.ProductPictures.md#product) back reference
Prices ProductPrices List of ProductPrice(Crm.Pricing.ProductPrices.md) child objects, based on the Crm.ProductPrice.Product(Crm.Pricing.ProductPrices.md#product) back reference
PurchaseProductPrices PurchaseProductPrices List of PurchaseProductPrice(Logistics.Procurement.PurchaseProductPrices.md) child objects, based on the Logistics.Procurement.PurchaseProductPrice.Product(Logistics.Procurement.PurchaseProductPrices.md#product) back reference
SerialNumbers SerialNumbers List of SerialNumber(Logistics.Inventory.SerialNumbers.md) child objects, based on the Logistics.Inventory.SerialNumber.Product(Logistics.Inventory.SerialNumbers.md#product) back reference
Variants ProductVariants List of ProductVariant(General.Products.ProductVariants.md) child objects, based on the General.Products.ProductVariant.Product(General.Products.ProductVariants.md#product) back reference

Attribute Details

ABCClass

Product importance classification, where A are the most important and C - the least important products. Usually used as user filtering condition when previewing results of the procurement planning process. Required Default("B ") Filter(eq)

Type: ABCClass
Category: System
Allowed values for the ABCClass(General.Products.Products.md#abcclass) data attribute
Allowed Values (General.Products.ProductsRepository.ABCClass Enum Members)

Value Description
A A value. Stored as 'A '.
Database Value: 'A '
Model Value: 0
Domain API Value: 'A'
B B value. Stored as 'B '.
Database Value: 'B '
Model Value: 1
Domain API Value: 'B'
C C value. Stored as 'C '.
Database Value: 'C '
Model Value: 2
Domain API Value: 'C'

Supported Filters: Equals
Supports Order By: False
Default Value: B
Show in UI: ShownByDefault

Active

True if the product is active, false - not to list in combo boxes for choosing in new documents. Required Default(true) Filter(eq)

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

AllowVariableMeasurementRatios

Allow variable (dynamic) measurement ratios for each transaction. If specified, each store transaction could specify different measurement ratio between the used measurement unit and the base measurement unit. Required Default(false) Filter(eq)

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

CatalogDescriptionHtml

Full HTML description of the product. Usually used for display on product catalogs, web pages, etc.

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

CostingMethod

Specifies the costing method for the product. null means to use the Enterprise Company default. Currently supported methods are: EXP - Explicitly specify lot; AVG - Average cost.

Type: CostingMethod nullable
Category: System
Allowed values for the CostingMethod(General.Products.Products.md#costingmethod) data attribute
Allowed Values (General.Products.ProductsRepository.CostingMethod Enum Members)

Value Description
AverageCostFor
TheWholeProduct		 AverageCostFor
TheWholeProduct value. Stored as 'AVG'.
Database Value: 'AVG'
Model Value: 0
Domain API Value: 'AverageCostFor
TheWholeProduct'
SeparateCostForEachLot SeparateCostForEachLot value. Stored as 'EXP'.
Database Value: 'EXP'
Model Value: 1
Domain API Value: 'SeparateCostForEachLot'
AveragePartitioned
ByReservedForDocument		 AveragePartitioned
ByReservedForDocument value. Stored as 'BLD'.
Database Value: 'BLD'
Model Value: 2
Domain API Value: 'AveragePartitioned
ByReservedForDocument'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

CreationTime

Date and time when the Product was created. Filter(ge;le) ReadOnly

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

CreationUser

Login name of the user, who created the Product. Filter(like) ReadOnly

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

Description

The description of the product.

Type: MultilanguageString (max) 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

ExpiryPeriodDays

Total default expiry period for the product (in days) from the date of production to the date of expiry.

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

FlushingMethod

Consumption method for work orders. M=Manual, using Consuption Journals, F=Forward (on release), B=Backward (on finish). Required Default("M")

Type: FlushingMethod
Category: System
Allowed values for the FlushingMethod(General.Products.Products.md#flushingmethod) data attribute
Allowed Values (General.Products.ProductsRepository.FlushingMethod Enum Members)

Value Description
Backward Backward value. Stored as 'B'.
Database Value: 'B'
Model Value: 0
Domain API Value: 'Backward'
Forward Forward value. Stored as 'F'.
Database Value: 'F'
Model Value: 1
Domain API Value: 'Forward'
Manual Manual value. Stored as 'M'.
Database Value: 'M'
Model Value: 2
Domain API Value: 'Manual'

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

GuaranteePeriodDays

Default guarantee period length in days. 0 means no guarantee. Should be non-null for serviced products and null for the others.

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

Id

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

IsFeatured

Specifies whether the product should be presented at the title space in promotional materials, web pages, etc. Required Default(false) Filter(eq)

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

IsSerialized

True if the parts use/require serial numbers. Required Default(false) Filter(eq)

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

LotsIssue

Determines the method by which the lots are automatically issued. The method determines the sequence of the lots: in the order of receipt (FIFO), in the order inverse of receipt (LIFO) or in the order of expiration (FEFO).

Type: LotsIssue nullable
Category: System
Allowed values for the LotsIssue(General.Products.Products.md#lotsissue) data attribute
Allowed Values (General.Products.ProductsRepository.LotsIssue Enum Members)

Value Description
FirstInFirstOut FirstInFirstOut value. Stored as 'FIFO'.
Database Value: 'FIFO'
Model Value: 0
Domain API Value: 'FirstInFirstOut'
FirstExpireFirstOut FirstExpireFirstOut value. Stored as 'FEFO'.
Database Value: 'FEFO'
Model Value: 1
Domain API Value: 'FirstExpireFirstOut'
LastInFirstOut LastInFirstOut value. Stored as 'LIFO'.
Database Value: 'LIFO'
Model Value: 2
Domain API Value: 'LastInFirstOut'

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

ManufacturingPolicy

Manufacturing policy controls the procurement planing system actions for this product. Allowed values are MTS=Make-To-Stock; MTO=Make-To-Order; ATO=Assemble-To-Order. Required Default("MTS")

Type: string (3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 3
Default Value: MTS
Show in UI: CannotBeShown

MinimalSalesPricePerLot

Minimal allowed price for sales of this product. The price is for one standard lot and in the costing currency of the product. The minimum is enforced upon planning and/or releasing a document. null means that there is no minimal sales price enforcement. Currency: CostingCurrency

Type: Amount (18, 4) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

MinimalSalesQuantityBase

Minimal base quantity of this product that has to be specified in any sale.

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

Name

Name of the item. Required Filter(eq;like)

Type: MultilanguageString (254)
Indexed: True
Category: System
Supported Filters: Equals, Like
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

PartNumber

Unique part number of the product. Required Filter(multi eq;like) ORD

Type: string (32)
Indexed: True
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: True
Maximum Length: 32
Show in UI: ShownByDefault

PlanningDemandTimeFenceDays

Period in the future, in which changes to the MPS are not accepted due to the high cost of changing. Demand for the period is calculated based entirely on the customer orders. Abbr. - DTF (null = Default of 30 days).

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

PlanningHorizonDays

Number of days in the future for which to plan the demand and supply (null = Default of 180 days).

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

PlanningTimeFenceDays

Period in the future inside of which changes to the MPS are carefully evaluated to prevent costly schedule disruption. Demand for the period between DTF and PTF is calculated as the bigger of customer orders and sales forecast. Abbr. - PTF. (null = Default of 90 days).

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

ScrapRate

Default scrap rate for the recipe, when this product is used as ingredient. Required Default(0)

Type: decimal (7, 6)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

ShortName

Short name of the product. Used for space-constrained devices, like mobile phones, fiscal printers, etc. Filter(eq;like)

Type: MultilanguageString (128) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

ShowInCatalog

Specifies whether to show the product in catalogs, referring to the product group of the product. false=Do not show; true=Show. 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

StandardCostPerLot

Standard cost for one standard lot of the product in the currency, specified by Costing_Currency_Id. Currency: ProductCurrency Required Default(0)

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

StandardLotSizeBase

The size of a standard lot, expressed in the base measurement unit of the product. Used for Standard_Cost and Standard_Price. Unit: BaseMeasurementCategory.BaseUnit Required Default(1)

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

StandardPricePerLot

Standard sales price (used if no special price is defined) for one standard lot of the product in the currency, specified by Costing_Currency_Id. Currency: ProductCurrency Required Default(0)

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

SupplySchemaId

The supply schema to use for the distribution of the product among warehouses. Filter(multi eq)

Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown

UpdateTime

Date and time when the Product was last updated. Filter(ge;le) ReadOnly

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

UpdateUser

Login name of the user, who last updated the Product. Filter(like) ReadOnly

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

UseLots

Specifies whether the use of lots for this product in store documents is required or is unallowed or is allowed while not required. Required Default("A")

Type: UseLots
Category: System
Allowed values for the UseLots(General.Products.Products.md#uselots) data attribute
Allowed Values (General.Products.ProductsRepository.UseLots Enum Members)

Value Description
Allowed Allowed value. Stored as 'A'.
Database Value: 'A'
Model Value: 0
Domain API Value: 'Allowed'
NotAllowed NotAllowed value. Stored as 'N'.
Database Value: 'N'
Model Value: 1
Domain API Value: 'NotAllowed'
Required Required value. Stored as 'R'.
Database Value: 'R'
Model Value: 2
Domain API Value: 'Required'

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

Reference Details

BaseMeasurementCategory

The base measurement category for quantities of this product. Required Filter(multi eq)

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

Front-End Recalc Expressions:
obj.ProductGroup.DefaultMeasurementUnit.MeasurementCategory

CargoType

Specifies what type of cargo this product is. Required when generating transportation requisitions. null means unspecified. Filter(multi eq)

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

CostingCurrency

Specifies the currency to use for cost calculations for the product. When null, the base currency for the enterprise company should be used. Filter(multi eq)

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

EnterpriseCompany

When not null, specifies that the product is specific to a given enterprise company and may be used only in documents from this enterprise company. Filter(multi eq)

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

Front-End Recalc Expressions:
obj.ProductGroup.EnterpriseCompany

ExciseProductType

Specifies the basic excise attributes of the product. Filter(multi eq) Introduced in version 22.1.6.45

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

IntrastatCommodityCode

Code from The Combined Nomenclature used within the European Union countries. Used when reporting Intrastat and Excise. Filter(multi eq)

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

IntrastatSupplementaryUnit

Additional measurement unit from the Intrastat Combined nomenclature. Used when creating Intrastat declarations. Filter(multi eq)

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

MeasurementUnit

Default measurement unit, when creating new documents with this product. Required Filter(multi eq)

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

Front-End Recalc Expressions:
obj.ProductGroup.DefaultMeasurementUnit

OriginCountry

Country from which the product originates (in which the product is produced/cultivated ...). Primarily used for Intrastat reporting. Filter(multi eq)

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

ProductGroup

The product group, under which the product is categorized. Required Filter(multi eq)

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

ProductType

The type of the product. This also defines whether the product is stocked. null=no specific product type and the product is stocked. Required Filter(multi eq)

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

Back-End Default Expression:
obj.ProductGroup.GetDefaultProductTypeForNewProduct( )

Front-End Recalc Expressions:
obj.ProductGroup.GetDefaultProductTypeForNewProduct( )

PurchaseMeasurementUnit

Default measurement unit to use, when creating new purchase documents with this product. Filter(multi eq)

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

ValuationGroup

Valuation group of the product. Used in reconciliations when compensating pluses and minuses. Equal plus and minus amounts within a valuation group are allowed to be compensated with each other for zero net fiscal effect. Filter(multi eq)

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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

  • priority
    The notification priority.
    Type: Systems.Core.NotificationsRepository.Priority
    Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
    Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

    Value Description
    Background Background value. Stored as 1.
    Model Value: 1
    Domain API Value: 'Background'
    Low Low value. Stored as 2.
    Model Value: 2
    Domain API Value: 'Low'
    Normal Normal value. Stored as 3.
    Model Value: 3
    Domain API Value: 'Normal'
    High High value. Stored as 4.
    Model Value: 4
    Domain API Value: 'High'
    Urgent Urgent value. Stored as 5.
    Model Value: 5
    Domain API Value: 'Urgent'

    Optional: True
    Default Value: Normal

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

Front-End Business Rules

API

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

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

Suggest improvement to this page