Table of Contents

Finance.Accounting.Accounts Entity

Namespace: Finance.Accounting

Contains the leaf level of the chart of accounts. Entity: Acc_Accounts

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Number; Name
Code Data Member:
Number
Name Data Member:
Name
Category: Definitions
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
AccountFullNumber string (30) The full number of the account, unique among all accounts. It consists of the group number, concatenated with the account number. Required Filter(like) ReadOnly
CurrencyValuationMethod CurrencyValuationMethod Method for base currency valuation of non base currency amounts. ACB = Account_Current_Balance, DCD = Document_Currency_
Directory, BRD=Balance_Reference_
Document. Required Default("ACB")
Description string (254) nullable The description of this Account.
Discontinued boolean True means that the account won't be used any more and should not appear in combo boxes. Required Default(false) Filter(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 account name. Required Filter(like)
Number string (30) The number of the account, unique within the account group. 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.

References

Name Type Description
AccountGroup AccountGroups The account group to which this account belongs. Required Filter(multi eq)
Currency Currencies (nullable) The primary currency of the account. All movements on the account are stored in this currency. If there are movements on the account, the currency cannot be changed. Filter(multi eq)
EnterpriseCompany EnterpriseCompanies (nullable) The Enterprise Company to which this Account applies, or null if it is for all enterprise companies. Filter(multi eq)

Child Collections

Name Type Description
RequiredProperties AccountRequiredProperties List of AccountRequiredProperty(Finance.Accounting.AccountRequiredProperties.md) child objects, based on the Finance.Accounting.AccountRequiredProperty.Account(Finance.Accounting.AccountRequiredProperties.md#account) back reference

Attribute Details

AccountFullNumber

The full number of the account, unique among all accounts. It consists of the group number, concatenated with the account number. Required Filter(like) ReadOnly

Type: string (30)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 30
Show in UI: ShownByDefault

Front-End Recalc Expressions:
( obj.AccountGroup.Number + obj.Number)

CurrencyValuationMethod

Method for base currency valuation of non base currency amounts. ACB = Account_Current_Balance, DCD = Document_Currency_Directory, BRD=Balance_Reference_Document. Required Default("ACB")

Type: CurrencyValuationMethod
Category: System
Allowed values for the CurrencyValuationMethod(Finance.Accounting.Accounts.md#currencyvaluationmethod) data attribute
Allowed Values (Finance.Accounting.AccountsRepository.CurrencyValuationMethod Enum Members)

Value Description
AccountCurrentBalance AccountCurrentBalance value. Stored as 'ACB'.
Database Value: 'ACB'
Model Value: 0
Domain API Value: 'AccountCurrentBalance'
DocumentCurrencyDirectory DocumentCurrencyDirectory value. Stored as 'DCD'.
Database Value: 'DCD'
Model Value: 1
Domain API Value: 'DocumentCurrencyDirectory'
BalanceReferenceDocument BalanceReferenceDocument value. Stored as 'BRD'.
Database Value: 'BRD'
Model Value: 2
Domain API Value: 'BalanceReferenceDocument'

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

Description

The description of this Account.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Discontinued

True means that the account won't be used any more and should not appear in combo boxes. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
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 account name. Required Filter(like)

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

Number

The number of the account, unique within the account group. Required Filter(like)

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

AccountGroup

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

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

Currency

The primary currency of the account. All movements on the account are stored in this currency. If there are movements on the account, the currency cannot be changed. Filter(multi eq)

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

EnterpriseCompany

The Enterprise Company to which this Account applies, or null if it is for all enterprise companies. Filter(multi eq)

Type: EnterpriseCompanies (nullable)
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

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

API

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

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