Table of Contents

General.Products.ProductTypes Entity

Namespace: General.Products

Categorization of the products by their nature. Entity: Gen_Product_Types

Default Visualization

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

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
Code string (16) The unique code of the ProductType. Required Filter(eq;like) ORD
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsDefault boolean When checked specifies that this type is set by default for new products unless another type is specified in the product groups. Required Default(false) Filter(eq)
IsFixedAsset boolean True when assets are acquired or retired when products from this type are purchased or sold. Required Default(false) Filter(eq)
IsServiceActivityService boolean True when the product corresponds to service used in service documents (like service activities). Required Default(false) Filter(eq)
IsServiced boolean True when the products of this type create service agreements and can be serviced. Required Default(false) Filter(eq)
IsShipped boolean True when the products from this type are being shipped after sales. Required Default(false) Filter(eq)
IsStocked boolean True=The products of this type are stocked in a warehouse; false=otherwise (services). Required Default(true) Filter(eq)
LotAutoCreation boolean If checked specifies that lots are automatically created by the receiving orders with which the products are received. Required Default(false)
Name MultilanguageString (254) The name of this ProductType. 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.

Child Collections

Name Type Description
PurchaseInvoice
LineProperties
ProductTypePurchaseInvoiceLineProperties List of ProductTypePurchase<br />InvoiceLineProperty(General.Products.ProductTypePurchase
InvoiceLineProperties.md) child objects, based on the General.Products.ProductTypePurchase<br />InvoiceLineProperty.ProductType(General.Products.ProductTypePurchase
InvoiceLineProperties.md#producttype) back reference
TaxGroups ProductTypeTaxGroups List of ProductTypeTaxGroup(Crm.Pos.ProductTypeTaxGroups.md) child objects, based on the Crm.Pos.ProductTypeTaxGroup.ProductType(Crm.Pos.ProductTypeTaxGroups.md#producttype) back reference

Attribute Details

Code

The unique code of the ProductType. Required Filter(eq;like) ORD

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

Back-End Default Expression:
obj.IncMax( o => o.Code, null, "00000")

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

IsDefault

When checked specifies that this type is set by default for new products unless another type is specified in the product groups. Required Default(false) Filter(eq)

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

IsFixedAsset

True when assets are acquired or retired when products from this type are purchased or sold. Required Default(false) Filter(eq)

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

IsServiceActivityService

True when the product corresponds to service used in service documents (like service activities). Required Default(false) Filter(eq)

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

IsServiced

True when the products of this type create service agreements and can be serviced. Required Default(false) Filter(eq)

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

IsShipped

True when the products from this type are being shipped after sales. Required Default(false) Filter(eq)

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

IsStocked

True=The products of this type are stocked in a warehouse; false=otherwise (services). Required Default(true) Filter(eq)

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

LotAutoCreation

If checked specifies that lots are automatically created by the receiving orders with which the products are received. Required Default(false)

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

Name

The name of this ProductType. 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

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

Front-End Business Rules

None

API

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

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