Class: PrincipalPayments

A class defining which principal exchanges occur for the stream.

URI: common_domain_model:PrincipalPayments

 classDiagram
    class PrincipalPayments
    click PrincipalPayments href "../PrincipalPayments/"
      PrincipalPayments : finalPayment

      PrincipalPayments : initialPayment

      PrincipalPayments : intermediatePayment

      PrincipalPayments : principalPaymentSchedule





        PrincipalPayments --> "0..1" PrincipalPaymentSchedule : principalPaymentSchedule
        click PrincipalPaymentSchedule href "../PrincipalPaymentSchedule/"



      PrincipalPayments : varyingLegNotionalCurrency

Slots

Name	Cardinality and Range	Description	Inheritance
initialPayment	1 Boolean	A true/false flag to indicate whether there is an initial exchange of princip...	direct
finalPayment	1 Boolean	A true/false flag to indicate whether there is a final exchange of principal ...	direct
intermediatePayment	1 Boolean	A true/false flag to indicate whether there are intermediate or interim excha...	direct
varyingLegNotionalCurrency	* string	Indicate the Payout legs which nominal amount may vary in regards of FX Fixin...	direct
principalPaymentSchedule	0..1 PrincipalPaymentSchedule	Describe dates schedules for Principal Exchanges and related role of the part...	direct

Usages

used by	used in	type	used
CommodityPayout	principalPayment	range	PrincipalPayments
CreditDefaultPayout	principalPayment	range	PrincipalPayments
InterestRatePayout	principalPayment	range	PrincipalPayments
PayoutBase	principalPayment	range	PrincipalPayments
OptionPayout	principalPayment	range	PrincipalPayments
PerformancePayout	principalPayment	range	PrincipalPayments
SettlementPayout	principalPayment	range	PrincipalPayments
FixedPricePayout	principalPayment	range	PrincipalPayments
AssetPayout	principalPayment	range	PrincipalPayments

In Subsets

CdmProductCommonSettlement

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

LinkML Source

Direct

name: PrincipalPayments
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: A class defining which principal exchanges occur for the stream.
in_subset:
- cdm_product_common_settlement
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- initialPayment
- finalPayment
- intermediatePayment
- varyingLegNotionalCurrency
- principalPaymentSchedule

Induced

name: PrincipalPayments
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: A class defining which principal exchanges occur for the stream.
in_subset:
- cdm_product_common_settlement
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  initialPayment:
    name: initialPayment
    description: A true/false flag to indicate whether there is an initial exchange
      of principal on the effective date.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayments
    domain_of:
    - PrincipalPayments
    range: boolean
    required: true
  finalPayment:
    name: finalPayment
    description: A true/false flag to indicate whether there is a final exchange of
      principal on the termination date.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayments
    domain_of:
    - PrincipalPayments
    range: boolean
    required: true
  intermediatePayment:
    name: intermediatePayment
    description: A true/false flag to indicate whether there are intermediate or interim
      exchanges of principal during the term of the swap.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayments
    domain_of:
    - PrincipalPayments
    range: boolean
    required: true
  varyingLegNotionalCurrency:
    name: varyingLegNotionalCurrency
    description: Indicate the Payout legs which nominal amount may vary in regards
      of FX Fixing dates as determined in the product terms.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayments
    domain_of:
    - PrincipalPayments
    range: string
    multivalued: true
  principalPaymentSchedule:
    name: principalPaymentSchedule
    description: Describe dates schedules for Principal Exchanges and related role
      of the parties when known.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayments
    domain_of:
    - PrincipalPayments
    range: PrincipalPaymentSchedule