SubscriptionBulkOrderConfirmationCancellationInstructionV01

setr.049.001.01

Scope An executing party, for example, a transfer agent sends the SubscriptionBulkOrderConfirmationCancellationInstruction message to the instructing party, for example, an investment manager or its authorised representative to cancel a previously sent SubscriptionBulkOrderConfirmation. Usage The SubscriptionBulkOrderConfirmationCancellationInstruction message is used to cancel one or more previously sent subscription bulk order confirmations. The amendment indicator element is used to specify whether the subscription bulk order confirmation cancellation is to be followed by a SubscriptionBulkOrderConfirmationAmendment. The SubscriptionBulkOrderConfirmationCancellationInstruction message is used to either:

• cancel an entire SubscriptionBulkOrderConfirmation message, that is, all the individual order confirmations that it contained, or,
• request the cancellation of one or more individual confirmations. There are two ways to use the message. (1) When the SubscriptionBulkOrderConfirmationCancellationInstruction message is used to cancel an entire message, this can be done by either:
• quoting the business references, for example, OrderReference, Deal Reference, of all the individual order confirmations listed in the SubscriptionBulkOrderConfirmation message, or,
• quoting the details of all the individual order confirmations (this includes the OrderReference and DealReference) listed in SubscriptionBulkOrderConfirmation message but this is not recommended. The message identification of the SubscriptionOrderConfirmation message may also be quoted in PreviousReference. It is also possible to instruct the cancellation of an entire confirmation message by quoting its message identification in PreviousReference, but this is not recommended. (2) When the SubscriptionBulkOrderConfirmationCancellationInstruction message is used to cancel one or more individual order confirmations, this can be done by either:
• quoting the business references, for example, OrderReference, Deal Reference, of each individual order confirmation listed in the SubscriptionBulkOrderConfirmation message, or,
• quoting the details of each individual order execution (this includes the OrderReference and DealReference) listed in SubscriptionBulkOrderConfirmation message but this is not recommended. The message identification of the SubscriptionBulkOrderConfirmation message in which the individual order confirmation was conveyed may also be quoted in PreviousReference. The rejection or acceptance of a SubscriptionBulkOrderConfirmationCancellationInstruction is made using an OrderConfirmationStatusReport message.

Message Construction

Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification

classDiagram
     direction LR
%% SubscriptionBulkOrderConfirmationCancellationInstructionV01 recursion level 0 with max 0
SubscriptionBulkOrderConfirmationCancellationInstructionV01 *-- "1..1" MessageIdentification1 : MessageIdentification
SubscriptionBulkOrderConfirmationCancellationInstructionV01 *-- "0..1" AdditionalReference3 : PoolReference
SubscriptionBulkOrderConfirmationCancellationInstructionV01 *-- "0..1" AdditionalReference3 : PreviousReference
SubscriptionBulkOrderConfirmationCancellationInstructionV01 *-- "0..1" AdditionalReference3 : RelatedReference
SubscriptionBulkOrderConfirmationCancellationInstructionV01 *-- "0..1" InvestmentFundOrderExecution1 : CancellationByReference
SubscriptionBulkOrderConfirmationCancellationInstructionV01 *-- "0..1" SubscriptionBulkOrderConfirmation1 : CancellationByOrderConfirmationDetails
SubscriptionBulkOrderConfirmationCancellationInstructionV01 *-- "0..1" CopyInformation2 : CopyDetails
  

Now, we will zero-in one-by-one on each of these building blocks.

MessageIdentification building block

Reference that uniquely identifies a message from a business application standpoint. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 members

PoolReference building block

Collective reference identifying a set of messages. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

PreviousReference building block

Reference to a linked message that was previously sent. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

RelatedReference building block

Reference to a linked message that was previously received. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

CancellationByReference building block

References of the orders confirmations to be cancelled. Reference of an order, deal reference, client reference and master reference. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InvestmentFundOrderExecution1 recursion level 0 with max 1
class InvestmentFundOrderExecution1{
    MasterReference IsoMax35Text
    AmendmentIndicator IsoYesNoIndicator
}
InvestmentFundOrderExecution1 *-- "1..0" InvestmentFundOrderExecution2 : OrderReferences
%% InvestmentFundOrderExecution2 recursion level 1 with max 1
class InvestmentFundOrderExecution2{
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    DealReference IsoMax35Text
}
  

InvestmentFundOrderExecution1 members

CancellationByOrderConfirmationDetails building block

