Class: MarginCallBase

Represents common attributes required for Issuance and Response to a Margin Call action as a result of a demand for delivery or return of collateral determined under a legal agreement such as a credit support document or equivalent.

URI: common_domain_model:MarginCallBase

 classDiagram
    class MarginCallBase
    click MarginCallBase href "../MarginCallBase/"
      MarginCallBase <|-- MarginCallExposure
        click MarginCallExposure href "../MarginCallExposure/"
      MarginCallBase <|-- MarginCallIssuance
        click MarginCallIssuance href "../MarginCallIssuance/"
      MarginCallBase <|-- MarginCallResponse
        click MarginCallResponse href "../MarginCallResponse/"
      
      MarginCallBase : agreementMinimumTransferAmount
        
          
    
        
        
        MarginCallBase --> "0..1" Money : agreementMinimumTransferAmount
        click Money href "../Money/"
    

        
      MarginCallBase : agreementRounding
        
          
    
        
        
        MarginCallBase --> "0..1" Money : agreementRounding
        click Money href "../Money/"
    

        
      MarginCallBase : agreementThreshold
        
          
    
        
        
        MarginCallBase --> "0..1" Money : agreementThreshold
        click Money href "../Money/"
    

        
      MarginCallBase : baseCurrencyExposure
        
          
    
        
        
        MarginCallBase --> "0..1" MarginCallExposure : baseCurrencyExposure
        click MarginCallExposure href "../MarginCallExposure/"
    

        
      MarginCallBase : callAgreementType
        
          
    
        
        
        MarginCallBase --> "1" AgreementName : callAgreementType
        click AgreementName href "../AgreementName/"
    

        
      MarginCallBase : callIdentifier
        
          
    
        
        
        MarginCallBase --> "0..1" Identifier : callIdentifier
        click Identifier href "../Identifier/"
    

        
      MarginCallBase : clearingBroker
        
          
    
        
        
        MarginCallBase --> "0..1" Party : clearingBroker
        click Party href "../Party/"
    

        
      MarginCallBase : collateralPortfolio
        
          
    
        
        
        MarginCallBase --> "0..1" CollateralPortfolio : collateralPortfolio
        click CollateralPortfolio href "../CollateralPortfolio/"
    

        
      MarginCallBase : independentAmountBalance
        
          
    
        
        
        MarginCallBase --> "0..1" CollateralBalance : independentAmountBalance
        click CollateralBalance href "../CollateralBalance/"
    

        
      MarginCallBase : instructionType
        
          
    
        
        
        MarginCallBase --> "1" MarginCallInstructionType : instructionType
        click MarginCallInstructionType href "../MarginCallInstructionType/"
    

        
      MarginCallBase : party
        
          
    
        
        
        MarginCallBase --> "*" Party : party
        click Party href "../Party/"
    

        
      MarginCallBase : partyRole
        
          
    
        
        
        MarginCallBase --> "*" PartyRole : partyRole
        click PartyRole href "../PartyRole/"
    

        
      MarginCallBase : regIMRole
        
          
    
        
        
        MarginCallBase --> "0..1" RegIMRoleEnum : regIMRole
        click RegIMRoleEnum href "../RegIMRoleEnum/"
    

        
      MarginCallBase : regMarginType
        
          
    
        
        
        MarginCallBase --> "1" RegMarginTypeEnum : regMarginType
        click RegMarginTypeEnum href "../RegMarginTypeEnum/"

Inheritance

MarginCallBase

Slots

