Class: TransferBase

Defines the transfer 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/"
      TransferBase <|-- PayoutTransferBase
        click PayoutTransferBase href "../PayoutTransferBase/"
      TransferBase <|-- UnscheduledTransfer
        click UnscheduledTransfer href "../UnscheduledTransfer/"
      
      TransferBase : asset
        
          
    
        
        
        TransferBase --> "1" Asset : asset
        click Asset href "../Asset/"
    

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

        
      TransferBase : partyReferencePayerReceiver
        
          
    
        
        
        TransferBase --> "0..1" PartyReferencePayerReceiver : partyReferencePayerReceiver
        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

• TransferBase
  • PayoutTransferBase
  • UnscheduledTransfer

Slots

Name	Cardinality and Range	Description	Inheritance
identifier	* Identifier	Represents a unique reference to the transfer	direct
quantity	1 NonNegativeQuantity	Represents the amount of the asset to be transferred	direct
asset	1 Asset	Represents the object that is subject to the transfer, it could be an asset o…	direct
settlementDate	1 AdjustableOrAdjustedOrRelativeDate	Represents the date on which the transfer to due	direct
paymentDiscounting	0..1 PaymentDiscounting	FpML specifies the FpML PaymentDiscounting	direct
partyReferencePayerReceiver	0..1 PartyReferencePayerReceiver	Represents the resolved parties to the transfer and their role	direct

Comments

• Rosetta condition QuantityUnitExists is not stated in LinkML: if asset as Cash exists then quantity -> unit -> currency exists else if asset as Commodity exists then quantity -> unit -> capacityUnit exists else if asset as Instrument exists then quantity -> unit -> financialUnit exists

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: TransferBase
description: Defines the transfer of an Asset (eg cash, securities or commodities)
  between two parties on a date.
comments:
- 'Rosetta condition QuantityUnitExists is not stated in LinkML: if asset as Cash
  exists then quantity -> unit -> currency exists else if asset as Commodity exists
  then quantity -> unit -> capacityUnit exists else if asset as Instrument exists
  then quantity -> unit -> financialUnit exists'
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  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
    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
    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
    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
    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
    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
    domain_of:
    - TransferBase
    range: PartyReferencePayerReceiver

Induced

name: TransferBase
description: Defines the transfer of an Asset (eg cash, securities or commodities)
  between two parties on a date.
comments:
- 'Rosetta condition QuantityUnitExists is not stated in LinkML: if asset as Cash
  exists then quantity -> unit -> currency exists else if asset as Commodity exists
  then quantity -> unit -> capacityUnit exists else if asset as Instrument exists
  then quantity -> unit -> financialUnit exists'
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  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: TransferBase
    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: TransferBase
    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: TransferBase
    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: TransferBase
    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: TransferBase
    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: TransferBase
    domain_of:
    - TransferBase
    range: PartyReferencePayerReceiver