Common information related to all the orders confirmations to be cancelled. Order confirmation details. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SubscriptionBulkOrderConfirmation1 recursion level 0 with max 1
class SubscriptionBulkOrderConfirmation1{
    AmendmentIndicator IsoYesNoIndicator
}
SubscriptionBulkOrderConfirmation1 *-- "1..1" SubscriptionBulkExecution3 : BulkExecutionDetails
SubscriptionBulkOrderConfirmation1 *-- "0..10" Intermediary9 : RelatedPartyDetails
SubscriptionBulkOrderConfirmation1 *-- "0..0" Extension1 : Extension
%% SubscriptionBulkExecution3 recursion level 1 with max 1
class SubscriptionBulkExecution3{
    MasterReference IsoMax35Text
    OrderDateTime IsoISODateTime
    RequestedFutureTradeDate IsoISODate
    CancellationRight CancellationRight1Code
    ExtendedCancellationRight IsoExtended350Code
    RequestedSettlementCurrency ActiveCurrencyCode
    RequestedNAVCurrency ActiveOrHistoricCurrencyCode
    TotalSettlementAmount IsoActiveCurrencyAndAmount
    CashSettlementDate IsoISODate
}
SubscriptionBulkExecution3 *-- "0..1" IPlaceOfTradeIdentification1Choice : PlaceOfTrade
SubscriptionBulkExecution3 *-- "1..1" FinancialInstrument10 : FinancialInstrumentDetails
SubscriptionBulkExecution3 *-- "1..0" SubscriptionExecution5 : IndividualExecutionDetails
SubscriptionBulkExecution3 *-- "0..1" PaymentTransaction24 : BulkCashSettlementDetails
%% Intermediary9 recursion level 1 with max 1
class Intermediary9{
    OrderOriginatorEligibility OrderOriginatorEligibility1Code
    TradingPartyCapacity TradingCapacity2Code
    Role InvestmentFundRole2Code
    ExtendedRole IsoExtended350Code
}
Intermediary9 *-- "1..1" IPartyIdentification2Choice : Identification
Intermediary9 *-- "0..1" Account7 : Account
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

SubscriptionBulkOrderConfirmation1 members

CopyDetails building block

Message is a copy. Information provided when the message is a copy of a previous message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CopyInformation2 recursion level 0 with max 1
class CopyInformation2{
    CopyIndicator IsoYesNoIndicator
}
CopyInformation2 *-- "0..1" BICIdentification1 : OriginalReceiver
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

CopyInformation2 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the SubscriptionBulkOrderConfirmationCancellationInstructionV01 implementation follows a specific implementaiton pattern. First of all, SubscriptionBulkOrderConfirmationCancellationInstructionV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SubscriptionBulkOrderConfirmationCancellationInstructionV01Document implements IOuterDocument. Because SubscriptionBulkOrderConfirmationCancellationInstructionV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SubscriptionBulkOrderConfirmationCancellationInstructionV01.

classDiagram
    class IOuterRecord
    SubscriptionBulkOrderConfirmationCancellationInstructionV01 --|> IOuterRecord : Implements
    SubscriptionBulkOrderConfirmationCancellationInstructionV01Document --|> IOuterDocument~SubscriptionBulkOrderConfirmationCancellationInstructionV01~ : Implements
    class IOuterDocument~SubscriptionBulkOrderConfirmationCancellationInstructionV01~ {
        SubscriptionBulkOrderConfirmationCancellationInstructionV01 Message
     }
  

Document wrapper for serialization

The only real purpose SubscriptionBulkOrderConfirmationCancellationInstructionV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.049.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SubscriptionBulkOrderConfirmationCancellationInstructionV01.ToDocument() method. The returned SubscriptionBulkOrderConfirmationCancellationInstructionV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    SubscriptionBulkOrderConfirmationCancellationInstructionV01Document *-- SubscriptionBulkOrderConfirmationCancellationInstructionV01 : Document
  

Sample of message format

