Table of Contents

Finance.Accounting.AccountingVoucherLines

Contains the individual debit or credit lines that make up an accounting voucher. Each line records a single entry to a specific account, possibly with analytical dimensions.

General

Namespace: Finance.Accounting
Repository: Finance.Accounting.AccountingVoucherLines
Base Table: Acc_Voucher_Lines
API access: ReadWrite

Visualization

Display Format: {LineNo}. {Voucher.DocumentNo} {Voucher.DocumentType.TypeName:T}
Search Members: Voucher.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.Accounting.AccountingVouchers
Aggregate Root:
Finance.Accounting.AccountingVouchers

Attributes

Name Type Description
CorrespondanceNo int32 The number of the correspondence group within the accounting voucher. For each correspondence group, the debits are equal to the creditsRequired Default(0)
CorrespondantAmount decimal (18, 2) nullable The amount (in the currency of the correspondent line) to which the amount in this line is corresponding if the current line is corresponding to only one line.ReadOnly
Credit Amount (18, 2) The amount of the credit in the currency of the account. 0 means that the account is not creditedCurrency: Currency Required Default(0)
CreditBase Amount (18, 2) The amount of credit in base currencyCurrency: Voucher.EnterpriseCompany.BaseCurrency Required Default(0)
CreditReporting Amount (18, 2) nullable The amount of credit in reporting currency.Currency: Voucher.EnterpriseCompany.ReportingCurrency Introduced in version 25.1.2.88
Debit Amount (18, 2) The amount of the debit in the currency of the account. 0 means that the account is not debitedCurrency: Currency Required Default(0)
DebitBase Amount (18, 2) The amount of debit in base currencyCurrency: Voucher.EnterpriseCompany.BaseCurrency Required Default(0)
DebitReporting Amount (18, 2) nullable The amount of debit in reporting currency.Currency: Voucher.EnterpriseCompany.ReportingCurrency Introduced in version 25.1.2.88
ItemKey string (64) nullable The item (grouping) key for the account in the line. Account_Id + Item_Key - the smallest unit of calculation for account balance.Filter(eq;like)
LineNo int32 Consecutive number of the line within the voucherRequired
RateDivisor decimal (18, 6) The divisor for conversion from Debit/Credit to base currencyRequired Default(1)
RateDivisorRC decimal (18, 6) nullable The divisor for conversion from Debit/Credit to Reporting currency.Introduced in version 26.1.3.74
RateMultiplier decimal (18, 6) The multiplier for conversion from Debit/Credit to base currencyRequired Default(1)
RateMultiplierRC decimal (18, 6) nullable The multiplier for conversion from Debit/Credit to Reporting currency.Introduced in version 26.1.3.74

References

Name Type Description
Account Accounts The account being debited or credited
CostCenter CostCenters (nullable) The cost center to which this cost is related
Currency Currencies The currency of the movement in this line. If there is defined currency for the account in the line that it should be equal to the value in this field.
Document AccountingVouchers The owner document. The voucher to which this line is attached. Required Filter(multi eq)
ProfitCenter ProfitCenters (nullable) The profit center to which this revenue is related
ReferencedDocument Documents The document which is referenced by the line. By default, this is the document of the voucher
Voucher AccountingVouchers The voucher to which this line is attached

System Attributes

Name Type Description
Id guid
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.
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Attribute Details

CorrespondanceNo

The number of the correspondence group within the accounting voucher. For each correspondence group, the debits are equal to the creditsRequired Default(0)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

CorrespondantAmount

The amount (in the currency of the correspondent line) to which the amount in this line is corresponding if the current line is corresponding to only one line.ReadOnly

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

Credit

The amount of the credit in the currency of the account. 0 means that the account is not creditedCurrency: Currency Required Default(0)

