Finance.Excise.ExciseAdministrativeDocumentLines Entity

Namespace: Finance.Excise

The details of the movement of each excise product for each excise document. Entity: Exc_Excise_Administrative_Document_Lines (Introduced in version 21.1.3.54)

Default Visualization

Default Display Text Format:
{LineNo}. {ExciseAdministrativeDocument.DocumentNo} {ExciseAdministrativeDocument.DocumentType.TypeName:T}
Default Search Members:
ExciseAdministrativeDocument.DocumentNo
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 Parent:
Finance.Excise.ExciseAdministrativeDocuments
Aggregate Root:
Finance.Excise.ExciseAdministrativeDocuments

Attributes

Name	Type	Description
CurrentBalanceBase	Quantity	The current balance of the product in the selected store and enterprise company. If lot, serial number or product variant are specified the quantity is calculated accordingly.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExciseAlcoholicStrength	decimal (5, 2) nullable	The alcoholic strength, which will be used for Excise reporting purposes. null if the product is not subject to alcoholic Excise reporting. `Introduced in version 21.1.3.97`
ExciseAmount	Amount (14, 2)	The excise amount . `Currency: Document.EnterpriseCompany.BaseCurrency` `Required` `Default(0)` `Filter(eq;ge;le)` `Introduced in version 21.1.3.94`
ExciseAmountBase	decimal (14, 4)	The excise amount in base currency. `Unit: ExciseAdministrative<br />Document.EnterpriseCompany.BaseCurrency` `Required` `Default(0)` `Filter(eq;ge;le)` `Introduced in version 21.1.3.94`
ExciseDutyRateValue	decimal (10, 6) nullable	The rate which should be applied for the specified product and purpose. null means not assigned yet. `Introduced in version 21.1.3.97`
ExciseQuantity	Quantity (12, 3)	The quantity, converted, for reporting purposes, in the measurement unit of the excise product type. `Unit: ExciseQuantityUnit` `Required` `Introduced in version 22.1.6.58`
Id	guid
LineNo	int32	Consecutive line number within the document. `Required` `Filter(multi eq)`
Notes	string (max) nullable	Notes for this ExciseAdministrative DocumentLine.
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.
ParentLineNo	int32 nullable	The number of the line within the parent document, which the current line executes. Null when the current line does not execute line. `Filter(multi eq)` `Introduced in version 22.1.4.9`
Quantity	Quantity (12, 3)	The quantity being sold, in the measurement unit, specified in Quantity Unit. `Unit: QuantityUnit` `Required` `Default(1)`
QuantityBase	Quantity (12, 3)	The quantity in base measurement category for the product. `Unit: Product.BaseMeasurementCategory.BaseUnit` `Required`

References

Name	Type	Description
Document	ExciseAdministrativeDocuments	The to which this ExciseAdministrative DocumentLine belongs. `Required` `Filter(multi eq)`
ExciseAdministrative Document	ExciseAdministrativeDocuments	The to which this ExciseAdministrative DocumentLine belongs. `Required` `Filter(multi eq)` `Owner`
ExciseDutyRate	ExciseDutyRates (nullable)	The Duty rate specified by the taxation and customs authorities. `Filter(multi eq)` `Introduced in version 21.1.3.97`
ExciseProduct	ExciseProducts (nullable)	The Excise product code defined by the taxation and customs authorities. `Filter(multi eq)` `Introduced in version 21.1.3.97`
ExcisePurposeCode	ExcisePurposeCodes (nullable)	The Purpose codes specify the different purposes recognized by the authorities for determining the excise rate. `Filter(multi eq)` `Introduced in version 21.1.3.97`
ExciseQuantityUnit	MeasurementUnits	The measurement unit of Excise Quantity. Copied from the excise product type. `Required` `Filter(multi eq)` `Introduced in version 22.1.6.58`
Lot	Lots (nullable)	Warehouse lot. `Filter(multi eq)` `Introduced in version 23.1.2.68`
MeasuringTransaction	MeasuringTransactions (nullable)	Transaction of product input or output, measured with specialized measuring device for excise purposes. `Filter(multi eq)` `Introduced in version 21.1.3.87`
ParentDocument	Documents (nullable)	The document, which the current line executes. Null when the current line does not execute another line. `Filter(multi eq)` `Introduced in version 22.1.4.9`
Product	Products	The product being sold. `Required` `Filter(multi eq)`
QuantityUnit	MeasurementUnits	The measurement unit of Quantity. `Required` `Filter(multi eq)`

Attribute Details

CurrentBalanceBase

The current balance of the product in the selected store and enterprise company. If lot, serial number or product variant are specified the quantity is calculated accordingly.

