Skip to content

Class: ScheduledTransfer

A scheduled transfer built into the contract.

URI: common_domain_model:ScheduledTransfer

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

      ScheduledTransfer : asset





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



      ScheduledTransfer : corporateActionTransferType





        ScheduledTransfer --> "0..1" CorporateActionTypeEnum : corporateActionTransferType
        click CorporateActionTypeEnum href "../CorporateActionTypeEnum/"



      ScheduledTransfer : identifier





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



      ScheduledTransfer : payerReceiver





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



      ScheduledTransfer : paymentDiscounting





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



      ScheduledTransfer : payoutReference





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



      ScheduledTransfer : quantity





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



      ScheduledTransfer : settlementDate





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



      ScheduledTransfer : transferType





        ScheduledTransfer --> "1" ScheduledTransferEnum : transferType
        click ScheduledTransferEnum href "../ScheduledTransferEnum/"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
transferType 1
ScheduledTransferEnum		 Specifies the type of scheduled transfer direct
corporateActionTransferType 0..1
CorporateActionTypeEnum		 direct
payoutReference 0..1
Payout or 
AssetPayout or 
CommodityPayout or 
CreditDefaultPayout or 
FixedPricePayout or 
InterestRatePayout or 
OptionPayout or 
PerformancePayout or 
SettlementPayout		 Represents the origin to the transfer as a reference for lineage purposes, wh... direct
identifier *
Identifier		 Represents a unique reference to the transfer TransferBase
payerReceiver 1
PartyReferencePayerReceiver		 Represents the parties to the transfer and their role TransferBase
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

Usages

used by used in type used
IndexTransitionInstruction cashTransfer any_of[range] ScheduledTransfer
BillingRecord recordTransfer any_of[range] ScheduledTransfer
BillingSummary summaryTransfer any_of[range] ScheduledTransfer
CancelableProvision initialFee any_of[range] ScheduledTransfer

Rules

Rule Applied Preconditions Postconditions Elseconditions
slot_conditions {'transferType': {'equals_string': 'CorporateAction'}} {'corporateActionTransferType': {'required': True}}

In Subsets

Comments

  • Rosetta condition: CorporateActionTransferTypeExists — if transferType = ScheduledTransferEnum -> CorporateAction then corporateActionTransferType exists

Identifier and Mapping Information

Schema Source

Mappings

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

LinkML Source

Direct

name: ScheduledTransfer
description: A scheduled transfer built into the contract.
comments:
- 'Rosetta condition: CorporateActionTransferTypeExists — if transferType = ScheduledTransferEnum
  -> CorporateAction then corporateActionTransferType exists'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: TransferBase
slots:
- transferType
- corporateActionTransferType
- payoutReference
slot_usage:
  transferType:
    name: transferType
    description: Specifies the type of scheduled transfer.
    range: ScheduledTransferEnum
    required: true
rules:
- preconditions:
    slot_conditions:
      transferType:
        name: transferType
        equals_string: CorporateAction
  postconditions:
    slot_conditions:
      corporateActionTransferType:
        name: corporateActionTransferType
        required: true
  description: When transfer type is Performance or Transfer then the type of event
    must be specified.

Induced

name: ScheduledTransfer
description: A scheduled transfer built into the contract.
comments:
- 'Rosetta condition: CorporateActionTransferTypeExists — if transferType = ScheduledTransferEnum
  -> CorporateAction then corporateActionTransferType exists'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: TransferBase
slot_usage:
  transferType:
    name: transferType
    description: Specifies the type of scheduled transfer.
    range: ScheduledTransferEnum
    required: true
attributes:
  transferType:
    name: transferType
    description: Specifies the type of scheduled transfer.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ScheduledTransfer
    domain_of:
    - UnscheduledTransfer
    - ScheduledTransfer
    range: ScheduledTransferEnum
    required: true
  corporateActionTransferType:
    name: corporateActionTransferType
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ScheduledTransfer
    domain_of:
    - ScheduledTransfer
    range: CorporateActionTypeEnum
  payoutReference:
    name: payoutReference
    annotations:
      metadata_reference:
        tag: metadata_reference
        value: true
    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
    rank: 1000
    owner: ScheduledTransfer
    domain_of:
    - ScheduledTransfer
    range: Payout
    any_of:
    - range: AssetPayout
    - range: CommodityPayout
    - range: CreditDefaultPayout
    - range: FixedPricePayout
    - range: InterestRatePayout
    - range: OptionPayout
    - range: PerformancePayout
    - range: SettlementPayout
  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: ScheduledTransfer
    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: ScheduledTransfer
    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: ScheduledTransfer
    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: ScheduledTransfer
    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: ScheduledTransfer
    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: ScheduledTransfer
    domain_of:
    - AssetFlowBase
    range: PaymentDiscounting
rules:
- preconditions:
    slot_conditions:
      transferType:
        name: transferType
        equals_string: CorporateAction
  postconditions:
    slot_conditions:
      corporateActionTransferType:
        name: corporateActionTransferType
        required: true
  description: When transfer type is Performance or Transfer then the type of event
    must be specified.