Class: AssetPayout

Security finance payout specification in case the product payout involves some form of security collateral, as in a securities financing transaction. Plus additional description for ICMA.

URI: common_domain_model:AssetPayout

 classDiagram
    class AssetPayout
    click AssetPayout href "../AssetPayout/"
      PayoutBase <|-- AssetPayout
        click PayoutBase href "../PayoutBase/"

      AssetPayout : assetLeg





        AssetPayout --> "1..*" AssetLeg : assetLeg
        click AssetLeg href "../AssetLeg/"



      AssetPayout : dividendTerms





        AssetPayout --> "0..1" DividendTerms : dividendTerms
        click DividendTerms href "../DividendTerms/"



      AssetPayout : minimumFee





        AssetPayout --> "0..1" Money : minimumFee
        click Money href "../Money/"



      AssetPayout : payerReceiver





        AssetPayout --> "1" PayerReceiver : payerReceiver
        click PayerReceiver href "../PayerReceiver/"



      AssetPayout : priceQuantity





        AssetPayout --> "0..1" ResolvablePriceQuantity : priceQuantity
        click ResolvablePriceQuantity href "../ResolvablePriceQuantity/"



      AssetPayout : principalPayment





        AssetPayout --> "0..1" PrincipalPayments : principalPayment
        click PrincipalPayments href "../PrincipalPayments/"



      AssetPayout : settlementTerms





        AssetPayout --> "0..1" SettlementTerms : settlementTerms
        click SettlementTerms href "../SettlementTerms/"



      AssetPayout : tradeType





        AssetPayout --> "0..1" AssetPayoutTradeTypeEnum : tradeType
        click AssetPayoutTradeTypeEnum href "../AssetPayoutTradeTypeEnum/"



      AssetPayout : underlier





        AssetPayout --> "1" Asset : underlier
        click Asset href "../Asset/"

Inheritance

PayoutBase
- AssetPayout

Slots

Name	Cardinality and Range	Description	Inheritance
assetLeg	1..* AssetLeg	Defines each asset movement as a buy/sell at different dates, typically 1 nea...	direct
underlier	1 Asset or Observable or Product	Specifies the Purchased Asset, usually a Security	direct
minimumFee	0..1 Money	A contractual minimum amount which the borrower will pay, regardless of the d...	direct
dividendTerms	0..1 DividendTerms	Specifies the terms under which dividends received by the borrower are passed...	direct
tradeType	0..1 AssetPayoutTradeTypeEnum	The trade type, eg repurchase transaction or buy/sell-back	direct
payerReceiver	1 PayerReceiver	Canonical representation of the payer and receiver parties applicable to each...	PayoutBase
priceQuantity	0..1 ResolvablePriceQuantity	Each payout leg must implement the quantity concept as a 'resolvable' type, w...	PayoutBase
principalPayment	0..1 PrincipalPayments	The specification of the principal exchange	PayoutBase
settlementTerms	0..1 SettlementTerms	Each payout leg must specifies its settlement terms, including the delivery t...	PayoutBase

Usages

used by	used in	type	used
ResetInstruction	payout	any_of[range]	AssetPayout
CalculateTransferInstruction	payout	any_of[range]	AssetPayout
ScheduledTransfer	payoutReference	any_of[range]	AssetPayout
EconomicTerms	payout	any_of[range]	AssetPayout

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

In Subsets

CdmProductTemplate

Comments

Rosetta condition: Quantity — priceQuantity exists
Rosetta condition: UnderlierNotCash — underlier -> Cash is absent

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/lmodel/common-domain-model

Mappings

Mapping Type	Mapped Value
self	common_domain_model:AssetPayout
native	common_domain_model:AssetPayout
close	fpml_5_10:AssetPayout

LinkML Source

Direct

name: AssetPayout
description: Security finance payout specification in case the product payout involves
  some form of security collateral, as in a securities financing transaction. Plus
  additional description for ICMA.
comments:
- 'Rosetta condition: Quantity — priceQuantity exists'
- 'Rosetta condition: UnderlierNotCash — underlier -> Cash is absent'
in_subset:
- cdm_product_template
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AssetPayout
is_a: PayoutBase
slots:
- assetLeg
- underlier
- minimumFee
- dividendTerms
- tradeType
slot_usage:
  underlier:
    name: underlier
    description: Specifies the Purchased Asset, usually a Security.
    range: Asset
  minimumFee:
    name: minimumFee
    description: A contractual minimum amount which the borrower will pay, regardless
      of the duration of the loan. A mechanism for making sure that a trade generates
      enough income.
  dividendTerms:
    name: dividendTerms
    description: Specifies the terms under which dividends received by the borrower
      are passed through to the lender.
