Class: AssetFlow

Specifies an asset flow, i.e. the outcome of either of computation (e.g. interest accrual) or an assessment of some sort. The asset flow can then be turned into an asset transfer artefact to be used as the input to a payment system or the outcome of it. The associated globalKey denotes the ability to associate a hash value to the AssetFlow instantiations for the purpose of model cross-referencing, in support of functionality such as the event effect and the lineage.

URI: common_domain_model:AssetFlow

 classDiagram
    class AssetFlow
    click AssetFlow href "../AssetFlow/"
      AssetFlowBase <|-- AssetFlow
        click AssetFlowBase href "../AssetFlowBase/"

      AssetFlow : asset





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



      AssetFlow : assetFlowType





        AssetFlow --> "0..1" ScheduledTransferEnum : assetFlowType
        click ScheduledTransferEnum href "../ScheduledTransferEnum/"



      AssetFlow : payerReceiver





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



      AssetFlow : paymentDiscounting





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



      AssetFlow : quantity





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



      AssetFlow : settlementDate





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

Inheritance

AssetFlowBase
- AssetFlow

Slots

Name	Cardinality and Range	Description	Inheritance
payerReceiver	1 PayerReceiver	Specifies who pays / receives the asset flow, through a normalised Party1 / P...	direct
assetFlowType	0..1 ScheduledTransferEnum	Type of asset flow corresponding to a scheduled event	direct
quantity	1 NonNegativeQuantity	Represents the amount of the asset to be transferred	AssetFlowBase
asset	1 Asset or Cash or Commodity or DigitalAsset or Instrument	Represents the object that is subject to the transfer, it could be an asset o...	AssetFlowBase
settlementDate	1 AdjustableOrAdjustedOrRelativeDate	Represents the date on which the transfer to due	AssetFlowBase
paymentDiscounting	0..1 PaymentDiscounting	FpML specifies the FpML PaymentDiscounting	AssetFlowBase

In Subsets

CdmProductCommonSettlement

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: AssetFlow
description: Specifies an asset flow, i.e. the outcome of either of computation (e.g.
  interest accrual) or an assessment of some sort. The asset flow can then be turned
  into an asset transfer artefact to be used as the input to a payment system or the
  outcome of it. The associated globalKey denotes the ability to associate a hash
  value to the AssetFlow instantiations for the purpose of model cross-referencing,
  in support of functionality such as the event effect and the lineage.
in_subset:
- cdm_product_common_settlement
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AssetFlow
is_a: AssetFlowBase
slots:
- payerReceiver
- assetFlowType
slot_usage:
  payerReceiver:
    name: payerReceiver
    description: Specifies who pays / receives the asset flow, through a normalised
      Party1 / Party2 enumerator.
    required: true

Induced

name: AssetFlow
description: Specifies an asset flow, i.e. the outcome of either of computation (e.g.
  interest accrual) or an assessment of some sort. The asset flow can then be turned
  into an asset transfer artefact to be used as the input to a payment system or the
  outcome of it. The associated globalKey denotes the ability to associate a hash
  value to the AssetFlow instantiations for the purpose of model cross-referencing,
  in support of functionality such as the event effect and the lineage.
in_subset:
- cdm_product_common_settlement
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AssetFlow
is_a: AssetFlowBase
slot_usage:
  payerReceiver:
    name: payerReceiver
    description: Specifies who pays / receives the asset flow, through a normalised
      Party1 / Party2 enumerator.
    required: true
attributes:
  payerReceiver:
    name: payerReceiver
    description: Specifies who pays / receives the asset flow, through a normalised
      Party1 / Party2 enumerator.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.payerReceiver
    rank: 1000
    owner: AssetFlow
    domain_of:
    - CalculateTransferInstruction
    - TransferBase
    - CollateralBalance
    - FeaturePayment
    - AssetFlow
    - PayoutBase
    - PrincipalPayment
    - PortfolioReturnTerms
    - PassThroughItem
    range: PayerReceiver
    required: true
  assetFlowType:
    name: assetFlowType
    description: Type of asset flow corresponding to a scheduled event.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetFlow.assetFlowType
    rank: 1000
    owner: AssetFlow
    domain_of:
    - AssetFlow
    range: ScheduledTransferEnum
  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
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.quantity
    rank: 1000
    owner: AssetFlow
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - AvailableInventoryRecord
    - PriceQuantity
    - BasketConstituent
    - FutureValueAmount
    - AssetFlowBase
    - 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
    rank: 1000
    owner: AssetFlow
    domain_of:
    - PositionBase
    - AssetFlowBase
    range: Asset
    required: true
    any_of:
    - range: Cash
    - range: Commodity
    - range: DigitalAsset
    - range: Instrument
  settlementDate:
    name: settlementDate
    description: Represents the date on which the transfer to due.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:BillingRecordInstruction.settlementDate
    rank: 1000
    owner: AssetFlow
    domain_of:
    - BillingRecordInstruction
    - NonDeliverableSubstitute
    - AssetFlowBase
    - 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
    close_mappings:
    - fpml_5_10:AssetFlowBase.paymentDiscounting
    rank: 1000
    owner: AssetFlow
    domain_of:
    - AssetFlowBase
    range: PaymentDiscounting