Type: Amount (18, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

CreditBase

The amount of credit in base currencyCurrency: Voucher.EnterpriseCompany.BaseCurrency Required Default(0)

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

CreditReporting

The amount of credit in reporting currency.Currency: Voucher.EnterpriseCompany.ReportingCurrency Introduced in version 25.1.2.88

Type: Amount (18, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
obj.SetDefaultsToRCattributes( obj.CreditReporting, "CreditReporting")

Debit

The amount of the debit in the currency of the account. 0 means that the account is not debitedCurrency: Currency Required Default(0)

Type: Amount (18, 2)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

DebitBase

The amount of debit in base currencyCurrency: Voucher.EnterpriseCompany.BaseCurrency Required Default(0)

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

DebitReporting

The amount of debit in reporting currency.Currency: Voucher.EnterpriseCompany.ReportingCurrency Introduced in version 25.1.2.88

Type: Amount (18, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
obj.SetDefaultsToRCattributes( obj.DebitReporting, "DebitReporting")

ItemKey

The item (grouping) key for the account in the line. Account_Id + Item_Key - the smallest unit of calculation for account balance.Filter(eq;like)

Type: string (64) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 64
Show in UI: HiddenByDefault

LineNo

Consecutive number of the line within the voucherRequired

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

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

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

RateDivisor

The divisor for conversion from Debit/Credit to base currencyRequired Default(1)

Type: decimal (18, 6)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 1
Show in UI: HiddenByDefault

RateDivisorRC

The divisor for conversion from Debit/Credit to Reporting currency.Introduced in version 26.1.3.74

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

Back-End Default Expression:
obj.SetDefaultsToRCattributes( Convert( obj.RateDivisorRC, Object), "RateDivisorRC")

Front-End Recalc Expressions:
IIF( ( ( ( ( ( ( ( ( obj.Account != null) AndAlso ( obj.Currency != null)) AndAlso ( obj.Voucher.EnterpriseCompany.ReportingCurrency != null)) AndAlso Not( obj.Voucher.EnterpriseCompany.ReportingCurrency.IsGhost)) AndAlso ( ( obj.ItemKey != null) OrElse True)) AndAlso ( ( obj.ReferencedDocument == null) OrElse True)) AndAlso ( ( obj.Debit.Value != 0) OrElse True)) AndAlso ( ( obj.Credit.Value != 0) OrElse True)), obj.SetMultiplierAndDivisorRC( ).Item2, obj.RateDivisorRC)

RateMultiplier

The multiplier for conversion from Debit/Credit to base currencyRequired Default(1)

Type: decimal (18, 6)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 1
Show in UI: HiddenByDefault

RateMultiplierRC

The multiplier for conversion from Debit/Credit to Reporting currency.Introduced in version 26.1.3.74

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

Back-End Default Expression:
obj.SetDefaultsToRCattributes( Convert( obj.RateMultiplierRC, Object), "RateMultiplierRC")

Front-End Recalc Expressions:
IIF( ( ( ( ( ( ( ( ( obj.Account != null) AndAlso ( obj.Currency != null)) AndAlso ( obj.Voucher.EnterpriseCompany.ReportingCurrency != null)) AndAlso Not( obj.Voucher.EnterpriseCompany.ReportingCurrency.IsGhost)) AndAlso ( ( obj.ItemKey != null) OrElse True)) AndAlso ( ( obj.ReferencedDocument == null) OrElse True)) AndAlso ( ( obj.Debit.Value != 0) OrElse True)) AndAlso ( ( obj.Credit.Value != 0) OrElse True)), obj.SetMultiplierAndDivisorRC( ).Item1, obj.RateMultiplierRC)

Id

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

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

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

Reference Details

Account

The account being debited or credited

Type: Accounts
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

CostCenter

The cost center to which this cost is related

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

Currency

The currency of the movement in this line. If there is defined currency for the account in the line that it should be equal to the value in this field.

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

Document

The owner document. The voucher to which this line is attached. Required Filter(multi eq)

Type: AccountingVouchers
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ProfitCenter

The profit center to which this revenue is related

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

ReferencedDocument

The document which is referenced by the line. By default, this is the document of the voucher

Type: Documents
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Back-End Default Expression:
IIF( ( obj.Voucher.DefaultReferencedDocument != null), obj.Voucher.DefaultReferencedDocument, Convert( obj.Voucher, Document))

Voucher

The voucher to which this line is attached

Type: AccountingVouchers
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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

  • priority
    The notification priority.
    Type: Systems.Core.NotificationsRepository.Priority
    Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
    Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

    Value Description
    Background Background value. Stored as 1.
    Model Value: 1
    Domain API Value: 'Background'
    Low Low value. Stored as 2.
    Model Value: 2
    Domain API Value: 'Low'
    Normal Normal value. Stored as 3.
    Model Value: 3
    Domain API Value: 'Normal'
    High High value. Stored as 4.
    Model Value: 4
    Domain API Value: 'High'
    Urgent Urgent value. Stored as 5.
    Model Value: 5
    Domain API Value: 'Urgent'

    Optional: True
    Default Value: Normal

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

Front-End Business Rules

API

Domain API Entity Set: Finance_Accounting_AccountingVoucherLines

Domain API Entity Type: Finance_Accounting_AccountingVoucherLine

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

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

Suggest improvement to this page