rules:
- postconditions:
    slot_conditions:
      priceQuantity:
        name: priceQuantity
        required: true
  description: When there is an OptionPayout the quantity can be expressed as part
    of the payoutQuantity, or as part of the underlier in the case of a Swaption.  For
    all other payouts that extend PayoutBase the payoutQuantity is a mandatory attribute.

Induced

name: AssetPayout
description: Security finance payout specification in case the product payout involves
  some form of security collateral, as in a securities financing transaction. Plus
  additional description for ICMA.
comments:
- 'Rosetta condition: Quantity — priceQuantity exists'
- 'Rosetta condition: UnderlierNotCash — underlier -> Cash is absent'
in_subset:
- cdm_product_template
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AssetPayout
is_a: PayoutBase
slot_usage:
  underlier:
    name: underlier
    description: Specifies the Purchased Asset, usually a Security.
    range: Asset
  minimumFee:
    name: minimumFee
    description: A contractual minimum amount which the borrower will pay, regardless
      of the duration of the loan. A mechanism for making sure that a trade generates
      enough income.
  dividendTerms:
    name: dividendTerms
    description: Specifies the terms under which dividends received by the borrower
      are passed through to the lender.
attributes:
  assetLeg:
    name: assetLeg
    description: Defines each asset movement as a buy/sell at different dates, typically
      1 near leg and 1 far leg in a securities financing transaction.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetPayout.assetLeg
    rank: 1000
    owner: AssetPayout
    domain_of:
    - AssetPayout
    range: AssetLeg
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
  underlier:
    name: underlier
    description: Specifies the Purchased Asset, usually a Security.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: AssetPayout
    domain_of:
    - CorporateAction
    - CommodityPayout
    - OptionPayout
    - PerformancePayout
    - PortfolioReturnTerms
    - SettlementPayout
    - AssetPayout
    range: Asset
    required: true
    any_of:
    - range: Observable
    - range: Product
  minimumFee:
    name: minimumFee
    description: A contractual minimum amount which the borrower will pay, regardless
      of the duration of the loan. A mechanism for making sure that a trade generates
      enough income.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BillingRecord.minimumFee
    rank: 1000
    owner: AssetPayout
    domain_of:
    - BillingRecord
    - AssetPayout
    range: Money
  dividendTerms:
    name: dividendTerms
    description: Specifies the terms under which dividends received by the borrower
      are passed through to the lender.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: AssetPayout
    domain_of:
    - AvailableInventoryRecord
    - AssetPayout
    range: DividendTerms
  tradeType:
    name: tradeType
    description: The trade type, eg repurchase transaction or buy/sell-back.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetPayout.tradeType
    rank: 1000
    owner: AssetPayout
    domain_of:
    - AssetPayout
    range: AssetPayoutTradeTypeEnum
  payerReceiver:
    name: payerReceiver
    description: Canonical representation of the payer and receiver parties applicable
      to each payout leg.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.payerReceiver
    rank: 1000
    owner: AssetPayout
    domain_of:
    - CalculateTransferInstruction
    - TransferBase
    - CollateralBalance
    - FeaturePayment
    - AssetFlow
    - PayoutBase
    - PrincipalPayment
    - PortfolioReturnTerms
    - PassThroughItem
    range: PayerReceiver
    required: true
  priceQuantity:
    name: priceQuantity
    description: Each payout leg must implement the quantity concept as a 'resolvable'
      type, which allows for different payout legs to be linked to each other (e.g.
      in the case of cross-curreny products).
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: AssetPayout
    domain_of:
    - ExecutionInstruction
    - IndexTransitionInstruction
    - PositionBase
    - PayoutBase
    - TradeLot
    range: ResolvablePriceQuantity
    required: false
    multivalued: false
    inlined: true
    inlined_as_list: true
  principalPayment:
    name: principalPayment
    description: The specification of the principal exchange. Optional as only applicable
      in the case of cross-currency or zero-coupon swaps with a final payment.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: AssetPayout
    domain_of:
    - PayoutBase
    range: PrincipalPayments
  settlementTerms:
    name: settlementTerms
    description: Each payout leg must specifies its settlement terms, including the
      delivery type (i.e. cash vs physical, and their respective terms), the transfer
      type (DvP etc.) and settlement date, if any.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: AssetPayout
    domain_of:
    - EquitySwapMasterConfirmation2018
    - PayoutBase
    range: SettlementTerms
    required: false
rules:
- postconditions:
    slot_conditions:
      priceQuantity:
        name: priceQuantity
        required: true
  description: When there is an OptionPayout the quantity can be expressed as part
    of the payoutQuantity, or as part of the underlier in the case of a Swaption.  For
    all other payouts that extend PayoutBase the payoutQuantity is a mandatory attribute.