Name	Cardinality and Range	Description	Inheritance
instructionType	1 MarginCallInstructionType	Identifies the enumeration values to specify the call notification type, dire…	direct
party	* Party	Represents the parties to the margin call	direct
partyRole	* PartyRole	Represents the role each specified party takes in the margin call	direct
clearingBroker	0..1 Party	Indicates the name of the Clearing Broker FCM/DCM	direct
callIdentifier	0..1 Identifier	Represents a unique Identifier for a margin call message, that can be referen…	direct
callAgreementType	1 AgreementName	Specifies the legal agreement type the margin call is generated from and gove…	direct
agreementMinimumTransferAmount	0..1 Money	Specifies the collateral legal agreement minimum transfer amount in base curr…	direct
agreementThreshold	0..1 Money	Specifies the collateral legal agreement threshold amount in base currency	direct
agreementRounding	0..1 Money	Specifies the collateral legal agreement rounding in base currency	direct
regMarginType	1 RegMarginTypeEnum	Identifies margin type and if related regulatory mandate	direct
regIMRole	0..1 RegIMRoleEnum	Indicates the role of the party in an regulatory initial margin call instruct…	direct
baseCurrencyExposure	0..1 MarginCallExposure	Represents the current mark to market value or IM calculation value of the tr…	direct
collateralPortfolio	0..1 CollateralPortfolio	Represents attributes to define the details of collateral assets within a col…	direct
independentAmountBalance	0..1 CollateralBalance	Represents additional credit support amount over and above mark to market val…	direct

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'regIMRole': {'value_presence': 'PRESENT'}}`	`{'regMarginType': {'equals_string': 'RegIM'}}`

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: MarginCallBase
description: Represents common attributes required for Issuance and Response to a
  Margin Call action as a result of a demand for delivery or return of collateral
  determined under a legal agreement such as a credit support document or equivalent.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  instructionType:
    name: instructionType
    description: Identifies the enumeration values to specify the call notification
      type, direction, specific action type.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: MarginCallInstructionType
    required: true
  party:
    name: party
    description: Represents the parties to the margin call. The cardinality is optional
      to address the case where both parties of the event are specified and a third
      party if applicable.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - AssetBase
    - DebtRedemption
    - MarginCallBase
    - Trade
    - UmbrellaAgreementParty
    - UmbrellaAgreementSet
    - AggregationParameters
    - AvailableInventory
    - CounterpartyPosition
    - WorkflowStep
    - WorkflowStepApproval
    - AdditionalObligations
    - AdditionalRepresentationElection
    - CalculationAgentTerms
    - CalculationCurrencyElection
    - CollateralManagementAgreementElection
    - ControlAgreementElections
    - ControlAgreementNecEventElection
    - CreditSupportDocumentElection
    - CreditSupportProviderElection
    - CustodianElection
    - CustodianRiskElection
    - ElectiveAmountElection
    - FrenchLawAddendumElection
    - HoldingAndUsingPostedCollateralElection
    - LegacyExposureScopeElection
    - LegacyIndependentAmountParty
    - MinimumTransferAmountElection
    - NotificationTimeElection
    - PledgeeRepresentativeRider
    - PostingObligationsElection
    - RecalculationOfValueElection
    - RegimeTerms
    - SecuredPartyRightsEventElection
    - SecurityInterestForObligations
    - SecurityProviderRightsEventElection
    - SensitivityMethodologiesPartyElection
    - SinglePostingParty
    - SpecifiedOrAccessConditionPartyElection
    - SubstitutedRegimeElection
    - SubstitutionPartyElection
    - TerminationCurrencyElection
    - ThresholdElection
    - ValuationAgent
    - ValuationCalculationDateLocationElection
    - AdditionalTerminationEventElection
    - AutomaticEarlyTerminationElection
    - CreditEventUponMergerElection
    - PartyTerminationCurrencySelection
    - SpecifiedEntity
    - EventsOfDefaultElection
    - EligibleCollateralSpecification
    range: Party
    multivalued: true
  partyRole:
    name: partyRole
    description: Represents the role each specified party takes in the margin call.
      further to the principal roles, payer and receiver.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    domain_of:
    - AssetBase
    - MarginCallBase
    - PartyChangeInstruction
    - Trade
    - UmbrellaAgreementParty
    - AvailableInventory
    - AvailableInventoryRecord
    - CounterpartyPosition
    - EligibleCollateralSpecification
    range: PartyRole
    multivalued: true
  clearingBroker:
    name: clearingBroker
    description: Indicates the name of the Clearing Broker FCM/DCM.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: Party
  callIdentifier:
    name: callIdentifier
    description: Represents a unique Identifier for a margin call message, that can
      be referenced throughout all points of the process.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: Identifier
  callAgreementType:
    name: callAgreementType
    description: Specifies the legal agreement type the margin call is generated from
      and governed by.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: AgreementName
    required: true
  agreementMinimumTransferAmount:
    name: agreementMinimumTransferAmount
    description: Specifies the collateral legal agreement minimum transfer amount
      in base currency.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: Money
  agreementThreshold:
    name: agreementThreshold
    description: Specifies the collateral legal agreement threshold amount in base
      currency.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: Money
  agreementRounding:
    name: agreementRounding
    description: Specifies the collateral legal agreement rounding in base currency.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: Money
  regMarginType:
    name: regMarginType
    description: Identifies margin type and if related regulatory mandate
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: RegMarginTypeEnum
    required: true
  regIMRole:
    name: regIMRole
    description: Indicates the role of the party in an regulatory initial margin call
      instruction (i.e Pledgor party or Secured party).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: RegIMRoleEnum
  baseCurrencyExposure:
    name: baseCurrencyExposure
    description: Represents the current mark to market value or IM calculation value
      of the trade portfolio as recorded by the principle (in base currency), to be
      referenced in a margin call.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: MarginCallExposure
  collateralPortfolio:
    name: collateralPortfolio
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: Represents attributes to define the details of collateral assets
      within a collateral portfolio to be used in margin call messaging and contribute
      to collateral balances e.g securities in a collateral account recorded by the
      principal as held or posted.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    - Collateral
    range: CollateralPortfolio
  independentAmountBalance:
    name: independentAmountBalance
    description: Represents additional credit support amount over and above mark to
      market value.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - MarginCallBase
    range: CollateralBalance
rules:
- preconditions:
    slot_conditions:
      regIMRole:
        name: regIMRole
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      regMarginType:
        name: regMarginType
        equals_string: RegIM
  description: 'RegIMRoleIMOnly: Specifies a condition to ensure that RegIMRole (Pledgor
    or Secured Party)is only applicable if the Reg margin type is defined as RegIM
    (Regulatory Initial Margin).'

Induced

name: MarginCallBase
description: Represents common attributes required for Issuance and Response to a
  Margin Call action as a result of a demand for delivery or return of collateral
  determined under a legal agreement such as a credit support document or equivalent.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  instructionType:
    name: instructionType
    description: Identifies the enumeration values to specify the call notification
      type, direction, specific action type.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: MarginCallInstructionType
    required: true
  party:
    name: party
    description: Represents the parties to the margin call. The cardinality is optional
      to address the case where both parties of the event are specified and a third
      party if applicable.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: MarginCallBase
    domain_of:
    - AssetBase
    - DebtRedemption
    - MarginCallBase
    - Trade
    - UmbrellaAgreementParty
    - UmbrellaAgreementSet
    - AggregationParameters
    - AvailableInventory
    - CounterpartyPosition
    - WorkflowStep
    - WorkflowStepApproval
    - AdditionalObligations
    - AdditionalRepresentationElection
    - CalculationAgentTerms
    - CalculationCurrencyElection
    - CollateralManagementAgreementElection
    - ControlAgreementElections
    - ControlAgreementNecEventElection
    - CreditSupportDocumentElection
    - CreditSupportProviderElection
    - CustodianElection
    - CustodianRiskElection
    - ElectiveAmountElection
    - FrenchLawAddendumElection
    - HoldingAndUsingPostedCollateralElection
    - LegacyExposureScopeElection
    - LegacyIndependentAmountParty
    - MinimumTransferAmountElection
    - NotificationTimeElection
    - PledgeeRepresentativeRider
    - PostingObligationsElection
    - RecalculationOfValueElection
    - RegimeTerms
    - SecuredPartyRightsEventElection
    - SecurityInterestForObligations
    - SecurityProviderRightsEventElection
    - SensitivityMethodologiesPartyElection
    - SinglePostingParty
    - SpecifiedOrAccessConditionPartyElection
    - SubstitutedRegimeElection
    - SubstitutionPartyElection
    - TerminationCurrencyElection
    - ThresholdElection
    - ValuationAgent
    - ValuationCalculationDateLocationElection
    - AdditionalTerminationEventElection
    - AutomaticEarlyTerminationElection
    - CreditEventUponMergerElection
    - PartyTerminationCurrencySelection
    - SpecifiedEntity
    - EventsOfDefaultElection
    - EligibleCollateralSpecification
    range: Party
    multivalued: true
  partyRole:
    name: partyRole
    description: Represents the role each specified party takes in the margin call.
      further to the principal roles, payer and receiver.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    owner: MarginCallBase
    domain_of:
    - AssetBase
    - MarginCallBase
    - PartyChangeInstruction
    - Trade
    - UmbrellaAgreementParty
    - AvailableInventory
    - AvailableInventoryRecord
    - CounterpartyPosition
    - EligibleCollateralSpecification
    range: PartyRole
    multivalued: true
  clearingBroker:
    name: clearingBroker
    description: Indicates the name of the Clearing Broker FCM/DCM.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: Party
  callIdentifier:
    name: callIdentifier
    description: Represents a unique Identifier for a margin call message, that can
      be referenced throughout all points of the process.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: Identifier
  callAgreementType:
    name: callAgreementType
    description: Specifies the legal agreement type the margin call is generated from
      and governed by.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: AgreementName
    required: true
  agreementMinimumTransferAmount:
    name: agreementMinimumTransferAmount
    description: Specifies the collateral legal agreement minimum transfer amount
      in base currency.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: Money
  agreementThreshold:
    name: agreementThreshold
    description: Specifies the collateral legal agreement threshold amount in base
      currency.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: Money
  agreementRounding:
    name: agreementRounding
    description: Specifies the collateral legal agreement rounding in base currency.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: Money
  regMarginType:
    name: regMarginType
    description: Identifies margin type and if related regulatory mandate
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: RegMarginTypeEnum
    required: true
  regIMRole:
    name: regIMRole
    description: Indicates the role of the party in an regulatory initial margin call
      instruction (i.e Pledgor party or Secured party).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: RegIMRoleEnum
  baseCurrencyExposure:
    name: baseCurrencyExposure
    description: Represents the current mark to market value or IM calculation value
      of the trade portfolio as recorded by the principle (in base currency), to be
      referenced in a margin call.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: MarginCallExposure
  collateralPortfolio:
    name: collateralPortfolio
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: Represents attributes to define the details of collateral assets
      within a collateral portfolio to be used in margin call messaging and contribute
      to collateral balances e.g securities in a collateral account recorded by the
      principal as held or posted.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    - Collateral
    range: CollateralPortfolio
  independentAmountBalance:
    name: independentAmountBalance
    description: Represents additional credit support amount over and above mark to
      market value.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: MarginCallBase
    domain_of:
    - MarginCallBase
    range: CollateralBalance
rules:
- preconditions:
    slot_conditions:
      regIMRole:
        name: regIMRole
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      regMarginType:
        name: regMarginType
        equals_string: RegIM
  description: 'RegIMRoleIMOnly: Specifies a condition to ensure that RegIMRole (Pledgor
    or Secured Party)is only applicable if the Reg margin type is defined as RegIM
    (Regulatory Initial Margin).'