Skip to content
common-domain-model

Class: PayoutTransferBase

Defines a transfer of an Asset associated with an economic payout - either a payout’s own scheduled terms or an outcome contingent on some other event. Carries a reference back to that Payout, and allows the transfer’s payer/receiver to be expressed as a generic, unresolved Party1 / Party2 enumerator, since a transfer generated directly from a payout’s terms may not yet be tied to resolved parties.

URI: common_domain_model:PayoutTransferBase

 classDiagram
    class PayoutTransferBase
    click PayoutTransferBase href "../PayoutTransferBase/"
      TransferBase <|-- PayoutTransferBase
        click TransferBase href "../TransferBase/"
      

      PayoutTransferBase <|-- ContingentTransfer
        click ContingentTransfer href "../ContingentTransfer/"
      PayoutTransferBase <|-- ScheduledTransfer
        click ScheduledTransfer href "../ScheduledTransfer/"
      

      PayoutTransferBase : asset
        
          
    
        
        
        PayoutTransferBase --> "1" Asset : asset
        click Asset href "../Asset/"
    

        
      PayoutTransferBase : identifier
        
          
    
        
        
        PayoutTransferBase --> "*" Identifier : identifier
        click Identifier href "../Identifier/"
    

        
      PayoutTransferBase : partyReferencePayerReceiver
        
          
    
        
        
        PayoutTransferBase --> "0..1" PartyReferencePayerReceiver : partyReferencePayerReceiver
        click PartyReferencePayerReceiver href "../PartyReferencePayerReceiver/"
    

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

        
      PayoutTransferBase : paymentDiscounting
        
          
    
        
        
        PayoutTransferBase --> "0..1" PaymentDiscounting : paymentDiscounting
        click PaymentDiscounting href "../PaymentDiscounting/"
    

        
      PayoutTransferBase : payoutReference
        
          
    
        
        
        PayoutTransferBase --> "0..1" Payout : payoutReference
        click Payout href "../Payout/"
    

        
      PayoutTransferBase : quantity
        
          
    
        
        
        PayoutTransferBase --> "1" NonNegativeQuantity : quantity
        click NonNegativeQuantity href "../NonNegativeQuantity/"
    

        
      PayoutTransferBase : settlementDate
        
          
    
        
        
        PayoutTransferBase --> "1" AdjustableOrAdjustedOrRelativeDate : settlementDate
        click AdjustableOrAdjustedOrRelativeDate href "../AdjustableOrAdjustedOrRelativeDate/"

Inheritance

Section titled “Inheritance”

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
payerReceiver 0..1
PayerReceiver		 Specifies who pays/receives the transfer, through a normalised Party1 / Party… direct
payoutReference 0..1
Payout		 Represents the origin to the transfer as a reference for lineage purposes, wh… direct
identifier *
Identifier		 Represents a unique reference to the transfer TransferBase
quantity 1
NonNegativeQuantity		 Represents the amount of the asset to be transferred TransferBase
asset 1
Asset		 Represents the object that is subject to the transfer, it could be an asset o… TransferBase
settlementDate 1
AdjustableOrAdjustedOrRelativeDate		 Represents the date on which the transfer to due TransferBase
paymentDiscounting 0..1
PaymentDiscounting		 FpML specifies the FpML PaymentDiscounting TransferBase
partyReferencePayerReceiver 0..1
PartyReferencePayerReceiver		 Represents the resolved parties to the transfer and their role TransferBase
Expressions & Logic

All Of

Section titled “All Of”

The class must satisfy all of:

  • AnonymousClassExpression({ ‘description’: (’PayerReceiverChoice: Required choice between a generic, unresolved ’ ‘payer/receiver and a party referenced payer/receiver for the transfer.’), ‘exactly_one_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘partyReferencePayerReceiver’: SlotDefinition({ ‘name’: ‘partyReferencePayerReceiver’, ‘value_presence’: PresenceEnum(text=‘PRESENT’) })} }), AnonymousClassExpression({ ‘slot_conditions’: {‘payerReceiver’: SlotDefinition({‘name’: ‘payerReceiver’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })] })

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:PayoutTransferBase
native common_domain_model:PayoutTransferBase

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: PayoutTransferBase
description: Defines a transfer of an Asset associated with an economic payout - either
  a payout's own scheduled terms or an outcome contingent on some other event. Carries
  a reference back to that Payout, and allows the transfer's payer/receiver to be
  expressed as a generic, unresolved Party1 / Party2 enumerator, since a transfer
  generated directly from a payout's terms may not yet be tied to resolved parties.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: TransferBase
