Skip to content

Class: TransferBase

Defines the movement of an Asset (eg cash, securities or commodities) between two parties on a date.

URI: common_domain_model:TransferBase

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


      TransferBase <|-- UnscheduledTransfer
        click UnscheduledTransfer href "../UnscheduledTransfer/"
      TransferBase <|-- ScheduledTransfer
        click ScheduledTransfer href "../ScheduledTransfer/"


      TransferBase : asset





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



      TransferBase : identifier





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



      TransferBase : payerReceiver





        TransferBase --> "1" PartyReferencePayerReceiver : payerReceiver
        click PartyReferencePayerReceiver href "../PartyReferencePayerReceiver/"



      TransferBase : paymentDiscounting





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



      TransferBase : quantity





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



      TransferBase : settlementDate





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

Inheritance

Slots

Name Cardinality and Range Description Inheritance
identifier *
Identifier		 Represents a unique reference to the transfer direct
payerReceiver 1
PartyReferencePayerReceiver		 Represents the parties to the transfer and their role 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

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self common_domain_model:TransferBase
native common_domain_model:TransferBase

LinkML Source

Direct

name: TransferBase
description: Defines the movement of an Asset (eg cash, securities or commodities)
  between two parties on a date.
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: AssetFlowBase
slots:
- identifier
- payerReceiver
slot_usage:
  identifier:
    name: identifier
    description: Represents a unique reference to the transfer.
    range: Identifier
    required: false
    inlined_as_list: true
  payerReceiver:
    name: payerReceiver
    description: Represents the parties to the transfer and their role.
    range: PartyReferencePayerReceiver
    required: true

Induced

name: TransferBase
description: Defines the movement of an Asset (eg cash, securities or commodities)
  between two parties on a date.
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: AssetFlowBase
slot_usage:
  identifier:
    name: identifier
    description: Represents a unique reference to the transfer.
    range: Identifier
    required: false
    inlined_as_list: true
  payerReceiver:
    name: payerReceiver
    description: Represents the parties to the transfer and their role.
    range: PartyReferencePayerReceiver
    required: true
attributes:
  identifier:
    name: identifier
    description: Represents a unique reference to the transfer.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.identifier
    rank: 1000
    owner: TransferBase
    domain_of:
    - AssetBase
    - AssetIdentifier
    - ProductIdentifier
    - AssignedIdentifier
    - BusinessUnit
    - PartyIdentifier
    - EntityIdentifier
    - PersonIdentifier
    - TransferBase
    - OtherAgreement
    - LegalAgreementBase
    - NonLegalEntity
    - MasterAgreementClauseVariant
    - Clause
    - ContractualDefinition
    - FloatingRateIndexMap
    - EligibleCollateralSpecification
    - NonTransferableProduct
    range: Identifier
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  payerReceiver:
    name: payerReceiver
    description: Represents the parties to the transfer and their role.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.payerReceiver
    rank: 1000
    owner: TransferBase
    domain_of:
    - CalculateTransferInstruction
    - TransferBase
    - CollateralBalance
    - FeaturePayment
    - AssetFlow
    - PayoutBase
    - PrincipalPayment
    - PortfolioReturnTerms
    - PassThroughItem
    range: PartyReferencePayerReceiver
    required: 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
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.quantity
    rank: 1000
    owner: TransferBase
    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: TransferBase
    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: TransferBase
    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: TransferBase
    domain_of:
    - AssetFlowBase
    range: PaymentDiscounting