Class: FeaturePayment

Payment made following trigger occurrence.

URI: common_domain_model:FeaturePayment

 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

Expressions & Logic

All Of

The class must satisfy all of:

• AnonymousClassExpression({ ‘description’: ‘FeaturePaymentChoice: Choice rule to represent an FpML choice construct.’, ‘exactly_one_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘levelPercentage’: SlotDefinition({‘name’: ‘levelPercentage’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘amount’: SlotDefinition({‘name’: ‘amount’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })] })

Usages

used by	used in	type	used
TriggerEvent	featurePayment	range	FeaturePayment

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	{'amount': {'value_presence': 'PRESENT'}}	{'amount': {'minimum_value': 0, '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:FeaturePayment
native	common_domain_model:FeaturePayment

LinkML Source

Direct

name: FeaturePayment
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: Payment made following trigger occurrence.
from_schema: https://w3id.org/lmodel/common-domain-model
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/cdm_observable_event
    domain_of:
    - CalculateTransferInstruction
    - CollateralBalance
    - PayoutTransferBase
    - FeaturePayment
    - PayoutBase
    - PrincipalPayment
    - PassThroughItem
    - PortfolioReturnTerms
    range: PartyReferencePayerReceiver
    required: true
  levelPercentage:
    name: levelPercentage
    description: The trigger level percentage.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    rank: 1000
    domain_of:
    - FeaturePayment
    range: decimal
  amount:
    name: amount
    description: The monetary quantity in currency units.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    domain_of:
    - Valuation
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - ElectiveAmountElection
    - LegacyResolutionAlternative
    - RatingAgencyAmount
    - ThresholdMinimumTransferAmountFixedAmount
    - FeaturePayment
    - ComputedAmount
    range: decimal
  time:
    name: time
    description: The feature payment time.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    domain_of:
    - TimeZone
    - ValuationTime
    - FeaturePayment
    range: TimeTypeEnum
  currency:
    name: currency
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: The currency in which an amount is denominated.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - FloatingRateIndexIdentification
    - AmountScheduleWithInitialValue
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - LegacyIndependentAmountRatingsBased
    - MinimumTransferAmountRatingsBased
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - CollateralInterestParameters
    - ComputedAmount
    range: string
  paymentDate:
    name: paymentDate
    description: The feature payment date.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    rank: 1000
    domain_of:
    - FeaturePayment
    - InterestRatePayout
    - PaymentDetail
    - SchedulePeriod
    range: AdjustableOrRelativeDate
rules:
- preconditions:
    slot_conditions:
      amount:
        name: amount
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      amount:
        name: amount
        minimum_value: 0
        value_presence: PRESENT
  description: 'Amount: The amount attribute is specified in FpML as non-negative
    decimal.'
all_of:
- description: 'FeaturePaymentChoice: Choice rule to represent an FpML choice construct.'
  exactly_one_of:
  - slot_conditions:
      levelPercentage:
        name: levelPercentage
        value_presence: PRESENT
  - slot_conditions:
      amount:
        name: amount
        value_presence: PRESENT

Induced

name: FeaturePayment
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: Payment made following trigger occurrence.
from_schema: https://w3id.org/lmodel/common-domain-model
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/cdm_observable_event
    owner: FeaturePayment
    domain_of:
    - CalculateTransferInstruction
    - CollateralBalance
    - PayoutTransferBase
    - FeaturePayment
    - PayoutBase
    - PrincipalPayment
    - PassThroughItem
    - PortfolioReturnTerms
    range: PartyReferencePayerReceiver
    required: true
  levelPercentage:
    name: levelPercentage
    description: The trigger level percentage.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    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/cdm_observable_event
    owner: FeaturePayment
    domain_of:
    - Valuation
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - ElectiveAmountElection
    - LegacyResolutionAlternative
    - RatingAgencyAmount
    - ThresholdMinimumTransferAmountFixedAmount
    - FeaturePayment
    - ComputedAmount
    range: decimal
  time:
    name: time
    description: The feature payment time.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    owner: FeaturePayment
    domain_of:
    - TimeZone
    - ValuationTime
    - FeaturePayment
    range: TimeTypeEnum
  currency:
    name: currency
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: The currency in which an amount is denominated.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    owner: FeaturePayment
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - FloatingRateIndexIdentification
    - AmountScheduleWithInitialValue
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - LegacyIndependentAmountRatingsBased
    - MinimumTransferAmountRatingsBased
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - CollateralInterestParameters
    - ComputedAmount
    range: string
  paymentDate:
    name: paymentDate
    description: The feature payment date.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_observable_event
    rank: 1000
    owner: FeaturePayment
    domain_of:
    - FeaturePayment
    - InterestRatePayout
    - PaymentDetail
    - SchedulePeriod
    range: AdjustableOrRelativeDate
rules:
- preconditions:
    slot_conditions:
      amount:
        name: amount
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      amount:
        name: amount
        minimum_value: 0
        value_presence: PRESENT
  description: 'Amount: The amount attribute is specified in FpML as non-negative
    decimal.'
all_of:
- description: 'FeaturePaymentChoice: Choice rule to represent an FpML choice construct.'
  exactly_one_of:
  - slot_conditions:
      levelPercentage:
        name: levelPercentage
        value_presence: PRESENT
  - slot_conditions:
      amount:
        name: amount
        value_presence: PRESENT