Class: PrincipalPayment

Any kind of principal payments when the amount is known and thus fixed.

URI: common_domain_model:PrincipalPayment

 classDiagram
    class PrincipalPayment
    click PrincipalPayment href "../PrincipalPayment/"
      PrincipalPayment : discountFactor

      PrincipalPayment : payerReceiver





        PrincipalPayment --> "0..1" PayerReceiver : payerReceiver
        click PayerReceiver href "../PayerReceiver/"



      PrincipalPayment : presentValuePrincipalAmount





        PrincipalPayment --> "0..1" Money : presentValuePrincipalAmount
        click Money href "../Money/"



      PrincipalPayment : principalAmount





        PrincipalPayment --> "0..1" Money : principalAmount
        click Money href "../Money/"



      PrincipalPayment : principalPaymentDate





        PrincipalPayment --> "0..1" AdjustableDate : principalPaymentDate
        click AdjustableDate href "../AdjustableDate/"

Slots

Name	Cardinality and Range	Description	Inheritance
principalPaymentDate	0..1 AdjustableDate	The date where the PrincipalPayment shall be settled	direct
payerReceiver	0..1 PayerReceiver	Specifies the parties responsible for making and receiving payments defined b...	direct
principalAmount	0..1 Money	When known at the time the transaction is made, the cash amount to be paid	direct
discountFactor	0..1 Decimal	The value representing the discount factor used to calculate the present valu...	direct
presentValuePrincipalAmount	0..1 Money	The amount representing the present value of the principal payment	direct

Usages

used by	used in	type	used
PrincipalPaymentSchedule	initialPrincipalPayment	range	PrincipalPayment
PrincipalPaymentSchedule	finalPrincipalPayment	range	PrincipalPayment

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'presentValuePrincipalAmount': {'required': True}}`	`{'discountFactor': {'required': True}}`

In Subsets

CdmProductCommonSettlement

Comments

Rosetta condition: PrincipalAmount — optional choice principalAmount, presentValuePrincipalAmount
Rosetta condition: DiscountFactor — if presentValuePrincipalAmount exists then discountFactor 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:PrincipalPayment
native	common_domain_model:PrincipalPayment

LinkML Source

Direct

name: PrincipalPayment
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: Any kind of principal payments when the amount is known and thus fixed.
comments:
- 'Rosetta condition: PrincipalAmount — optional choice principalAmount, presentValuePrincipalAmount'
- 'Rosetta condition: DiscountFactor — if presentValuePrincipalAmount exists then
  discountFactor exists'
in_subset:
- cdm_product_common_settlement
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- principalPaymentDate
- payerReceiver
- principalAmount
- discountFactor
- presentValuePrincipalAmount
slot_usage:
  payerReceiver:
    name: payerReceiver
    description: Specifies the parties responsible for making and receiving payments
      defined by this structure.
  discountFactor:
    name: discountFactor
    description: The value representing the discount factor used to calculate the
      present value of the principal payment amount.
rules:
- postconditions:
    any_of:
    - slot_conditions:
        principalAmount:
          name: principalAmount
          required: true
    - slot_conditions:
        presentValuePrincipalAmount:
          name: presentValuePrincipalAmount
          required: true
  description: PrincipalAmount
- preconditions:
    slot_conditions:
      presentValuePrincipalAmount:
        name: presentValuePrincipalAmount
        required: true
  postconditions:
    slot_conditions:
      discountFactor:
        name: discountFactor
        required: true
  description: DiscountFactor

Induced

name: PrincipalPayment
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: Any kind of principal payments when the amount is known and thus fixed.
comments:
- 'Rosetta condition: PrincipalAmount — optional choice principalAmount, presentValuePrincipalAmount'
- 'Rosetta condition: DiscountFactor — if presentValuePrincipalAmount exists then
  discountFactor exists'
in_subset:
- cdm_product_common_settlement
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  payerReceiver:
    name: payerReceiver
    description: Specifies the parties responsible for making and receiving payments
      defined by this structure.
  discountFactor:
    name: discountFactor
    description: The value representing the discount factor used to calculate the
      present value of the principal payment amount.
attributes:
  principalPaymentDate:
    name: principalPaymentDate
    description: The date where the PrincipalPayment shall be settled.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayment
    domain_of:
    - PrincipalPayment
    range: AdjustableDate
  payerReceiver:
    name: payerReceiver
    description: Specifies the parties responsible for making and receiving payments
      defined by this structure.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.payerReceiver
    rank: 1000
    owner: PrincipalPayment
    domain_of:
    - CalculateTransferInstruction
    - TransferBase
    - CollateralBalance
    - FeaturePayment
    - AssetFlow
    - PayoutBase
    - PrincipalPayment
    - PortfolioReturnTerms
    - PassThroughItem
    range: PayerReceiver
  principalAmount:
    name: principalAmount
    description: When known at the time the transaction is made, the cash amount to
      be paid.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayment
    domain_of:
    - PrincipalPayment
    range: Money
  discountFactor:
    name: discountFactor
    description: The value representing the discount factor used to calculate the
      present value of the principal payment amount.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayment
    domain_of:
    - PaymentCalculationPeriod
    - PaymentDiscounting
    - PrincipalPayment
    range: decimal
  presentValuePrincipalAmount:
    name: presentValuePrincipalAmount
    description: The amount representing the present value of the principal payment.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: PrincipalPayment
    domain_of:
    - PrincipalPayment
    range: Money
rules:
- postconditions:
    any_of:
    - slot_conditions:
        principalAmount:
          name: principalAmount
          required: true
    - slot_conditions:
        presentValuePrincipalAmount:
          name: presentValuePrincipalAmount
          required: true
  description: PrincipalAmount
- preconditions:
    slot_conditions:
      presentValuePrincipalAmount:
        name: presentValuePrincipalAmount
        required: true
  postconditions:
    slot_conditions:
      discountFactor:
        name: discountFactor
        required: true
  description: DiscountFactor