Table of Contents

Finance.Excise.ExciseStampOperationTypes Entity

Namespace: Finance.Excise

Specifies the type of the Excise Stamp operation. Entity: Exc_Excise_Stamp_Operation_Types (Introduced in version 22.1.5.85)

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

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
Box1Effect ExciseStampOperation
TypeEnum
Specifies how the operation changes the Excise Stamp availability in the correspondent Box. The boxes are used to report the availability of excise stamps in the relevant locations according to the requirements of the customs administration. Required Default("N")
Box2Effect ExciseStampOperation
TypeEnum
Specifies how the operation changes the Excise Stamp availability in the correspondent Box. The boxes are used to report the availability of excise stamps in the relevant locations according to the requirements of the customs administration. Required Default("N")
Box3Effect ExciseStampOperation
TypeEnum
Specifies how the operation changes the Excise Stamp availability in the correspondent Box. The boxes are used to report the availability of excise stamps in the relevant locations according to the requirements of the customs administration. Required Default("N")
Code string (32) The unique code of the ExciseStampOperationType. Required Filter(multi eq) ORD
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsWholeLot boolean nullable Specifies for this Excise Stamp Operation Type, that when selecting a Excise Stamp Lot within the Excise Stamp Operation line, the entire quantity from the chosen Excise Stamp Lot is copied. Filter(eq) Introduced in version 24.1.1.80
Name MultilanguageString (254) Name of operation (multi-language 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.
RequireProduct boolean nullable Specifies whether for this operation type, the Product field is mandatory in the Excise Stamp Operation line. Filter(eq) Introduced in version 24.1.1.91
TrackSequence boolean nullable Checks for this Excise Stamp Operation Type, when entering numbers, the sequence of previously entered numbers is preserved. Filter(eq) Introduced in version 24.1.1.82

Attribute Details

Box1Effect

Specifies how the operation changes the Excise Stamp availability in the correspondent Box. The boxes are used to report the availability of excise stamps in the relevant locations according to the requirements of the customs administration. Required Default("N")

Type: ExciseStampOperation
TypeEnum

Category: System
Generic enum type for ExciseStampOperationTypeEnum properties
Allowed Values (Finance.Excise.ExciseStampOperationTypeEnum Enum Members)

Value Description
NoChange Value is not changed. Stored as 'N'.
Database Value: 'N'
Model Value: 0
Domain API Value: 'NoChange'
Plus Add value. Stored as 'P'.
Database Value: 'P'
Model Value: 1
Domain API Value: 'Plus'
Minus Subtract value. Stored as 'M'.
Database Value: 'M'
Model Value: 2
Domain API Value: 'Minus'

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

Box2Effect

Specifies how the operation changes the Excise Stamp availability in the correspondent Box. The boxes are used to report the availability of excise stamps in the relevant locations according to the requirements of the customs administration. Required Default("N")

Type: ExciseStampOperation
TypeEnum

Category: System
Generic enum type for ExciseStampOperationTypeEnum properties
Allowed Values (Finance.Excise.ExciseStampOperationTypeEnum Enum Members)

Value Description
NoChange Value is not changed. Stored as 'N'.
Database Value: 'N'
Model Value: 0
Domain API Value: 'NoChange'
Plus Add value. Stored as 'P'.
Database Value: 'P'
Model Value: 1
Domain API Value: 'Plus'
Minus Subtract value. Stored as 'M'.
Database Value: 'M'
Model Value: 2
Domain API Value: 'Minus'

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

Box3Effect

Specifies how the operation changes the Excise Stamp availability in the correspondent Box. The boxes are used to report the availability of excise stamps in the relevant locations according to the requirements of the customs administration. Required Default("N")

Type: ExciseStampOperation
TypeEnum

Category: System
Generic enum type for ExciseStampOperationTypeEnum properties
Allowed Values (Finance.Excise.ExciseStampOperationTypeEnum Enum Members)

Value Description
NoChange Value is not changed. Stored as 'N'.
Database Value: 'N'
Model Value: 0
Domain API Value: 'NoChange'
Plus Add value. Stored as 'P'.
Database Value: 'P'
Model Value: 1
Domain API Value: 'Plus'
Minus Subtract value. Stored as 'M'.
Database Value: 'M'
Model Value: 2
Domain API Value: 'Minus'

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

Code

The unique code of the ExciseStampOperationType. Required Filter(multi eq) ORD

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

IsWholeLot

Specifies for this Excise Stamp Operation Type, that when selecting a Excise Stamp Lot within the Excise Stamp Operation line, the entire quantity from the chosen Excise Stamp Lot is copied. Filter(eq) Introduced in version 24.1.1.80

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

Name

Name of operation (multi-language 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

RequireProduct

Specifies whether for this operation type, the Product field is mandatory in the Excise Stamp Operation line. Filter(eq) Introduced in version 24.1.1.91

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

TrackSequence

Checks for this Excise Stamp Operation Type, when entering numbers, the sequence of previously entered numbers is preserved. Filter(eq) Introduced in version 24.1.1.82

Type: boolean nullable
Category: System
Supported Filters: Equals
Supports Order By: False
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

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

None

Front-End Business Rules

None

API

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

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