CustodyStatementOfHoldingsCancellation

semt.004.001.01

Scope The CustodyStatementOfHoldingsCancellation message is sent by an account servicer to the account owner or the account owner’s designated agent. The account servicer may be a local agent (sub-custodian) acting on behalf of its global custodian customer, a custodian acting on behalf of an investment management institution or a broker/dealer, a fund administrator or fund intermediary, trustee or registrar, etc. This message is used to cancel a previously sent CustodyStatementOfHoldings message. Usage The CustodyStatementOfHoldingsCancellation message is sent by an account servicer to the account owner 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
%% CustodyStatementOfHoldingsCancellation recursion level 0 with max 0
CustodyStatementOfHoldingsCancellation *-- "1..1" AdditionalReference2 : PreviousReference
CustodyStatementOfHoldingsCancellation *-- "0..1" AdditionalReference2 : RelatedReference
CustodyStatementOfHoldingsCancellation *-- "1..1" Pagination : MessagePagination
CustodyStatementOfHoldingsCancellation *-- "0..1" CustodyStatementOfHoldings1 : StatementToBeCancelled
  

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

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
%% CustodyStatementOfHoldings1 recursion level 0 with max 1
CustodyStatementOfHoldings1 *-- "1..1" Pagination : MessagePagination
CustodyStatementOfHoldings1 *-- "0..1" Statement3 : StatementGeneralDetails
CustodyStatementOfHoldings1 *-- "0..1" SafekeepingAccount1 : AccountDetails
CustodyStatementOfHoldings1 *-- "0..0" AggregateBalanceInformation1 : BalanceForAccount
CustodyStatementOfHoldings1 *-- "0..0" SubAccountIdentification1 : SubAccountDetails
CustodyStatementOfHoldings1 *-- "0..1" TotalValueInPageAndStatement : TotalValues
CustodyStatementOfHoldings1 *-- "0..0" Extension1 : Extension
%% Pagination recursion level 1 with max 1
class Pagination{
    PageNumber IsoMax5NumericText
    LastPageIndicator IsoYesNoIndicator
}
%% Statement3 recursion level 1 with max 1
class Statement3{
    Reference IsoMax35Text
    ActivityIndicator IsoYesNoIndicator
    ReportNumber IsoMax5NumericText
}
Statement3 *-- "1..1" IDateAndDateTimeChoice : StatementDateTime
Statement3 *-- "0..1" IDateAndDateTimeChoice : CreationDateTime
Statement3 *-- "0..1" IFrequencyCodeAndDSSCodeChoice : Frequency
Statement3 *-- "0..1" IStatementUpdateTypeCodeAndDSSCodeChoice : UpdateType
Statement3 *-- "0..1" IStatementBasisCodeAndDSSCodeChoice : StatementBasis
%% SafekeepingAccount1 recursion level 1 with max 1
class SafekeepingAccount1{
    FungibleIndicator IsoYesNoIndicator
    Name IsoMax35Text
    Designation IsoMax35Text
}
SafekeepingAccount1 *-- "1..1" IAccountIdentificationFormatChoice : Identification
SafekeepingAccount1 *-- "0..10" Intermediary1 : IntermediaryInformation
SafekeepingAccount1 *-- "0..1" IPartyIdentification1Choice : AccountOwner
SafekeepingAccount1 *-- "0..1" IPartyIdentification1Choice : AccountServicer
%% AggregateBalanceInformation1 recursion level 1 with max 1
class AggregateBalanceInformation1{
    DaysAccrued IsoNumber
    HoldingValue IsoActiveOrHistoricCurrencyAndAmount
    AccruedInterestAmount IsoActiveOrHistoricCurrencyAndAmount
    BookValue IsoActiveOrHistoricCurrencyAndAmount
}
AggregateBalanceInformation1 *-- "1..1" IBalanceQuantity1Choice : AggregateQuantity
AggregateBalanceInformation1 *-- "0..1" IBalanceQuantity1Choice : AvailableQuantity
AggregateBalanceInformation1 *-- "0..1" IBalanceQuantity1Choice : NotAvailableQuantity
AggregateBalanceInformation1 *-- "0..1" ISafekeepingPlaceFormatChoice : SafekeepingPlace
AggregateBalanceInformation1 *-- "1..1" FinancialInstrument4 : FinancialInstrumentDetails
AggregateBalanceInformation1 *-- "0..0" PriceInformation1 : PriceDetails
AggregateBalanceInformation1 *-- "0..1" ForeignExchangeTerms3 : ForeignExchangeDetails
AggregateBalanceInformation1 *-- "0..0" SubBalanceInformation1 : BalanceBreakdownDetails
AggregateBalanceInformation1 *-- "0..0" AdditionalBalanceInformation : AdditionalBalanceBreakdownDetails
AggregateBalanceInformation1 *-- "0..0" AggregateBalancePerSafekeepingPlace1 : BalanceAtSafekeepingPlace
%% SubAccountIdentification1 recursion level 1 with max 1
class SubAccountIdentification1{
    FungibleIndicator IsoYesNoIndicator
    ActivityIndicator IsoYesNoIndicator
}
SubAccountIdentification1 *-- "1..1" IAccountIdentificationFormatChoice : Identification
SubAccountIdentification1 *-- "0..0" AggregateBalanceInformation1 : 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
}
  

