CustodyStatementOfHoldingsCancellationV02

semt.004.001.02

Scope An account servicer, for example, a transfer agent, sends the CustodyStatementOfHoldingsCancellation message to the account owner, for example, an investment manager or its authorised representative to cancel a previously sent CustodyStatementOfHoldings message. Usage The CustodyStatementOfHoldingsCancellation message is used to cancel a previously sent CustodyStatementOfHoldings message. This message must contain the reference of the message to be cancelled. This message may also contain details of the message to be cancelled, but this is not recommended.

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
%% CustodyStatementOfHoldingsCancellationV02 recursion level 0 with max 0
CustodyStatementOfHoldingsCancellationV02 *-- "1..1" MessageIdentification1 : MessageIdentification
CustodyStatementOfHoldingsCancellationV02 *-- "0..1" AdditionalReference2 : PreviousReference
CustodyStatementOfHoldingsCancellationV02 *-- "0..1" AdditionalReference2 : RelatedReference
CustodyStatementOfHoldingsCancellationV02 *-- "1..1" Pagination : MessagePagination
CustodyStatementOfHoldingsCancellationV02 *-- "0..1" CustodyStatementOfHoldings2 : StatementToBeCancelled
  

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

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
%% AdditionalReference2 recursion level 0 with max 1
class AdditionalReference2{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer
%% IPartyIdentification1Choice recursion level 1 with max 1
  

AdditionalReference2 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
%% AdditionalReference2 recursion level 0 with max 1
class AdditionalReference2{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference2 *-- "0..1" IPartyIdentification1Choice : ReferenceIssuer
%% IPartyIdentification1Choice recursion level 1 with max 1
  

AdditionalReference2 members

MessagePagination building block

Number used to sequence pages when it is not possible for data to be conveyed in a single message and the data has to be split across several pages (messages). Number used to sequence pages when it is not possible for data to be conveyed in a single message and the data has to be split across several pages (messages). For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Pagination recursion level 0 with max 1
class Pagination{
    PageNumber IsoMax5NumericText
    LastPageIndicator IsoYesNoIndicator
}
  

Pagination members

StatementToBeCancelled building block

The Custody Statement of Holdings message to cancel. Information about a custody statement of holdings. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CustodyStatementOfHoldings2 recursion level 0 with max 1
CustodyStatementOfHoldings2 *-- "0..1" Statement7 : StatementGeneralDetails
CustodyStatementOfHoldings2 *-- "0..1" SafekeepingAccount2 : AccountDetails
CustodyStatementOfHoldings2 *-- "0..0" AggregateBalanceInformation4 : BalanceForAccount
CustodyStatementOfHoldings2 *-- "0..0" SubAccountIdentification5 : SubAccountDetails
CustodyStatementOfHoldings2 *-- "0..1" TotalValueInPageAndStatement : TotalValues
CustodyStatementOfHoldings2 *-- "0..0" Extension1 : Extension
%% Statement7 recursion level 1 with max 1
class Statement7{
    Reference IsoMax35Text
    ActivityIndicator IsoYesNoIndicator
    ReportNumber IsoMax5NumericText
}
Statement7 *-- "1..1" IDateAndDateTimeChoice : StatementDateTime
Statement7 *-- "0..1" IDateAndDateTimeChoice : CreationDateTime
Statement7 *-- "1..1" IFrequencyCodeAndDSSCode1Choice : Frequency
Statement7 *-- "1..1" IStatementUpdateTypeCodeAndDSSCodeChoice : UpdateType
Statement7 *-- "1..1" IStatementBasisCodeAndDSSCodeChoice : StatementBasis
%% SafekeepingAccount2 recursion level 1 with max 1
class SafekeepingAccount2{
    FungibleIndicator IsoYesNoIndicator
    Name IsoMax35Text
    Designation IsoMax35Text
}
SafekeepingAccount2 *-- "1..1" IAccountIdentificationFormatChoice : Identification
SafekeepingAccount2 *-- "0..10" Intermediary11 : IntermediaryInformation
SafekeepingAccount2 *-- "0..1" IPartyIdentification2Choice : AccountOwner
SafekeepingAccount2 *-- "0..1" IPartyIdentification2Choice : AccountServicer
%% AggregateBalanceInformation4 recursion level 1 with max 1
class AggregateBalanceInformation4{
    DaysAccrued IsoNumber
    HoldingValue IsoActiveOrHistoricCurrencyAndAmount
    PreviousHoldingValue IsoActiveOrHistoricCurrencyAndAmount
    AccruedInterestAmount IsoActiveOrHistoricCurrencyAndAmount
    AccruedInterestAmountSign IsoPlusOrMinusIndicator
    BookValue IsoActiveOrHistoricCurrencyAndAmount
}
AggregateBalanceInformation4 *-- "1..1" IBalanceQuantity1Choice : AggregateQuantity
AggregateBalanceInformation4 *-- "0..1" IBalanceQuantity1Choice : AvailableQuantity
AggregateBalanceInformation4 *-- "0..1" IBalanceQuantity1Choice : NotAvailableQuantity
AggregateBalanceInformation4 *-- "0..1" ISafekeepingPlaceFormatChoice : SafekeepingPlace
AggregateBalanceInformation4 *-- "1..1" FinancialInstrument13 : FinancialInstrumentDetails
AggregateBalanceInformation4 *-- "0..0" PriceInformation2 : PriceDetails
AggregateBalanceInformation4 *-- "0..1" ForeignExchangeTerms6 : ForeignExchangeDetails
AggregateBalanceInformation4 *-- "0..0" SubBalanceInformation2 : BalanceBreakdownDetails
AggregateBalanceInformation4 *-- "0..0" AdditionalBalanceInformation2 : AdditionalBalanceBreakdownDetails
AggregateBalanceInformation4 *-- "0..0" AggregateBalancePerSafekeepingPlace3 : BalanceAtSafekeepingPlace
%% SubAccountIdentification5 recursion level 1 with max 1
class SubAccountIdentification5{
    FungibleIndicator IsoYesNoIndicator
    ActivityIndicator IsoYesNoIndicator
}
SubAccountIdentification5 *-- "1..1" IAccountIdentificationFormatChoice : Identification
SubAccountIdentification5 *-- "0..0" AggregateBalanceInformation4 : BalanceForSubAccount
%% TotalValueInPageAndStatement recursion level 1 with max 1
class TotalValueInPageAndStatement{
    TotalHoldingsValueOfPage IsoActiveCurrencyAndAmount
    TotalHoldingsValueOfStatement IsoActiveCurrencyAndAmount
}
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

CustodyStatementOfHoldings2 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CustodyStatementOfHoldingsCancellationV02 --|> IOuterRecord : Implements
    CustodyStatementOfHoldingsCancellationV02Document --|> IOuterDocument~CustodyStatementOfHoldingsCancellationV02~ : Implements
    class IOuterDocument~CustodyStatementOfHoldingsCancellationV02~ {
        CustodyStatementOfHoldingsCancellationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    CustodyStatementOfHoldingsCancellationV02Document *-- CustodyStatementOfHoldingsCancellationV02 : 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:semt.004.001.02">
    <CtdyStmtOfHldgsCxlV02>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <MsgPgntn>
            <!-- MessagePagination inner content -->
        </MsgPgntn>
        <StmtToBeCanc>
            <!-- StatementToBeCancelled inner content -->
        </StmtToBeCanc>
    </CtdyStmtOfHldgsCxlV02>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Mb_vvNFSEd-BzquC8wXy7w_-145472728"
  previousVersion="_MXYVe9FSEd-BzquC8wXy7w_1108713826"
  name="CustodyStatementOfHoldingsCancellationV02"
  definition="Scope&#xD;&#xA;An account servicer, for example, a transfer agent, sends the CustodyStatementOfHoldingsCancellation message to the account owner, for example, an investment manager or its authorised representative to cancel a previously sent CustodyStatementOfHoldings message.&#xD;&#xA;Usage&#xD;&#xA;The CustodyStatementOfHoldingsCancellation message is used to cancel a previously sent CustodyStatementOfHoldings message. This message must contain the reference of the message to be cancelled.&#xD;&#xA;This message may also contain details of the message to be cancelled, but this is not recommended."
  registrationStatus="Registered"
  messageSet="_wFQdsE2rEeG_I4xRYCA_7g _hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
  xmlTag="CtdyStmtOfHldgsCxlV02"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_Mb_vvdFSEd-BzquC8wXy7w_682925728"
    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="_Mb_vvtFSEd-BzquC8wXy7w_-145472685"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
  <messageBuildingBlock
    xmi:id="_Mb_vv9FSEd-BzquC8wXy7w_-145472650"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="RltdRef"
    complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
  <messageBuildingBlock
    xmi:id="_McJgsNFSEd-BzquC8wXy7w_-145472572"
    name="MessagePagination"
    definition="Number used to sequence pages when it is not possible for data to be conveyed in a single message and the data has to be split across several pages (messages)."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgPgntn"
    complexType="_Q65gBdp-Ed-ak6NoX_4Aeg_-21330104" />
  <messageBuildingBlock
    xmi:id="_McJgsdFSEd-BzquC8wXy7w_-145472607"
    name="StatementToBeCancelled"
    definition="The Custody Statement of Holdings message to cancel."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="StmtToBeCanc"
    complexType="_RPKf0tp-Ed-ak6NoX_4Aeg_1115213683" />
  <messageDefinitionIdentifier
    businessArea="semt"
    messageFunctionality="004"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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