General.CurrencyDirectoryLines Entity

Namespace: General

Contains exchange rate for a currency against the main currency of currency directory. Entity: Gen_Currency_Directory_Lines

Default Visualization

Default Display Text Format:
{CurrencyDirectory.Name}
Default Search Members:
CurrencyDirectory.Name
Name Data Member:
CurrencyDirectory.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 Parent:
General.CurrencyDirectories
Aggregate Root:
General.CurrencyDirectories

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
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.
RateDivisor	decimal (18, 6)	The divisor for conversion from From_Currency to Directory.To_Currency. `Required` `Default(1)`
RateMultiplier	decimal (18, 6)	The multiplier for conversion from From_Currency to Directory.To_Currency. `Required` `Default(1)`

References

Name	Type	Description
CurrencyDirectory	CurrencyDirectories	The to which this CurrencyDirectoryLine belongs. `Required` `Filter(multi eq)` `Owner`
FromCurrency	Currencies	The currency for which the exchange rate is recorded. `Required` `Filter(multi eq)`

Attribute Details

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

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

RateDivisor

The divisor for conversion from From_Currency to Directory.To_Currency. Required Default(1)

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

RateMultiplier

The multiplier for conversion from From_Currency to Directory.To_Currency. Required Default(1)

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

Reference Details

CurrencyDirectory

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

Type: CurrencyDirectories
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

FromCurrency

The currency for which the exchange rate is recorded. Required Filter(multi eq)

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