Table of Contents

Finance.Excise.ExciseProductTypes Entity

Namespace: Finance.Excise

The different types of excise products. Excise product types are differentiated by product, capacity, alcoholic strength and other criteria. Entity: Exc_Excise_Product_Types (Introduced in version 22.1.6.44)

Default Visualization

Default Display Text Format:
{Code}: {Name}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Settings
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

Attributes

Name Type Description
AlcoholicStrength decimal (5, 2) Percentage of pure alcohol used in excise duty reporting. Required Default(0)
Capacity decimal (6, 4) nullable Package capacity - number of cigarettes or volume of alcohol in liters. Default(0)
Category Category Specifies the excise product category of the excise stamp - alcohol, tobacco, and others. Required
Code string (32) The unique code of the ExciseProductType. Required Filter(multi eq;like) ORD
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExciseAmountPerStamp decimal (10, 6) The excise duty, which is charged with one excise label. Required Default(0)
Id guid
IsActive boolean Indicates whether this excise poduct type is active and usable for choosing in new documents. Required Default(true) Filter(eq)
Name MultilanguageString (254) The name of this ExciseProductType. Required Filter(like)
Notes string (max) nullable Notes for this ExciseProductType.
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
CommodityCode CommodityCodes Code from The Combined Nomenclature used within the European Union countries. Required Filter(multi eq)
ExciseProduct ExciseProducts Excise product according to the EU nomenclature for products subject to excise duty. Required Filter(multi eq)
MeasurementUnit MeasurementUnits (nullable) The unit of measure in which the product is reported. Filter(multi eq)

Attribute Details

AlcoholicStrength

Percentage of pure alcohol used in excise duty reporting. Required Default(0)

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

Capacity

Package capacity - number of cigarettes or volume of alcohol in liters. Default(0)

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

Category

Specifies the excise product category of the excise stamp - alcohol, tobacco, and others. Required

Type: Category
Category: System
Allowed values for the Category(Finance.Excise.ExciseProductTypes.md#category) data attribute
Allowed Values (Finance.Excise.ExciseProductTypesRepository.Category Enum Members)

Value Description
ExciseStampFor
TobaccoProducts		 Excise Stamp for Tobacco Products. Stored as 'TT'.
Database Value: 'TT'
Model Value: 0
Domain API Value: 'ExciseStampFor
TobaccoProducts'
ExciseStampFor
AlcoholProducts		 Excise Stamp for Alcohol Products. Stored as 'AA'.
Database Value: 'AA'
Model Value: 1
Domain API Value: 'ExciseStampFor
AlcoholProducts'
DutyFree Duty Free. Stored as 'DF'.
Database Value: 'DF'
Model Value: 2
Domain API Value: 'DutyFree'

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

Code

The unique code of the ExciseProductType. 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

Back-End Default Expression:
obj.GetNextDefaultCode( )

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

ExciseAmountPerStamp

The excise duty, which is charged with one excise label. Required Default(0)

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

Id

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

IsActive

Indicates whether this excise poduct type is active and usable 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

Name

The name of this ExciseProductType. Required Filter(like)

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

Notes

Notes for this ExciseProductType.

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

Reference Details

CommodityCode

Code from The Combined Nomenclature used within the European Union countries. Required Filter(multi eq)

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

ExciseProduct

Excise product according to the EU nomenclature for products subject to excise duty. Required Filter(multi eq)

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

MeasurementUnit

The unit of measure in which the product is reported. Filter(multi eq)

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

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

None

Front-End Business Rules

None

API

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

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

Suggest improvement to this page