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

Expressions & Logic

All Of

The class must satisfy all of:

• AnonymousClassExpression({ ‘description’: ‘PrincipalAmount’, ‘exactly_one_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘principalAmount’: SlotDefinition({‘name’: ‘principalAmount’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘presentValuePrincipalAmount’: SlotDefinition({ ‘name’: ‘presentValuePrincipalAmount’, ‘value_presence’: PresenceEnum(text=‘PRESENT’) })} }), AnonymousClassExpression({ ‘all_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘principalAmount’: SlotDefinition({‘name’: ‘principalAmount’, ‘value_presence’: PresenceEnum(text=‘ABSENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘presentValuePrincipalAmount’: SlotDefinition({ ‘name’: ‘presentValuePrincipalAmount’, ‘value_presence’: PresenceEnum(text=‘ABSENT’) })} })] })] })

Usages

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

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	{'presentValuePrincipalAmount': {'value_presence': 'PRESENT'}}	{'discountFactor': {'value_presence': 'PRESENT'}}

Identifier and Mapping Information

Annotations

property	value
rosetta_metadata	key

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:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: Any kind of principal payments when the amount is known and thus fixed.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  principalPaymentDate:
    name: principalPaymentDate
    description: The date where the PrincipalPayment shall be settled.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    rank: 1000
    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/cdm_product_common_settlement
    domain_of:
    - CalculateTransferInstruction
    - CollateralBalance
    - PayoutTransferBase
    - FeaturePayment
    - PayoutBase
    - PrincipalPayment
    - PassThroughItem
    - PortfolioReturnTerms
    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/cdm_product_common_settlement
    rank: 1000
    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/cdm_product_common_settlement
    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/cdm_product_common_settlement
    rank: 1000
    domain_of:
    - PrincipalPayment
    range: Money
rules:
- preconditions:
    slot_conditions:
      presentValuePrincipalAmount:
        name: presentValuePrincipalAmount
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      discountFactor:
        name: discountFactor
        value_presence: PRESENT
  description: DiscountFactor
all_of:
- description: PrincipalAmount
  exactly_one_of:
  - slot_conditions:
      principalAmount:
        name: principalAmount
        value_presence: PRESENT
  - slot_conditions:
      presentValuePrincipalAmount:
        name: presentValuePrincipalAmount
        value_presence: PRESENT
  - all_of:
    - slot_conditions:
        principalAmount:
          name: principalAmount
          value_presence: ABSENT
    - slot_conditions:
        presentValuePrincipalAmount:
          name: presentValuePrincipalAmount
          value_presence: ABSENT

Induced

name: PrincipalPayment
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: Any kind of principal payments when the amount is known and thus fixed.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  principalPaymentDate:
    name: principalPaymentDate
    description: The date where the PrincipalPayment shall be settled.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_common_settlement
    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/cdm_product_common_settlement
    owner: PrincipalPayment
    domain_of:
    - CalculateTransferInstruction
    - CollateralBalance
    - PayoutTransferBase
    - FeaturePayment
    - PayoutBase
    - PrincipalPayment
    - PassThroughItem
    - PortfolioReturnTerms
    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/cdm_product_common_settlement
    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/cdm_product_common_settlement
    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/cdm_product_common_settlement
    rank: 1000
    owner: PrincipalPayment
    domain_of:
    - PrincipalPayment
    range: Money
rules:
- preconditions:
    slot_conditions:
      presentValuePrincipalAmount:
        name: presentValuePrincipalAmount
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      discountFactor:
        name: discountFactor
        value_presence: PRESENT
  description: DiscountFactor
all_of:
- description: PrincipalAmount
  exactly_one_of:
  - slot_conditions:
      principalAmount:
        name: principalAmount
        value_presence: PRESENT
  - slot_conditions:
      presentValuePrincipalAmount:
        name: presentValuePrincipalAmount
        value_presence: PRESENT
  - all_of:
    - slot_conditions:
        principalAmount:
          name: principalAmount
          value_presence: ABSENT
    - slot_conditions:
        presentValuePrincipalAmount:
          name: presentValuePrincipalAmount
          value_presence: ABSENT