Class: FeaturePayment

Payment made following trigger occurrence.

 classDiagram
    class FeaturePayment
    click FeaturePayment href "../FeaturePayment/"
      FeaturePayment : amount

      FeaturePayment : currency

      FeaturePayment : levelPercentage

      FeaturePayment : payerReceiver





        FeaturePayment --> "1" PartyReferencePayerReceiver : payerReceiver
        click PartyReferencePayerReceiver href "../PartyReferencePayerReceiver/"



      FeaturePayment : paymentDate





        FeaturePayment --> "0..1" AdjustableOrRelativeDate : paymentDate
        click AdjustableOrRelativeDate href "../AdjustableOrRelativeDate/"



      FeaturePayment : time





        FeaturePayment --> "0..1" TimeTypeEnum : time
        click TimeTypeEnum href "../TimeTypeEnum/"

Slots

Name	Cardinality and Range	Description	Inheritance
payerReceiver	1 PartyReferencePayerReceiver	This attribute doesn't exist as part of the FpML construct, which makes use o...	direct
levelPercentage	0..1 Decimal	The trigger level percentage	direct
amount	0..1 Decimal	The monetary quantity in currency units	direct
time	0..1 TimeTypeEnum	The feature payment time	direct
currency	0..1 string	The currency in which an amount is denominated	direct
paymentDate	0..1 AdjustableOrRelativeDate	The feature payment date	direct

Usages

used by	used in	type	used
TriggerEvent	featurePayment	range	FeaturePayment

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'amount': {'required': True}}`	`{'amount': {'minimum_value': 0.0}}`

In Subsets

CdmObservableEvent

Comments

Rosetta condition: FeaturePaymentChoice — required choice levelPercentage, amount
Rosetta condition: Amount — if amount exists then amount >= 0.0

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:FeaturePayment
native	common_domain_model:FeaturePayment

LinkML Source

Direct

name: FeaturePayment
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: Payment made following trigger occurrence.
comments:
- 'Rosetta condition: FeaturePaymentChoice — required choice levelPercentage, amount'
- 'Rosetta condition: Amount — if amount exists then amount >= 0.0'
in_subset:
- cdm_observable_event
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- payerReceiver
- levelPercentage
- amount
- time
- currency
- paymentDate
slot_usage:
  payerReceiver:
    name: payerReceiver
    description: This attribute doesn't exist as part of the FpML construct, which
      makes use of the PayerReceiver.model group.
    range: PartyReferencePayerReceiver
    required: true
  amount:
    name: amount
    description: The monetary quantity in currency units.
    range: decimal
    required: false
  time:
    name: time
    description: The feature payment time.
    range: TimeTypeEnum
    required: false
  currency:
    name: currency
    description: The currency in which an amount is denominated.
rules:
- postconditions:
    exactly_one_of:
    - slot_conditions:
        levelPercentage:
          name: levelPercentage
          required: true
    - slot_conditions:
        amount:
          name: amount
          required: true
  description: ' Choice rule to represent an FpML choice construct.'
- preconditions:
    slot_conditions:
      amount:
        name: amount
        required: true
  postconditions:
    slot_conditions:
      amount:
        name: amount
        minimum_value: 0.0
  description: ' The amount attribute is specified in FpML as non-negative decimal.'

Induced

name: FeaturePayment
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: Payment made following trigger occurrence.
comments:
- 'Rosetta condition: FeaturePaymentChoice — required choice levelPercentage, amount'
- 'Rosetta condition: Amount — if amount exists then amount >= 0.0'
in_subset:
- cdm_observable_event
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  payerReceiver:
    name: payerReceiver
    description: This attribute doesn't exist as part of the FpML construct, which
      makes use of the PayerReceiver.model group.
    range: PartyReferencePayerReceiver
    required: true
  amount:
    name: amount
    description: The monetary quantity in currency units.
    range: decimal
    required: false
  time:
    name: time
    description: The feature payment time.
    range: TimeTypeEnum
    required: false
  currency:
    name: currency
    description: The currency in which an amount is denominated.
attributes:
  payerReceiver:
    name: payerReceiver
    description: This attribute doesn't exist as part of the FpML construct, which
      makes use of the PayerReceiver.model group.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.payerReceiver
    rank: 1000
    owner: FeaturePayment
    domain_of:
    - CalculateTransferInstruction
    - TransferBase
    - CollateralBalance
    - FeaturePayment
    - AssetFlow
    - PayoutBase
    - PrincipalPayment
    - PortfolioReturnTerms
    - PassThroughItem
    range: PartyReferencePayerReceiver
    required: true
  levelPercentage:
    name: levelPercentage
    description: The trigger level percentage.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: FeaturePayment
    domain_of:
    - FeaturePayment
    range: decimal
  amount:
    name: amount
    description: The monetary quantity in currency units.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: FeaturePayment
    domain_of:
    - Valuation
    - ElectiveAmountElection
    - CSAThresholdVariableSet
    - ThresholdMinimumTransferAmountFixedAmount
    - CSAMinimumTransferAmountVariableSet
    - LegacyResolutionAlternative
    - RatingAgencyAmount
    - FeaturePayment
    - ComputedAmount
    range: decimal
    required: false
  time:
    name: time
    description: The feature payment time.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: FeaturePayment
    domain_of:
    - TimeZone
    - ValuationTime
    - FeaturePayment
    range: TimeTypeEnum
    required: false
  currency:
    name: currency
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: The currency in which an amount is denominated.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: FeaturePayment
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - MinimumTransferAmountRatingsBased
    - LegacyIndependentAmountRatingsBased
    - FloatingRateIndexIdentification
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - AmountSchedule
    - CollateralInterestParameters
    - ComputedAmount
    range: string
  paymentDate:
    name: paymentDate
    description: The feature payment date.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: FeaturePayment
    domain_of:
    - FeaturePayment
    - InterestRatePayout
    - PaymentDetail
    - SchedulePeriod
    range: AdjustableOrRelativeDate
rules:
- postconditions:
    exactly_one_of:
    - slot_conditions:
        levelPercentage:
          name: levelPercentage
          required: true
    - slot_conditions:
        amount:
          name: amount
          required: true
  description: ' Choice rule to represent an FpML choice construct.'
- preconditions:
    slot_conditions:
      amount:
        name: amount
        required: true
  postconditions:
    slot_conditions:
      amount:
        name: amount
        minimum_value: 0.0
  description: ' The amount attribute is specified in FpML as non-negative decimal.'