attributes:
  payerReceiver:
    name: payerReceiver
    description: Specifies who pays/receives the transfer, through a normalised Party1
      / Party2 enumerator, for use before the transfer is resolved to actual parties.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - CalculateTransferInstruction
    - CollateralBalance
    - PayoutTransferBase
    - FeaturePayment
    - PayoutBase
    - PrincipalPayment
    - PassThroughItem
    - PortfolioReturnTerms
    range: PayerReceiver
  payoutReference:
    name: payoutReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: Represents the origin to the transfer as a reference for lineage
      purposes, whether it originated from trade level settlement terms or from payment
      terms on an economic payout.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - PayoutTransferBase
    range: Payout
all_of:
- description: 'PayerReceiverChoice: Required choice between a generic, unresolved
    payer/receiver and a party referenced payer/receiver for the transfer.'
  exactly_one_of:
  - slot_conditions:
      partyReferencePayerReceiver:
        name: partyReferencePayerReceiver
        value_presence: PRESENT
  - slot_conditions:
      payerReceiver:
        name: payerReceiver
        value_presence: PRESENT

Induced

Section titled “Induced”
name: PayoutTransferBase
description: Defines a transfer of an Asset associated with an economic payout - either
  a payout's own scheduled terms or an outcome contingent on some other event. Carries
  a reference back to that Payout, and allows the transfer's payer/receiver to be
  expressed as a generic, unresolved Party1 / Party2 enumerator, since a transfer
  generated directly from a payout's terms may not yet be tied to resolved parties.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: TransferBase
attributes:
  payerReceiver:
    name: payerReceiver
    description: Specifies who pays/receives the transfer, through a normalised Party1
      / Party2 enumerator, for use before the transfer is resolved to actual parties.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: PayoutTransferBase
    domain_of:
    - CalculateTransferInstruction
    - CollateralBalance
    - PayoutTransferBase
    - FeaturePayment
    - PayoutBase
    - PrincipalPayment
    - PassThroughItem
    - PortfolioReturnTerms
    range: PayerReceiver
  payoutReference:
    name: payoutReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: Represents the origin to the transfer as a reference for lineage
      purposes, whether it originated from trade level settlement terms or from payment
      terms on an economic payout.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: PayoutTransferBase
    domain_of:
    - PayoutTransferBase
    range: Payout
  identifier:
    name: identifier
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: Represents a unique reference to the transfer.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: PayoutTransferBase
    domain_of:
    - AssetBase
    - AssetIdentifier
    - ProductIdentifier
    - AssignedIdentifier
    - BusinessUnit
    - EntityIdentifier
    - PartyIdentifier
    - PersonIdentifier
    - TransferBase
    - ContractualDefinition
    - FloatingRateIndexMap
    - CompositionStep
    - InstructionComposition
    - LegalAgreementBase
    - NonLegalEntity
    - OtherAgreement
    - AvailableInventory
    - InventoryRecord
    - ClauseLibraryClause
    - ClauseLibraryClauseVariant
    - Clause
    - EligibleCollateralSpecification
    - NonTransferableProduct
    range: Identifier
    multivalued: true
  quantity:
    name: quantity
    description: Represents the amount of the asset to be transferred. The cashflow
      amount is always a positive number, as the cashflow direction is implied by
      the payer/receiver attribute.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: PayoutTransferBase
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - TransferBase
    - BasketConstituent
    - PriceQuantity
    - AvailableInventoryRecord
    - FutureValueAmount
    - PortfolioReturnTerms
    range: NonNegativeQuantity
    required: true
  asset:
    name: asset
    description: Represents the object that is subject to the transfer, it could be
      an asset or a reference.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: PayoutTransferBase
    domain_of:
    - TransferBase
    - PositionBase
    - TransferableProduct
    range: Asset
    required: true
  settlementDate:
    name: settlementDate
    description: Represents the date on which the transfer to due.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: PayoutTransferBase
    domain_of:
    - BillingRecordInstruction
    - TransferBase
    - NonDeliverableSubstitute
    - SettlementBase
    - AssetLeg
    range: AdjustableOrAdjustedOrRelativeDate
    required: true
  paymentDiscounting:
    name: paymentDiscounting
    description: FpML specifies the FpML PaymentDiscounting.model group for representing
      the discounting elements that can be associated with a payment.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: PayoutTransferBase
    domain_of:
    - TransferBase
    range: PaymentDiscounting
  partyReferencePayerReceiver:
    name: partyReferencePayerReceiver
    description: Represents the resolved parties to the transfer and their role.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: PayoutTransferBase
    domain_of:
    - TransferBase
    range: PartyReferencePayerReceiver
all_of:
- description: 'PayerReceiverChoice: Required choice between a generic, unresolved
    payer/receiver and a party referenced payer/receiver for the transfer.'
  exactly_one_of:
  - slot_conditions:
      partyReferencePayerReceiver:
        name: partyReferencePayerReceiver
        value_presence: PRESENT
  - slot_conditions:
      payerReceiver:
        name: payerReceiver
        value_presence: PRESENT