PriceReportCancellationV04

reda.002.001.04

SCOPE A report provider, for example, a transfer agent, fund accountant or market data provider, sends the PriceReportCancellation message to the report recipient, for example, a fund management company, transfer agent, market data provider, regulator or any other interested party to cancel previously sent prices.

USAGE The PriceReportCancellation message is used to either:

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
%% PriceReportCancellationV04 recursion level 0 with max 0
class PriceReportCancellationV04{
    PriceReportIdentification IsoMax35Text
    CancellationIdentification IsoMax35Text
    CancellationReason IsoMax350Text
    CompletePriceCancellation IsoYesNoIndicator
}
PriceReportCancellationV04 *-- "1..1" MessageIdentification1 : MessageIdentification
PriceReportCancellationV04 *-- "0..1" AdditionalReference3 : PoolReference
PriceReportCancellationV04 *-- "0..1" AdditionalReference3 : PreviousReference
PriceReportCancellationV04 *-- "1..1" Pagination : MessagePagination
PriceReportCancellationV04 *-- "0..1" IDateAndDateTime1Choice : ExpectedPriceCorrectionDate
PriceReportCancellationV04 *-- "0..1" PriceReport3 : CancelledPriceValuationDetails
PriceReportCancellationV04 *-- "0..1" Extension1 : Extension
  

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

Member name Description Data Type / Multiplicity
Identification Identification of the message. IsoMax35Text - Required 1..1
CreationDateTime Date of creation of the message. IsoISODateTime - Required 1..1

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

Member name Description Data Type / Multiplicity
Reference Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. IsoMax35Text - Required 1..1
ReferenceIssuer Issuer of the reference. IPartyIdentification2Choice - Optional 0..1
MessageName Name of a message. IsoMax35Text - Optional 0..1

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

Member name Description Data Type / Multiplicity
Reference Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. IsoMax35Text - Required 1..1
ReferenceIssuer Issuer of the reference. IPartyIdentification2Choice - Optional 0..1
MessageName Name of a message. IsoMax35Text - Optional 0..1

MessagePagination building block

Pagination of the message. 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

Member name Description Data Type / Multiplicity
PageNumber Page number. IsoMax5NumericText - Required 1..1
LastPageIndicator Indicates the last page. IsoYesNoIndicator - Required 1..1

PriceReportIdentification building block

Unique and unambiguous identifier for the price report, as assigned by the reporting party. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

CancellationIdentification building block

Unique and unambiguous identifier for the cancellation of the previous price report, as assigned by the reporting party. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

CancellationReason building block

Reason for the cancellation. Specifies a character string with a maximum length of 350 characters. For comparison, see the ISO20022 official specification This message is declared as Max350Text in the ISO specification. In our implementation, it is represented in source code as IsoMax350Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

ExpectedPriceCorrectionDate building block

Date or date and time the price will be corrected. Choice between a date or a date and time format. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IDateAndDateTime1Choice recursion level 0 with max 1
  

DateAndDateTime1Choice members

Member name Description Data Type / Multiplicity

CompletePriceCancellation building block

Indicates whether or not all the prices of the referenced price report are cancelled. Indicates a “Yes” or “No” type of answer for an element. For comparison, see the ISO20022 official specification This message is declared as YesNoIndicator in the ISO specification. In our implementation, it is represented in source code as IsoYesNoIndicator. Due to global using directives, it is treated as a System.String by the compiler and runtime.

CancelledPriceValuationDetails building block

Details of prices to be cancelled. Information about a price report. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PriceReport3 recursion level 0 with max 1
PriceReport3 *-- "1..0" PriceValuation4 : PriceValuationDetails
%% PriceValuation4 recursion level 1 with max 1
class PriceValuation4{
    Identification IsoMax35Text
    TotalNAV IsoActiveOrHistoricCurrencyAndAmount
    ValuationType ValuationTiming1Code
    ValuationFrequency EventFrequency1Code
    OfficialValuationIndicator IsoYesNoIndicator
    SuspendedIndicator IsoYesNoIndicator
}
PriceValuation4 *-- "0..1" IDateAndDateTimeChoice : ValuationDateTime
PriceValuation4 *-- "1..1" IDateAndDateTimeChoice : NAVDateTime
PriceValuation4 *-- "1..1" FinancialInstrument8 : FinancialInstrumentDetails
PriceValuation4 *-- "0..1" IPartyIdentification2Choice : FundManagementCompany
PriceValuation4 *-- "0..1" FinancialInstrumentQuantity1 : TotalUnitsNumber
PriceValuation4 *-- "0..1" IDateAndDateTimeChoice : NextValuationDateTime
PriceValuation4 *-- "0..1" IDateAndDateTimeChoice : PreviousValuationDateTime
PriceValuation4 *-- "0..0" UnitPrice15 : PriceDetails
PriceValuation4 *-- "0..0" ValuationStatistics3 : ValuationStatistics
PriceValuation4 *-- "0..1" PerformanceFactors1 : PerformanceDetails
  

PriceReport3 members

Member name Description Data Type / Multiplicity
PriceValuationDetails Information related to the price valuation of a financial instrument. PriceValuation4 - Unknown 1..0

Extension building block

Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Extension1 recursion level 0 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

Extension1 members

