Finance.Vat.BoxTypes Entity

The types of boxes in a VAT declaration. . Entity: VAT_Box_Types (Introduced in version 22.1.4.18)

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.Vat.BoxTypes

Attributes

Name	Type	Description
CalculationType	CalculationType	Determines the source of amounts of the current Box Type. Sources can be the Vat Entries or the Calculated attribute from the VAT Declaration which is specified in the "Calculated Attribute Name" field. `Required` `Default("DT")` `Filter(multi eq)` `Introduced in version 22.1.5.90`
Code	string (32)	The unique code of the BoxType. `Required` `Filter(multi eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Name	MultilanguageString (254)	The name for this box type. (Miltilanguage string). `Required` `Filter(like)`
Notes	string (max) nullable	Notes for this BoxType.
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
CalculatedAttribute	CalculatedAttributes (nullable)	The calculated attribute which will be used in the calculation of the amount of the current Box Type. Used when the value of the "Calculation Type" field is "Calculated Attribute". `Filter(multi eq)` `Introduced in version 22.1.5.97`
Country	Countries	The Country for which this type of box is declared. `Required` `Filter(multi eq)`

Attribute Details

CalculationType

Determines the source of amounts of the current Box Type. Sources can be the Vat Entries or the Calculated attribute from the VAT Declaration which is specified in the "Calculated Attribute Name" field. Required Default("DT") Filter(multi eq) Introduced in version 22.1.5.90

Type: CalculationType
Category: System
Allowed values for the CalculationType(Finance.Vat.BoxTypes.md#calculationtype) data attribute
Allowed Values (Finance.Vat.BoxTypesRepository.CalculationType Enum Members)

Value	Description
DealTypes	Source of amounts are Vat Entries. Stored as 'DT'. Database Value: 'DT' Model Value: 0 Domain API Value: 'DealTypes'
CalculatedAttribute	Source of amounts is Calculated attribute from the VAT Declaration which is specified in the "Calculated Attribute Name" field. Stored as 'CA'. Database Value: 'CA' Model Value: 1 Domain API Value: 'CalculatedAttribute'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: DealTypes
Show in UI: ShownByDefault

Code

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

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

Name

The name for this box type. (Miltilanguage string). Required Filter(like)

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

Notes

Notes for this BoxType.

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

CalculatedAttribute

The calculated attribute which will be used in the calculation of the amount of the current Box Type. Used when the value of the "Calculation Type" field is "Calculated Attribute". Filter(multi eq) Introduced in version 22.1.5.97

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

Country

The Country for which this type of box is declared. Required Filter(multi eq)

Type: Countries
Indexed: True
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