CustodyStatementOfHoldings1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CustodyStatementOfHoldingsCancellation --|> IOuterRecord : Implements
    CustodyStatementOfHoldingsCancellationDocument --|> IOuterDocument~CustodyStatementOfHoldingsCancellation~ : Implements
    class IOuterDocument~CustodyStatementOfHoldingsCancellation~ {
        CustodyStatementOfHoldingsCancellation Message
     }
  

Document wrapper for serialization

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

classDiagram
    CustodyStatementOfHoldingsCancellationDocument *-- CustodyStatementOfHoldingsCancellation : 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.01">
    <semt.004.001.01>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <MsgPgntn>
            <!-- MessagePagination inner content -->
        </MsgPgntn>
        <StmtToBeCanc>
            <!-- StatementToBeCancelled inner content -->
        </StmtToBeCanc>
    </semt.004.001.01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_MXYVe9FSEd-BzquC8wXy7w_1108713826"
  nextVersions="_Mb_vvNFSEd-BzquC8wXy7w_-145472728"
  name="CustodyStatementOfHoldingsCancellation"
  definition="Scope&#xD;&#xA;The CustodyStatementOfHoldingsCancellation message is sent by an account servicer to the account owner or the account owner's designated agent. The account servicer may be a local agent (sub-custodian) acting on behalf of its global custodian customer, a custodian acting on behalf of an investment management institution or a broker/dealer, a fund administrator or fund intermediary, trustee or registrar, etc.&#xD;&#xA;This message is used to cancel a previously sent CustodyStatementOfHoldings message.&#xD;&#xA;Usage&#xD;&#xA;The CustodyStatementOfHoldingsCancellation message is sent by an account servicer to the account owner to cancel a previously sent CustodyStatementOfHoldings message.&#xD;&#xA;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."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="semt.004.001.01"
  xmlTag="semt.004.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_MXYVfNFSEd-BzquC8wXy7w_1620345511"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="PrvsRef"
    complexType="_RNE1Kdp-Ed-ak6NoX_4Aeg_-577369889" />
  <messageBuildingBlock
    xmi:id="_MXYVfdFSEd-BzquC8wXy7w_1938037635"
    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="_MXYVftFSEd-BzquC8wXy7w_1983699054"
    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="_MXhfYNFSEd-BzquC8wXy7w_-1021887814"
    name="StatementToBeCancelled"
    definition="The Custody Statement of Holdings message to cancel."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="StmtToBeCanc"
    complexType="_UyjHA9p-Ed-ak6NoX_4Aeg_-1254942072" />
  <messageDefinitionIdentifier
    businessArea="semt"
    messageFunctionality="004"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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