This is an abbreviated version of what the message should look like.

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:setr.049.001.01">
    <SbcptBlkOrdrConfCxlInstrV01>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <CxlByRef>
            <!-- CancellationByReference inner content -->
        </CxlByRef>
        <CxlByOrdrConfDtls>
            <!-- CancellationByOrderConfirmationDetails inner content -->
        </CxlByOrdrConfDtls>
        <CpyDtls>
            <!-- CopyDetails inner content -->
        </CpyDtls>
    </SbcptBlkOrdrConfCxlInstrV01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ygXWKNE7Ed-BzquC8wXy7w_-1338235349"
  nextVersions="_Aab7hzbLEead9bDRE_1DAQ"
  name="SubscriptionBulkOrderConfirmationCancellationInstructionV01"
  definition="Scope&#xD;&#xA;An executing party, for example, a transfer agent sends the SubscriptionBulkOrderConfirmationCancellationInstruction message to the instructing party, for example, an investment manager or its authorised representative to cancel a previously sent SubscriptionBulkOrderConfirmation.&#xD;&#xA;Usage&#xD;&#xA;The SubscriptionBulkOrderConfirmationCancellationInstruction message is used to cancel one or more previously sent subscription bulk order confirmations.&#xD;&#xA;The amendment indicator element is used to specify whether the subscription bulk order confirmation cancellation is to be followed by a SubscriptionBulkOrderConfirmationAmendment.&#xD;&#xA;The SubscriptionBulkOrderConfirmationCancellationInstruction message is used to either:&#xD;&#xA;- cancel an entire SubscriptionBulkOrderConfirmation message, that is, all the individual order confirmations that it contained, or,&#xD;&#xA;- request the cancellation of one or more individual confirmations.&#xD;&#xA;There are two ways to use the message.&#xD;&#xA;(1) When the SubscriptionBulkOrderConfirmationCancellationInstruction message is used to cancel an entire message, this can be done by either:&#xD;&#xA;- quoting the business references, for example, OrderReference, Deal Reference, of all the individual order confirmations listed in the SubscriptionBulkOrderConfirmation message, or,&#xD;&#xA;- quoting the details of all the individual order confirmations (this includes the OrderReference and DealReference) listed in SubscriptionBulkOrderConfirmation message but this is not recommended.&#xD;&#xA;The message identification of the SubscriptionOrderConfirmation message may also be quoted in PreviousReference.&#xD;&#xA;It is also possible to instruct the cancellation of an entire confirmation message by quoting its message identification in PreviousReference, but this is not recommended.&#xD;&#xA;(2) When the SubscriptionBulkOrderConfirmationCancellationInstruction message is used to cancel one or more individual order confirmations, this can be done by either:&#xD;&#xA;- quoting the business references, for example, OrderReference, Deal Reference, of each individual order confirmation listed in the SubscriptionBulkOrderConfirmation message, or,&#xD;&#xA;- quoting the details of each individual order execution (this includes the OrderReference and DealReference) listed in SubscriptionBulkOrderConfirmation message but this is not recommended.&#xD;&#xA;The message identification of the SubscriptionBulkOrderConfirmation message in which the individual order confirmation was conveyed may also be quoted in PreviousReference.&#xD;&#xA;The rejection or acceptance of a SubscriptionBulkOrderConfirmationCancellationInstruction is made using an OrderConfirmationStatusReport message."
  registrationStatus="Registered"
  messageSet="_wFQdsE2rEeG_I4xRYCA_7g"
  xmlTag="SbcptBlkOrdrConfCxlInstrV01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_ygggFdE7Ed-BzquC8wXy7w_-1749227623"
    name="AccountIdentificationRule"
    definition="If the confirmation message was linked to an account opening request and the account identification is not yet known then the value of the AccountIdentification element in CancellationByOrderConfirmationDetails/BulkExecutionDetails/IndividualExecutionDetails/InvestmentAccountDetails must be UNKNOWN if present."
    registrationStatus="Provisionally Registered" />
  <xors
    xmi:id="_ygggGNE7Ed-BzquC8wXy7w_-1749227095"
    name="CancellationByReferenceOrByOrderConfirmationDetailsRule"
    definition="Either CancellationByOrderConfirmationDetails or CancellationByReference may be present, but not both."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_ygggEtE7Ed-BzquC8wXy7w_1701642090 _ygggE9E7Ed-BzquC8wXy7w_1699796593" />
  <messageBuildingBlock
    xmi:id="_ygXWKdE7Ed-BzquC8wXy7w_1701643993"
    nextVersions="_Aab7jTbLEead9bDRE_1DAQ"
    name="MessageIdentification"
    definition="Reference that uniquely identifies a message from a business application standpoint."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_ygXWKtE7Ed-BzquC8wXy7w_1700718953"
    nextVersions="_Aab7jzbLEead9bDRE_1DAQ"
    name="PoolReference"
    definition="Collective reference identifying a set of messages."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PoolRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_ygggENE7Ed-BzquC8wXy7w_1700720004"
    nextVersions="_Aab7kTbLEead9bDRE_1DAQ"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_ygggEdE7Ed-BzquC8wXy7w_372102168"
    nextVersions="_Aab7kzbLEead9bDRE_1DAQ"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="RltdRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_ygggEtE7Ed-BzquC8wXy7w_1701642090"
    name="CancellationByReference"
    definition="References of the orders confirmations to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlByRef"
    complexType="_R60r-dp-Ed-ak6NoX_4Aeg_-571676430" />
  <messageBuildingBlock
    xmi:id="_ygggE9E7Ed-BzquC8wXy7w_1699796593"
    name="CancellationByOrderConfirmationDetails"
    definition="Common information related to all the orders confirmations to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlByOrdrConfDtls"
    complexType="_RN-NDNp-Ed-ak6NoX_4Aeg_372099263" />
  <messageBuildingBlock
    xmi:id="_ygggFNE7Ed-BzquC8wXy7w_1702565188"
    nextVersions="_Aab7mTbLEead9bDRE_1DAQ"
    name="CopyDetails"
    definition="Message is a copy."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CpyDtls"
    complexType="_Q7Vk4tp-Ed-ak6NoX_4Aeg_-1918092012" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="049"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.