Member name Description Data Type / Multiplicity
PlaceAndName Name qualifying the information provided in the Text field, and place where this information should be inserted. IsoMax350Text - Required 1..1
Text Text of the extension. IsoMax350Text - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    PriceReportCancellationV04 --|> IOuterRecord : Implements
    PriceReportCancellationV04Document --|> IOuterDocument~PriceReportCancellationV04~ : Implements
    class IOuterDocument~PriceReportCancellationV04~ {
        PriceReportCancellationV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    PriceReportCancellationV04Document *-- PriceReportCancellationV04 : 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:reda.002.001.04">
    <PricRptCxl>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <MsgPgntn>
            <!-- MessagePagination inner content -->
        </MsgPgntn>
        <PricRptId>
            <!-- PriceReportIdentification inner content -->
        </PricRptId>
        <CxlId>
            <!-- CancellationIdentification inner content -->
        </CxlId>
        <CxlRsn>
            <!-- CancellationReason inner content -->
        </CxlRsn>
        <XpctdPricCrrctnDt>
            <!-- ExpectedPriceCorrectionDate inner content -->
        </XpctdPricCrrctnDt>
        <CmpltPricCxl>
            <!-- CompletePriceCancellation inner content -->
        </CmpltPricCxl>
        <CancPricValtnDtls>
            <!-- CancelledPriceValuationDetails inner content -->
        </CancPricValtnDtls>
        <Xtnsn>
            <!-- Extension inner content -->
        </Xtnsn>
    </PricRptCxl>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_M87dQRj3EeKxeog5DTmtgg"
  previousVersion="_ZstsytEvEd-BzquC8wXy7w_-609818463"
  name="PriceReportCancellationV04"
  definition="SCOPE&#xD;&#xA;A report provider, for example, a transfer agent, fund accountant or market data provider, sends the PriceReportCancellation message to the report recipient, for example, a fund management company, transfer agent, market data provider, regulator or any other interested party to cancel previously sent prices.&#xA;&#xD;&#xA;USAGE&#xD;&#xA;The PriceReportCancellation message is used to either: &#xA;- cancel an entire PriceReport that was previously sent (by quoting the business reference of the original price report in the PriceReportIdentification element), or,&#xA;- cancel one or more individual prices from a previously sent price report (by using the PriceDetailsToBeCancelled sequence).&#xA;Technically, it is possible to cancel all the prices individually by using the PriceDetailsToBeCancelled sequence, but this is not recommended.&#xA;The cancellation should not contain the cancellation of prices for more than one NAV date. &#xD;&#xA;&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_wFQdsE2rEeG_I4xRYCA_7g _hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
  xmlTag="PricRptCxl"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_dhjnkRmDEeKxsrht2duUcg"
    name="CompletePriceCancellation1Rule"
    definition="If CompletePriceCancellation is &quot;false&quot; or &quot;0&quot; (No), then one or more instances of CancelledPriceValuationDetails must be present."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/CancelledPriceValuationDetails[*]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/CompletePriceCancellation&lt;/leftOperand&gt;&lt;rightOperand&gt;False&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_oSc-WhmDEeKxsrht2duUcg"
    name="CompletePriceCancellation2Rule"
    definition="If CompletePriceCancellation is &quot;true&quot; or &quot;1&quot; (Yes), then CancelledPriceValuationDetails must not be present."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition&gt;&lt;ComplexRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/CancelledPriceValuationDetails[*]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;EqualToValue&quot;&gt;&lt;leftOperand&gt;/CompletePriceCancellation&lt;/leftOperand&gt;&lt;rightOperand&gt;True&lt;/rightOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;" />
  <messageBuildingBlock
    xmi:id="_M87dQxj3EeKxeog5DTmtgg"
    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="_M87dRxj3EeKxeog5DTmtgg"
    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="_M87dSxj3EeKxeog5DTmtgg"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_M87dTxj3EeKxeog5DTmtgg"
    name="MessagePagination"
    definition="Pagination of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgPgntn"
    complexType="_Q65gBdp-Ed-ak6NoX_4Aeg_-21330104" />
  <messageBuildingBlock
    xmi:id="_NPnKdRmAEeKxsrht2duUcg"
    name="PriceReportIdentification"
    definition="Unique and unambiguous identifier for the price report, as assigned by the reporting party."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="PricRptId"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_epzJZRmAEeKxsrht2duUcg"
    name="CancellationIdentification"
    definition="Unique and unambiguous identifier for the cancellation of the previous price report, as assigned by the reporting party."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CxlId"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_06rKcBmAEeKxsrht2duUcg"
    name="CancellationReason"
    definition="Reason for the cancellation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CxlRsn"
    simpleType="_YW1tKNp-Ed-ak6NoX_4Aeg_1778996852" />
  <messageBuildingBlock
    xmi:id="_RTTz8BmBEeKxsrht2duUcg"
    name="ExpectedPriceCorrectionDate"
    definition="Date or date and time the price will be corrected."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="XpctdPricCrrctnDt"
    complexType="_Axs_MNokEeC60axPepSq7g_-1588891689" />
  <messageBuildingBlock
    xmi:id="_Cj3HgBmCEeKxsrht2duUcg"
    name="CompletePriceCancellation"
    definition="Indicates whether or not all the prices of the referenced price report are cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CmpltPricCxl"
    simpleType="_YXbjA9p-Ed-ak6NoX_4Aeg_-2040117978" />
  <messageBuildingBlock
    xmi:id="_M87dUxj3EeKxeog5DTmtgg"
    name="CancelledPriceValuationDetails"
    definition="Details of prices to be cancelled."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="CancPricValtnDtls"
    complexType="_brky0RmCEeKxsrht2duUcg" />
  <messageBuildingBlock
    xmi:id="_2sI2JRmCEeKxsrht2duUcg"
    name="Extension"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="Xtnsn"
    complexType="_Q6vvCNp-Ed-ak6NoX_4Aeg_1503007069" />
  <messageDefinitionIdentifier
    businessArea="reda"
    messageFunctionality="002"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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