Table of Contents

Finance.Vat.DealTypes Entity

Namespace: Finance.Vat

Contains deal types supported by the system as well as user-defined types. Entity: VAT_Deal_Types

Default Visualization

Default Display Text Format:
{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
Code string (32) Code of the deal type. Required Filter(multi eq;like) ORD Introduced in version 23.1.0.32
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EntryType EntryType Type of the VAT entries, which are made for this deal type. S=Sales, P=Purchases. Required Filter(eq)
Id guid
IsSystem boolean Is_System is True for those deal types that are managed by the system via update procedures and cannot be edited by the user. Required Default(false) Filter(eq) ReadOnly
Name string (254) Description of the deal type. Required Filter(eq;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.
TaxCode TaxCode VAT rate type for this deal type. Can be among "STD"(Standard rate), "RED"(Reduced rate), "SPR"(Super-reduced rates), "INT"(Intermediary (Parking) rates), "EXM"(Tax Exempt), "NS"(Non-subject to tax). Required Filter(multi eq) Introduced in version 23.1.0.33

References

Name Type Description
Country Countries The country for which this deal type applies. The country is matched against the country of the enterprise company. Required Filter(multi eq)

Child Collections

Name Type Description
DocumentAmounts DealTypeDocumentAmounts List of DealTypeDocumentAmount(Finance.Vat.DealTypeDocumentAmounts.md) child objects, based on the Finance.Vat.DealTypeDocumentAmount.DealType(Finance.Vat.DealTypeDocumentAmounts.md#dealtype) back reference

Attribute Details

Code

Code of the deal type. Required Filter(multi eq;like) ORD Introduced in version 23.1.0.32

Type: string (32)
Indexed: True
Category: System
Supported Filters: Equals, Like, 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

EntryType

Type of the VAT entries, which are made for this deal type. S=Sales, P=Purchases. Required Filter(eq)

Type: EntryType
Category: System
Allowed values for the EntryType(Finance.Vat.DealTypes.md#entrytype) data attribute
Allowed Values (Finance.Vat.DealTypesRepository.EntryType Enum Members)

Value Description
Purchases Purchases value. Stored as 'P'.
Database Value: 'P'
Model Value: 0
Domain API Value: 'Purchases'
Sales Sales value. Stored as 'S'.
Database Value: 'S'
Model Value: 1
Domain API Value: 'Sales'

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

Id

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

IsSystem

Is_System is True for those deal types that are managed by the system via update procedures and cannot be edited by the user. Required Default(false) Filter(eq) ReadOnly

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

Name

Description of the deal type. Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
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

TaxCode

VAT rate type for this deal type. Can be among "STD"(Standard rate), "RED"(Reduced rate), "SPR"(Super-reduced rates), "INT"(Intermediary (Parking) rates), "EXM"(Tax Exempt), "NS"(Non-subject to tax). Required Filter(multi eq) Introduced in version 23.1.0.33

Type: TaxCode
Category: System
Allowed values for the TaxCode(Finance.Vat.DealTypes.md#taxcode) data attribute
Allowed Values (Finance.Vat.DealTypesRepository.TaxCode Enum Members)

Value Description
StandardRate StandardRate value. Stored as 'STD'.
Database Value: 'STD'
Model Value: 0
Domain API Value: 'StandardRate'
ReducedRate ReducedRate value. Stored as 'RED'.
Database Value: 'RED'
Model Value: 1
Domain API Value: 'ReducedRate'
SuperReducedRates SuperReducedRates value. Stored as 'SPR'.
Database Value: 'SPR'
Model Value: 2
Domain API Value: 'SuperReducedRates'
IntermediaryParkingRates IntermediaryParkingRates value. Stored as 'INT'.
Database Value: 'INT'
Model Value: 3
Domain API Value: 'IntermediaryParkingRates'
TaxExempt TaxExempt value. Stored as 'EXM'.
Database Value: 'EXM'
Model Value: 4
Domain API Value: 'TaxExempt'
NonSubjectToTax NonSubjectToTax value. Stored as 'NS '.
Database Value: 'NS '
Model Value: 5
Domain API Value: 'NonSubjectToTax'

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

Reference Details

Country

The country for which this deal type applies. The country is matched against the country of the enterprise company. Required Filter(multi eq)

Type: Countries
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_Vat_DealTypes?$top=10

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

Suggest improvement to this page