Type: Quantity
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

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

ExciseAlcoholicStrength

The alcoholic strength, which will be used for Excise reporting purposes. null if the product is not subject to alcoholic Excise reporting. Introduced in version 21.1.3.97

Type: decimal (5, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
obj.GetNewAlcoholicStrength( obj.MeasuringTransaction, obj.Product)

ExciseAmount

The excise amount . Currency: Document.EnterpriseCompany.BaseCurrency Required Default(0) Filter(eq;ge;le) Introduced in version 21.1.3.94

Type: Amount (14, 2)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
new Amount( ( obj.ExciseAmountBase * ( obj.ExciseDutyRateValue ?? 0)), obj.Document.EnterpriseCompany.BaseCurrency)

ExciseAmountBase

The excise amount in base currency. Unit: ExciseAdministrativeDocument.EnterpriseCompany.BaseCurrency Required Default(0) Filter(eq;ge;le) Introduced in version 21.1.3.94

Type: decimal (14, 4)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: 0
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
obj.CalculateExciseAmountBase( obj.ExciseProduct, obj.ExciseQuantity, obj.ExciseAlcoholicStrength).IfNullThen( obj.ExciseAmountBase)

ExciseDutyRateValue

The rate which should be applied for the specified product and purpose. null means not assigned yet. Introduced in version 21.1.3.97

Type: decimal (10, 6) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

Front-End Recalc Expressions:
obj.ExciseDutyRate.ExciseDutyRateField

ExciseQuantity

The quantity, converted, for reporting purposes, in the measurement unit of the excise product type. Unit: ExciseQuantityUnit Required Introduced in version 22.1.6.58

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

Front-End Recalc Expressions:
obj.QuantityBase.ConvertTo( obj.ExciseQuantityUnit, obj.Product)

Id

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

LineNo

Consecutive line number within the document. Required Filter(multi eq)

Type: int32
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.ExciseAdministrativeDocument.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.ExciseAdministrativeDocument.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 1)

Notes

Notes for this ExciseAdministrativeDocumentLine.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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

ParentLineNo

The number of the line within the parent document, which the current line executes. Null when the current line does not execute line. Filter(multi eq) Introduced in version 22.1.4.9

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

Quantity

The quantity being sold, in the measurement unit, specified in Quantity Unit. Unit: QuantityUnit Required Default(1)

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

QuantityBase

The quantity in base measurement category for the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required

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

Front-End Recalc Expressions:
IIF( ( ( ( obj.Quantity == null) OrElse ( obj.QuantityUnit == null)) OrElse ( obj.Product == null)), obj.QuantityBase, obj.Quantity.ConvertTo( obj.Product.BaseUnit, obj.Product))

Reference Details

Document

The to which this ExciseAdministrativeDocumentLine belongs. Required Filter(multi eq)

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

ExciseAdministrativeDocument

The to which this ExciseAdministrativeDocumentLine belongs. Required Filter(multi eq) Owner

Type: ExciseAdministrativeDocuments
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

ExciseDutyRate

The Duty rate specified by the taxation and customs authorities. Filter(multi eq) Introduced in version 21.1.3.97

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

Front-End Recalc Expressions:
obj.DetermineExciseDutyRate( obj.ExciseProduct, obj.ExcisePurposeCode)

ExciseProduct

The Excise product code defined by the taxation and customs authorities. Filter(multi eq) Introduced in version 21.1.3.97

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

Front-End Recalc Expressions:
obj.Product.ExciseProductType.ExciseProduct

ExcisePurposeCode

The Purpose codes specify the different purposes recognized by the authorities for determining the excise rate. Filter(multi eq) Introduced in version 21.1.3.97

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

Front-End Recalc Expressions:
IIF( ( obj.LineNo == obj.LineNo), obj.DefaultExcisePurposeCode( ), null)

ExciseQuantityUnit

The measurement unit of Excise Quantity. Copied from the excise product type. Required Filter(multi eq) Introduced in version 22.1.6.58

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

Front-End Recalc Expressions:
obj.Product.ExciseProductType.MeasurementUnit

Lot

Warehouse lot. Filter(multi eq) Introduced in version 23.1.2.68

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

MeasuringTransaction

Transaction of product input or output, measured with specialized measuring device for excise purposes. Filter(multi eq) Introduced in version 21.1.3.87

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

ParentDocument

The document, which the current line executes. Null when the current line does not execute another line. Filter(multi eq) Introduced in version 22.1.4.9

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

Product

The product being sold. Required Filter(multi eq)

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

QuantityUnit

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

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

Front-End Recalc Expressions:
obj.Product.MeasurementUnit

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