Finance.Excise.ExciseProductCategories Entity

Namespace: Finance.Excise

Product Category is defined by the taxation and customs authorities. Also specifies the calculation algorithm for the excise. For EU, the product category code is a single character - B,E,I,S,T or W. Entity: Exc_Excise_Product_Categories (Introduced in version 21.1.3.87)

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

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

Finance.Excise.ExciseProductCategories

Attributes

Name	Type	Description
CalculationAlgorithm	CalculationAlgorithm	The calculation algorithm for Tax Base. NOP=No operation - manually set Tax Base; QTY=Qty; QAS=Qty * Alcoholic strength; QAP=Qty * Alcoholic strength / 100. `Required`
Code	string (32)	For EU, the product category code is a single character - B,E,I,S,T or W. `Required` `Filter(multi eq;like)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Name	MultilanguageString (254)	Multilanguage String. `Required` `Filter(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.

Attribute Details

CalculationAlgorithm

The calculation algorithm for Tax Base. NOP=No operation - manually set Tax Base; QTY=Qty; QAS=Qty * Alcoholic strength; QAP=Qty * Alcoholic strength / 100. Required

Type: CalculationAlgorithm
Category: System
Allowed values for the CalculationAlgorithm(Finance.Excise.ExciseProductCategories.md#calculationalgorithm) data attribute
Allowed Values (Finance.Excise.ExciseProductCategoriesRepository.CalculationAlgorithm Enum Members)

Value	Description
NoОperation	No operation - manually set Tax Base. Stored as 'NOP'. Database Value: 'NOP' Model Value: 0 Domain API Value: 'NoОperation'
Qty	Quantity. Stored as 'QTY'. Database Value: 'QTY' Model Value: 1 Domain API Value: 'Qty'
QtyByAlcoholicStrength	Quantity * Alcoholic strength. Stored as 'QAS'. Database Value: 'QAS' Model Value: 2 Domain API Value: 'QtyByAlcoholicStrength'
QtyByAlcoholic StrengthDiv100	Quantity * Alcoholic strength / 100. Stored as 'QAP'. Database Value: 'QAP' Model Value: 3 Domain API Value: 'QtyByAlcoholic StrengthDiv100'

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

Code

For EU, the product category code is a single character - B,E,I,S,T or W. Required Filter(multi eq;like)

Type: string (32)
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 32
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
Filterable Reference: True
Default Value: NewGuid
Show in UI: CannotBeShown

Name

Multilanguage String. Required Filter(like)

Type: MultilanguageString (254)
Category: System
Supported Filters: 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

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