Finance.Assets.DepreciationMethods Entity

Depreciation methods. Contains both system-defined and user-defined methods. Entity: Ast_Depreciation_Methods

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Name
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

Finance.Assets.DepreciationMethods

Attributes

Name	Type	Description
DepreciationFunction	DepreciationFunction	Basic mathematical depreciation function used to calculate asset depreciation. STL=Straight Line, SYD=Sum of Years Digits, FAC=Depreciation change by factor, TAB=User defined with table. `Required` `Default("STL")`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Factor	decimal (5, 3)	Factor used in factor depreciation function. Factor < 1 means declining depreciation; >1 - increasing. The depreciation is multiplied for each period by the factor. `Required` `Default(1)`
Id	guid
IsSystem	boolean	Is_System is True for those depreciation methods that are managed by the system via update procedures and cannot be edited by the user. `Required` `Default(false)` `Filter(eq)` `ReadOnly`
MonthsInAPeriod	int32	Number of equal valued months calculated with single application of the function. `Required` `Default(12)`
Name	MultilanguageString (254)	Multilanguage string. `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.
PeriodDeterminationMethod	PeriodDeterminationMethod	Determines when the depreciation starts and when it ends. NM=Next_Month, CM=Current_Month, BD=By_Days. `Required`
StartFromNextMonth	boolean	When true, denotes that the depreciation starts from the month, following the month of deployment. When false, the depreciation starts from the same month. `Required` `Default(true)` `ReadOnly`

Attribute Details

DepreciationFunction

Basic mathematical depreciation function used to calculate asset depreciation. STL=Straight Line, SYD=Sum of Years Digits, FAC=Depreciation change by factor, TAB=User defined with table. Required Default("STL")

Type: DepreciationFunction
Category: System
Allowed values for the DepreciationFunction(Finance.Assets.DepreciationMethods.md#depreciationfunction) data attribute
Allowed Values (Finance.Assets.DepreciationMethodsRepository.DepreciationFunction Enum Members)

Value	Description
DepreciationChangeByFactor	DepreciationChangeByFactor value. Stored as 'FAC'. Database Value: 'FAC' Model Value: 0 Domain API Value: 'DepreciationChangeByFactor'
StraightLine	StraightLine value. Stored as 'STL'. Database Value: 'STL' Model Value: 1 Domain API Value: 'StraightLine'
SumOfYearsDigits	SumOfYearsDigits value. Stored as 'SYD'. Database Value: 'SYD' Model Value: 2 Domain API Value: 'SumOfYearsDigits'
UserDefinedWithTable	UserDefinedWithTable value. Stored as 'TAB'. Database Value: 'TAB' Model Value: 3 Domain API Value: 'UserDefinedWithTable'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: StraightLine
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

Factor

Factor used in factor depreciation function. Factor < 1 means declining depreciation; >1 - increasing. The depreciation is multiplied for each period by the factor. Required Default(1)

Type: decimal (5, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 1
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 depreciation methods 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

MonthsInAPeriod

Number of equal valued months calculated with single application of the function. Required Default(12)

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

Name

Multilanguage string. Required Filter(like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Like
Supports Order By: False
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

PeriodDeterminationMethod

Determines when the depreciation starts and when it ends. NM=Next_Month, CM=Current_Month, BD=By_Days. Required

Type: PeriodDeterminationMethod
Category: System
Allowed values for the PeriodDeterminationMethod(Finance.Assets.DepreciationMethods.md#perioddeterminationmethod) data attribute
Allowed Values (Finance.Assets.DepreciationMethodsRepository.PeriodDeterminationMethod Enum Members)

Value	Description
NextMonth	NextMonth value. Stored as 'NM'. Database Value: 'NM' Model Value: 0 Domain API Value: 'NextMonth'
CurrentMonth	CurrentMonth value. Stored as 'CM'. Database Value: 'CM' Model Value: 1 Domain API Value: 'CurrentMonth'
ByDays	ByDays value. Stored as 'BD'. Database Value: 'BD' Model Value: 2 Domain API Value: 'ByDays'

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

StartFromNextMonth

When true, denotes that the depreciation starts from the month, following the month of deployment. When false, the depreciation starts from the same month. Required Default(true) ReadOnly

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: True
Show in UI: CannotBeShown

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