Class: Money
Defines a monetary amount in a specified currency.
URI: common_domain_model:Money
classDiagram
class Money
click Money href "../Money/"
Quantity <|-- Money
click Quantity href "../Quantity/"
Money : datedValue
Money --> "*" DatedValue : datedValue
click DatedValue href "../DatedValue/"
Money : frequency
Money --> "0..1" Frequency : frequency
click Frequency href "../Frequency/"
Money : multiplier
Money --> "0..1" Measure : multiplier
click Measure href "../Measure/"
Money : unit
Money --> "0..1" UnitType : unit
click UnitType href "../UnitType/"
Money : value
Inheritance
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| multiplier | 0..1 Measure |
Defines an optional number that the quantity should be multiplied by to deriv... | QuantitySchedule |
| frequency | 0..1 Frequency |
Defines the frequency to be used when defining a quantity | QuantitySchedule |
| datedValue | * DatedValue |
A schedule of step date and value pairs | MeasureSchedule |
| value | 0..1 Decimal |
Specifies the value of the measure as a number | MeasureBase |
| unit | 0..1 UnitType |
Qualifies the unit by which the amount is measured | MeasureBase |
Usages
In Subsets
Comments
- Rosetta condition: CurrencyUnitExists — unit -> currency exists
Identifier and Mapping Information
Annotations
| property | value |
|---|---|
| metadata_key | True |
Schema Source
- from schema: https://w3id.org/lmodel/common-domain-model
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | common_domain_model:Money |
| native | common_domain_model:Money |
| close | gist:Magnitude |
LinkML Source
Direct
name: Money
annotations:
metadata_key:
tag: metadata_key
value: true
description: Defines a monetary amount in a specified currency.
comments:
- 'Rosetta condition: CurrencyUnitExists — unit -> currency exists'
in_subset:
- cdm_observable_asset
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- gist:Magnitude
is_a: Quantity
Induced
name: Money
annotations:
metadata_key:
tag: metadata_key
value: true
description: Defines a monetary amount in a specified currency.
comments:
- 'Rosetta condition: CurrencyUnitExists — unit -> currency exists'
in_subset:
- cdm_observable_asset
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- gist:Magnitude
is_a: Quantity
attributes:
multiplier:
name: multiplier
description: Defines an optional number that the quantity should be multiplied
by to derive a total quantity. This number is associated to a unit. For example
in the case of the Coal (API2) CIF ARA (ARGUS-McCloskey) Futures Contract on
the CME, where the unit would be contracts, the multiplier value would 1,000
and the mulitiplier unit would be 1,000 MT (Metric Tons).
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Money
domain_of:
- QuantitySchedule
- FloatingRateProcessingParameters
range: Measure
frequency:
name: frequency
description: Defines the frequency to be used when defining a quantity. For example
a quantity may be specified as a number of barrels of oil per day, which needs
multiplying by the number of days in the relevant period to get the total quantity
as a number of barrels.
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Money
domain_of:
- QuantitySchedule
- CSAValuationDate
range: Frequency
datedValue:
name: datedValue
description: A schedule of step date and value pairs. On each step date the associated
step value becomes effective. The step dates are used to order the steps by
ascending order. This attribute is optional so the data type may be used to
define a schedule with a single value.
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Money
domain_of:
- MeasureSchedule
- Schedule
range: DatedValue
multivalued: true
inlined: true
inlined_as_list: true
value:
name: value
description: Specifies the value of the measure as a number. Optional because
in a measure vector or schedule, this single value may be omitted.
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Money
domain_of:
- MeasureBase
- Schedule
- DatedValue
- Taxonomy
- TaxonomyClassification
- CodeValue
- AdjustmentFactor
- AccrualFactor
- DisputeResolution
- OtherEligibleAndPostedSupport
- CSAThresholdVariableSet
- CSAMinimumTransferAmountVariableSet
- MasterAgreementVariableSet
range: decimal
unit:
name: unit
description: Qualifies the unit by which the amount is measured. Optional because
a measure may be unit-less (e.g. when representing a ratio between amounts in
the same unit).
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Money
domain_of:
- MeasureBase
- Qty
- Term
range: UnitType