Skip to content
common-domain-model

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" NonNegativeMeasure : multiplier
        click NonNegativeMeasure href "../NonNegativeMeasure/"
    

        
      Money : total
        
          
    
        
        
        Money --> "0..1" Schedule : total
        click Schedule href "../Schedule/"
    

        
      Money : unit
        
          
    
        
        
        Money --> "1" UnitType : unit
        click UnitType href "../UnitType/"
    

        
      Money : value

Inheritance

Section titled “Inheritance”

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
multiplier 0..1
NonNegativeMeasure		 Defines an optional measure that the quantity should be multiplied by to deri… QuantitySchedule
frequency 0..1
Frequency		 Defines the frequency to be used when defining a quantity QuantitySchedule
total 0..1
Schedule		 Specifies the total quantity when the quantity itself is specified with a fre… QuantitySchedule
unit 1
UnitType		 Requires that a unit of amount must be specified for any quantity MeasureBase
value 1
Decimal		 Requires the single rate or amount, as the case may be, to be present Schedule
datedValue *
DatedValue		 The schedule must be absent Schedule
Expressions & Logic

All Of

Section titled “All Of”

The class must satisfy all of:

  • AnonymousClassExpression({ ‘description’: (’From Schedule. ValueExists: A schedule may be specified as a single value or ’ ’as a set of date-value pairs. Both attributes may be specified, in which ’ ‘case the single amount number is the initial value.’), ‘any_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘value’: SlotDefinition({‘name’: ‘value’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘datedValue’: SlotDefinition({‘name’: ‘datedValue’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })] })

Usages

Section titled “Usages”
used by used in type used
MoneyBound money range Money
BillingRecord minimumFee range Money
CollateralBalance amountBaseCurrency range Money
CollateralPosition cashBalance range Money
Exposure aggregateValue range Money
MarginCallBase agreementMinimumTransferAmount range Money
MarginCallBase agreementThreshold range Money
MarginCallBase agreementRounding range Money
MarginCallExposure agreementMinimumTransferAmount range Money
MarginCallExposure agreementThreshold range Money
MarginCallExposure agreementRounding range Money
MarginCallIssuance callAmountInBaseCurrency range Money
MarginCallIssuance agreementMinimumTransferAmount range Money
MarginCallIssuance agreementThreshold range Money
MarginCallIssuance agreementRounding range Money
MarginCallResponse agreedAmountBaseCurrency range Money
MarginCallResponse agreementMinimumTransferAmount range Money
MarginCallResponse agreementThreshold range Money
MarginCallResponse agreementRounding range Money
Valuation amount range Money
ValuationMethod quotationAmount range Money
ValuationMethod minimumQuotationAmount range Money
CalculationPeriod forecastAmount range Money
PaymentCalculationPeriod fixedPaymentAmount range Money
PaymentCalculationPeriod forecastPaymentAmount range Money
PaymentCalculationPeriod presentValueAmount range Money
Position cashBalance range Money
PositionBase cashBalance range Money
AmountOfNetCapital amountOfNetCapital range Money
CustodianTerms minimumAssets range Money
ElectiveAmountElection amount range Money
LegacyIndependentAmountParty fixedAmount range Money
LegacyResolutionAlternative amount range Money
PostedCreditSupportItem cashOrSecurityValue range Money
PostedCreditSupportItem disputedCashOrSecurityValue range Money
ThresholdMinimumTransferAmountFixedAmount amount range Money
StandardizedScheduleInitialMargin netInitialMargin range Money
StandardizedScheduleTradeInfo grossInitialMargin range Money
StandardizedScheduleTradeInfo markToMarketValue range Money
CreditEvents defaultRequirement range Money
FailureToPay paymentRequirement range Money
FixedAmountCalculationDetails calculationPeriodNotionalAmount range Money
StubValue stubAmount range Money
FloatingAmountCalculationDetails calculationPeriodNotionalAmount range Money
CashSettlementTerms cashSettlementAmount range Money
PaymentDetail paymentAmount range Money
PaymentDiscounting presentValueAmount range Money
PercentageRule notionalAmountReference range Money
PrincipalPayment principalAmount range Money
PrincipalPayment presentValuePrincipalAmount range Money
ShapingProvision shapeSchedule range Money
AssetPayout minimumFee range Money
DividendTerms minimumBillingAmount range Money
ExerciseFee notionalReference range Money
ExerciseFeeSchedule notionalReference range Money
MultipleExercise notionalReference range Money
PartialExercise notionalReference range Money

Comments

Section titled “Comments”
  • Rosetta condition CurrencyUnitExists is not stated in LinkML: unit -> currency exists

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Annotations

Section titled “Annotations”
property value
rosetta_metadata key

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:Money
native common_domain_model:Money

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: Money
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: Defines a monetary amount in a specified currency.
comments:
- 'Rosetta condition CurrencyUnitExists is not stated in LinkML: unit -> currency
  exists'
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Quantity
all_of:
- description: 'From Schedule. ValueExists: A schedule may be specified as a single
    value or as a set of date-value pairs. Both attributes may be specified, in which
    case the single amount number is the initial value.'
  any_of:
  - slot_conditions:
      value:
        name: value
        value_presence: PRESENT
  - slot_conditions:
      datedValue:
        name: datedValue
        value_presence: PRESENT

Induced

Section titled “Induced”
name: Money
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: Defines a monetary amount in a specified currency.
comments:
- 'Rosetta condition CurrencyUnitExists is not stated in LinkML: unit -> currency
  exists'
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Quantity
attributes:
  multiplier:
    name: multiplier
    description: Defines an optional measure that the quantity should be multiplied
      by to derive a total quantity. Requires that the multiplier must be positive.
      This number is associated to an optional 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/cdm_base_math
    rank: 1000
    owner: Money
    domain_of:
    - QuantitySchedule
    - FloatingRateProcessingParameters
    range: NonNegativeMeasure
  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/cdm_base_math
    rank: 1000
    owner: Money
    domain_of:
    - QuantitySchedule
    - CSAValuationDate
    range: Frequency
  total:
    name: total
    description: Specifies the total quantity when the quantity itself is specified
      with a frequency.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_math
    rank: 1000
    owner: Money
    domain_of:
    - QuantitySchedule
    range: Schedule
  unit:
    name: unit
    description: Requires that a unit of amount must be specified for any quantity.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Money
    domain_of:
    - MeasureBase
    range: UnitType
    required: true
  value:
    name: value
    description: Requires the single rate or amount, as the case may be, to be present.
      An initial rate of 5% would be represented as 0.05.
    from_schema: https://w3id.org/lmodel/common-domain-model
    owner: Money
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: decimal
    required: true
  datedValue:
    name: datedValue
    description: The schedule must be absent.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Money
    domain_of:
    - Schedule
    range: DatedValue
    multivalued: true
all_of:
- description: 'From Schedule. ValueExists: A schedule may be specified as a single
    value or as a set of date-value pairs. Both attributes may be specified, in which
    case the single amount number is the initial value.'
  any_of:
  - slot_conditions:
      value:
        name: value
        value_presence: PRESENT
  - slot_conditions:
      datedValue:
        name: datedValue
        value_presence: PRESENT