Finance.Accounting.TemplateLines Entity

Namespace: Finance.Accounting

Each template line contains the posting to a single set of debit and credit account. It also specifies the way to calculate the amount. Entity: Acc_Template_Lines

Default Visualization

Default Display Text Format:
{AmountColumnName}
Default Search Members:
AmountColumnName
Name Data Member:
AmountColumnName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Parent:
Finance.Accounting.Templates
Aggregate Root:
General.DocumentTypes

Attributes

Name Type Description
AmountColumnName string (64) The name of the column within the amount rowset where the amount is located. Required
AmountCondition AmountCondition nullable Condition for the amount. The line is accounted only when the condition is matched. The condition can be one of: null - no condition, the line should be accounted unconditionally; '+' - The amount should be positive; '-' - The amount should be negative. The amount is matched as returned from the source, before applying the Multiplier.
AmountRowId guid nullable The id of the row from the amount rowset where the amount is located. null means to account one by one for all rows within the rowset. Filter(multi eq)
AmountRowName string (254) nullable The name of definition, specified in Amount_Row_Id. null means that no Amount_Row_Id is specified or there is no name.
AmountSourceFilter dataaccessfilter nullable Filter that further specifies which rows from the amount rowset determine the amount.
AmountSourceName string (64) The source rowset for the amount. For example: DocLines, DocHeader, Additional Amounts, Stock Types, etc. Required
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FilterXML dataaccessfilter nullable The line is accounted only when the filter is satisfied compared with the source document header.
Id guid
LineNo int32 Consecutive number of the line within the template. Determines the order of execution of the template lines. Required
Multiplier decimal (18, 6) Factor by which the amount from the source will be multiplied. Required Default(1)
Notes string (254) nullable Notes for this TemplateLine.
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.
ValidFromDate datetime nullable Start date from which the accounting template line is valid. Filter(multi eq;ge;le)
ValidToDate datetime nullable End date to which the accounting template line is valid. Filter(multi eq;ge;le)

References

Name Type Description
CreditAccount Accounts The account which should be credited. Required Filter(multi eq)
DebitAccount Accounts The account which should be debited. Required Filter(multi eq)
Template Templates The to which this TemplateLine belongs. Required Filter(multi eq) Owner

Child Collections

Name Type Description
TemplateLineProperties TemplateLineProperties List of TemplateLineProperty(Finance.Accounting.TemplateLineProperties.md) child objects, based on the Finance.Accounting.TemplateLineProperty.TemplateLine(Finance.Accounting.TemplateLineProperties.md#templateline) back reference

Attribute Details

AmountColumnName

The name of the column within the amount rowset where the amount is located. Required

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

AmountCondition

Condition for the amount. The line is accounted only when the condition is matched. The condition can be one of: null - no condition, the line should be accounted unconditionally; '+' - The amount should be positive; '-' - The amount should be negative. The amount is matched as returned from the source, before applying the Multiplier.

Type: AmountCondition nullable
Category: System
Allowed values for the AmountCondition(Finance.Accounting.TemplateLines.md#amountcondition) data attribute
Allowed Values (Finance.Accounting.TemplateLinesRepository.AmountCondition Enum Members)

Value Description
Positive Positive value. Stored as '+'.
Database Value: '+'
Model Value: 0
Domain API Value: 'Positive'
Negative Negative value. Stored as '-'.
Database Value: '-'
Model Value: 1
Domain API Value: 'Negative'

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

AmountRowId

The id of the row from the amount rowset where the amount is located. null means to account one by one for all rows within the rowset. Filter(multi eq)

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

AmountRowName

The name of definition, specified in Amount_Row_Id. null means that no Amount_Row_Id is specified or there is no name.

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

AmountSourceFilter

Filter that further specifies which rows from the amount rowset determine the amount.

Type: dataaccessfilter nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

AmountSourceName

The source rowset for the amount. For example: DocLines, DocHeader, Additional Amounts, Stock Types, etc. Required

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

FilterXML

The line is accounted only when the filter is satisfied compared with the source document header.

Type: dataaccessfilter nullable
Category: System
Supported Filters: NotFilterable
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

LineNo

Consecutive number of the line within the template. Determines the order of execution of the template lines. Required

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

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

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

Multiplier

Factor by which the amount from the source will be multiplied. Required Default(1)

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

Notes

Notes for this TemplateLine.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
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

ValidFromDate

Start date from which the accounting template line is valid. Filter(multi eq;ge;le)

Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

ValidToDate

End date to which the accounting template line is valid. Filter(multi eq;ge;le)

Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

CreditAccount

The account which should be credited. Required Filter(multi eq)

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

DebitAccount

The account which should be debited. Required Filter(multi eq)

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

Template

The to which this TemplateLine belongs. Required Filter(multi eq) Owner

Type: Templates
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

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_TemplateLines?$top=10

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