Finance.Accounting.TemplateLineProperties Entity

Namespace: Finance.Accounting

Contains the way to obtain the values for each required property of both the debit and the credit accounts. Entity: Acc_Template_Line_Properties

Default Visualization

Default Display Text Format:
{TemplateLine.AmountColumnName}
Default Search Members:
TemplateLine.AmountColumnName
Name Data Member:
TemplateLine.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.TemplateLines
Aggregate Root:
Systems.Documents.DocumentTypes

Attributes

Name	Type	Description
ConstantValueId	guid nullable	The internal Id of a property value, selected as constant value. Applicable only when Property Value Source Type = Constant. `Filter(multi eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsDebit	boolean	If Is_Debit=true then this property is for the debit account in the template line for which is this record. If Is_Debit=false then the property is for the credit account. `Required` `Default(true)` `Filter(eq)`
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.
PropertyDescription	MultilanguageString (254) nullable	Description for the property value that should be used when the description can't be determined by the source (e.g. when the source type is constant).
PropertyNo	int32	The ordinal position of the property value in the item key of the account. `Required` `Filter(eq)`
PropertyValueSource	string (2000)	Source for the property value according to the chosen source type. `Required`
PropertyValueSourceType	string (64)	Type of source for the property value. For example: System properties, User properties for document, Constant, ... `Required`

References

Name	Type	Description
Property	CustomProperties	The property which value will be included in the item key of the account. `Required` `Filter(multi eq)`
TemplateLine	TemplateLines	The to which this TemplateLineProperty belongs. `Required` `Filter(multi eq)` `Owner`

Attribute Details

ConstantValueId

The internal Id of a property value, selected as constant value. Applicable only when Property Value Source Type = Constant. Filter(multi eq)

Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
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

IsDebit

If Is_Debit=true then this property is for the debit account in the template line for which is this record. If Is_Debit=false then the property is for the credit account. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
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

PropertyDescription

Description for the property value that should be used when the description can't be determined by the source (e.g. when the source type is constant).

Type: MultilanguageString (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault

PropertyNo

The ordinal position of the property value in the item key of the account. Required Filter(eq)

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

PropertyValueSource

Source for the property value according to the chosen source type. Required

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

PropertyValueSourceType

Type of source for the property value. For example: System properties, User properties for document, Constant, ... Required

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

Reference Details

Property

The property which value will be included in the item key of the account. Required Filter(multi eq)

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

TemplateLine

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

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