setr.054.001.01
Scope An executing party, for example, a transfer agent, sends the RedemptionBulkOrderConfirmationAmendment message to the instructing party, for example, an investment manager or its authorised representative to amend a previously sent RedemptionBulkOrderConfirmation message. Usage The RedemptionBulkOrderConfirmationAmendment message is used to amend one or more previously sent redemption bulk order confirmations. Each bulk order confirmation amendment specified is identified in DealReference. The reference of the original individual order is specified in OrderReference. The message identification of the RedemptionBulkOrder message in which the orders were conveyed may also be quoted in RelatedReference. The message identification of the RedemptionBulkOrderConfirmation message in which the original order confirmations were conveyed may also be quoted in PreviousReference.
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 %% RedemptionBulkOrderConfirmationAmendmentV01 recursion level 0 with max 0 RedemptionBulkOrderConfirmationAmendmentV01 *-- "1..1" MessageIdentification1 : MessageIdentification RedemptionBulkOrderConfirmationAmendmentV01 *-- "0..1" AdditionalReference3 : PoolReference RedemptionBulkOrderConfirmationAmendmentV01 *-- "0..1" AdditionalReference3 : PreviousReference RedemptionBulkOrderConfirmationAmendmentV01 *-- "0..1" AdditionalReference3 : RelatedReference RedemptionBulkOrderConfirmationAmendmentV01 *-- "1..1" RedemptionBulkExecution3 : BulkExecutionDetails RedemptionBulkOrderConfirmationAmendmentV01 *-- "0..10" Intermediary9 : RelatedPartyDetails RedemptionBulkOrderConfirmationAmendmentV01 *-- "0..1" CopyInformation2 : CopyDetails RedemptionBulkOrderConfirmationAmendmentV01 *-- "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 |
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
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 |
BulkExecutionDetails building block
General information related to the execution of investment fund orders. Execution of a redemption order. For comparison, see the ISO20022 official specification
classDiagram direction tb %% RedemptionBulkExecution3 recursion level 0 with max 1 class RedemptionBulkExecution3{ MasterReference IsoMax35Text OrderDateTime IsoISODateTime RequestedFutureTradeDate IsoISODate CancellationRight CancellationRight1Code ExtendedCancellationRight IsoExtended350Code RequestedSettlementCurrency ActiveCurrencyCode RequestedNAVCurrency ActiveOrHistoricCurrencyCode TotalSettlementAmount IsoActiveCurrencyAndAmount CashSettlementDate IsoISODate } RedemptionBulkExecution3 *-- "0..1" IPlaceOfTradeIdentification1Choice : PlaceOfTrade RedemptionBulkExecution3 *-- "1..1" FinancialInstrument10 : FinancialInstrumentDetails RedemptionBulkExecution3 *-- "1..0" RedemptionExecution5 : IndividualExecutionDetails RedemptionBulkExecution3 *-- "0..1" PaymentTransaction22 : BulkCashSettlementDetails %% IPlaceOfTradeIdentification1Choice recursion level 1 with max 1 %% FinancialInstrument10 recursion level 1 with max 1 class FinancialInstrument10{ Name IsoMax350Text SupplementaryIdentification IsoMax35Text ClassType IsoMax35Text SecuritiesForm FormOfSecurity1Code DistributionPolicy DistributionPolicy1Code ProductGroup IsoMax140Text } FinancialInstrument10 *-- "1..1" ISecurityIdentification3Choice : Identification %% RedemptionExecution5 recursion level 1 with max 1 class RedemptionExecution5{ OrderReference IsoMax35Text ClientReference IsoMax35Text DealReference IsoMax35Text Rounding RoundingDirection2Code NetAmount IsoActiveCurrencyAndAmount HoldingsRedemptionRate IsoPercentageRate GrossAmount IsoActiveCurrencyAndAmount SettlementAmount IsoActiveCurrencyAndAmount CashSettlementDate IsoISODate SettlementMethod DeliveryReceiptType2Code PartiallyExecutedIndicator IsoYesNoIndicator BestExecution BestExecution1Code CumDividendIndicator IsoYesNoIndicator IncomePreference IncomePreference1Code Group1Or2Units UKTaxGroupUnitCode PhysicalDeliveryIndicator IsoYesNoIndicator NonStandardSettlementInformation IsoMax350Text PartialSettlementOfUnits IsoPercentageRate PartialSettlementOfCash IsoPercentageRate PartialRedemptionWithholdingAmount IsoCurrencyAndAmount FinancialAdvice FinancialAdvice1Code NegotiatedTrade NegotiatedTrade1Code LateReport LateReport1Code } RedemptionExecution5 *-- "0..10" FundOrderType3 : OrderType RedemptionExecution5 *-- "0..1" IndividualPerson12 : BeneficiaryDetails RedemptionExecution5 *-- "1..1" FinancialInstrumentQuantity1 : UnitsNumber RedemptionExecution5 *-- "1..1" InvestmentAccount21 : InvestmentAccountDetails RedemptionExecution5 *-- "1..1" IDateAndDateTimeChoice : TradeDateTime RedemptionExecution5 *-- "1..1" UnitPrice10 : DealingPriceDetails RedemptionExecution5 *-- "0..2" UnitPrice10 : InformativePriceDetails RedemptionExecution5 *-- "0..1" IProfitAndLoss1Choice : InterimProfitAmount RedemptionExecution5 *-- "0..0" ForeignExchangeTerms7 : ForeignExchangeDetails RedemptionExecution5 *-- "0..1" TotalCharges3 : ChargeGeneralDetails RedemptionExecution5 *-- "0..1" TotalCommissions3 : CommissionGeneralDetails RedemptionExecution5 *-- "0..4" InvestmentFundsOrderBreakdown1 : StaffClientBreakdown RedemptionExecution5 *-- "0..1" TotalTaxes3 : TaxGeneralDetails RedemptionExecution5 *-- "0..1" FundSettlementParameters4 : SettlementAndCustodyDetails RedemptionExecution5 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails RedemptionExecution5 *-- "0..1" PaymentTransaction22 : CashSettlementDetails RedemptionExecution5 *-- "0..10" Intermediary9 : RelatedPartyDetails RedemptionExecution5 *-- "0..1" Equalisation1 : Equalisation %% PaymentTransaction22 recursion level 1 with max 1 PaymentTransaction22 *-- "0..1" IPaymentInstrument11Choice : PaymentInstrument
RedemptionBulkExecution3 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MasterReference | Unique and unambiguous identifier for a group of individual orders, as assigned by the instructing party. This identifier links the individual orders together. | IsoMax35Text - Optional 0..1 |
PlaceOfTrade | Market in which the advised trade transaction was executed. | IPlaceOfTradeIdentification1Choice - Optional 0..1 |
OrderDateTime | Date and time at which the order was placed by the investor. | IsoISODateTime - Optional 0..1 |
RequestedFutureTradeDate | Future date at which the investor requests the order to be executed. | The specification of a requested future trade date is not allowed in some markets. The date must be a date in the future. |
CancellationRight | Cancellation right of an investor with respect to an investment fund order. | CancellationRight1Code - Optional 0..1 |
ExtendedCancellationRight | Cancellation right of an investor with respect to an investment fund order. | IsoExtended350Code - Optional 0..1 |
FinancialInstrumentDetails | Investment fund class to which an investment fund order execution is related. | FinancialInstrument10 - Required 1..1 |
IndividualExecutionDetails | Execution of a redemption order. | RedemptionExecution5 - Unknown 1..0 |
RequestedSettlementCurrency | Currency requested for settlement of cash proceeds. | ActiveCurrencyCode - Optional 0..1 |
RequestedNAVCurrency | Currency to be used for pricing the fund. This currency must be among the set of currencies in which the price may be expressed, as stated in the prospectus. | ActiveOrHistoricCurrencyCode - Optional 0..1 |
TotalSettlementAmount | Total amount of money paid /to be paid or received in exchange for the financial instrument in the multiple order. | IsoActiveCurrencyAndAmount - Optional 0..1 |
CashSettlementDate | Date on which cash is available. | IsoISODate - Optional 0..1 |
BulkCashSettlementDetails | Payment processes required to transfer cash from the debtor to the creditor. | PaymentTransaction22 - Optional 0..1 |
RelatedPartyDetails building block
Information about parties related to the transaction. Party that provides services to investors relating to financial products. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Intermediary9 recursion level 0 with max 1 class Intermediary9{ OrderOriginatorEligibility OrderOriginatorEligibility1Code TradingPartyCapacity TradingCapacity2Code Role InvestmentFundRole2Code ExtendedRole IsoExtended350Code } Intermediary9 *-- "1..1" IPartyIdentification2Choice : Identification Intermediary9 *-- "0..1" Account7 : Account %% IPartyIdentification2Choice recursion level 1 with max 1 %% Account7 recursion level 1 with max 1 Account7 *-- "1..1" AccountIdentification1 : Identification Account7 *-- "0..1" IPartyIdentification2Choice : AccountServicer
Intermediary9 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Unique and unambiguous identifier of the intermediary. | IPartyIdentification2Choice - Required 1..1 |
Account | Business relationship between two entities; one entity is the account owner, the other entity is the account servicer. | Account7 - Optional 0..1 |
OrderOriginatorEligibility | Counterparties eligibility as defined by article 24 of the EU MiFID Directive applicable to transactions executed by investment firms for eligible counterparties. | OrderOriginatorEligibility1Code - Optional 0..1 |
TradingPartyCapacity | Capacity of the party executing an order. | TradingCapacity2Code - Optional 0..1 |
Role | Function performed by the intermediary. | InvestmentFundRole2Code - Optional 0..1 |
ExtendedRole | Function performed by the intermediary. | IsoExtended350Code - Optional 0..1 |
CopyDetails building block
Information provided when the message is a copy of a previous message. 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
Member name | Description | Data Type / Multiplicity |
---|---|---|
CopyIndicator | Indicates whether the message is a copy. | IsoYesNoIndicator - Required 1..1 |
OriginalReceiver | Original receiver of the message, if this message is a copy. | BICIdentification1 - Optional 0..1 |
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 RedemptionBulkOrderConfirmationAmendmentV01 implementation follows a specific implementaiton pattern. First of all, RedemptionBulkOrderConfirmationAmendmentV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RedemptionBulkOrderConfirmationAmendmentV01Document implements IOuterDocument. Because RedemptionBulkOrderConfirmationAmendmentV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RedemptionBulkOrderConfirmationAmendmentV01.
classDiagram class IOuterRecord RedemptionBulkOrderConfirmationAmendmentV01 --|> IOuterRecord : Implements RedemptionBulkOrderConfirmationAmendmentV01Document --|> IOuterDocument~RedemptionBulkOrderConfirmationAmendmentV01~ : Implements class IOuterDocument~RedemptionBulkOrderConfirmationAmendmentV01~ { RedemptionBulkOrderConfirmationAmendmentV01 Message }
Document wrapper for serialization
The only real purpose RedemptionBulkOrderConfirmationAmendmentV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.054.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RedemptionBulkOrderConfirmationAmendmentV01.ToDocument() method. The returned RedemptionBulkOrderConfirmationAmendmentV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram RedemptionBulkOrderConfirmationAmendmentV01Document *-- RedemptionBulkOrderConfirmationAmendmentV01 : 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.054.001.01">
<RedBlkOrdrConfAmdmntV01>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<PoolRef>
<!-- PoolReference inner content -->
</PoolRef>
<PrvsRef>
<!-- PreviousReference inner content -->
</PrvsRef>
<RltdRef>
<!-- RelatedReference inner content -->
</RltdRef>
<BlkExctnDtls>
<!-- BulkExecutionDetails inner content -->
</BlkExctnDtls>
<RltdPtyDtls>
<!-- RelatedPartyDetails inner content -->
</RltdPtyDtls>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</RedBlkOrdrConfAmdmntV01>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_oK5XINE7Ed-BzquC8wXy7w_-352837634"
name="RedemptionBulkOrderConfirmationAmendmentV01"
definition="Scope
An executing party, for example, a transfer agent, sends the RedemptionBulkOrderConfirmationAmendment message to the instructing party, for example, an investment manager or its authorised representative to amend a previously sent RedemptionBulkOrderConfirmation message.
Usage
The RedemptionBulkOrderConfirmationAmendment message is used to amend one or more previously sent redemption bulk order confirmations.
Each bulk order confirmation amendment specified is identified in DealReference. The reference of the original individual order is specified in OrderReference.
The message identification of the RedemptionBulkOrder message in which the orders were conveyed may also be quoted in RelatedReference. The message identification of the RedemptionBulkOrderConfirmation message in which the original order confirmations were conveyed may also be quoted in PreviousReference."
registrationStatus="Registered"
messageSet="_wFQdsE2rEeG_I4xRYCA_7g"
xmlTag="RedBlkOrdrConfAmdmntV01"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_oLDIINE7Ed-BzquC8wXy7w_82026730"
name="AccountIdentificationRule"
definition="If this message is linked to an account opening request and the account identification is not yet known then the value of the AccountIdentification element in BulkExecutionDetails/IndividualExecutionDetails/InvestmentAccountDetails must be UNKNOWN."
registrationStatus="Provisionally Registered" />
<constraint
xmi:id="_oLDII9E7Ed-BzquC8wXy7w_82026772"
name="OrderReferenceRule"
definition="If this message is not solicited by the receiver, then the value of the OrderReference element in every occurrence of BulkExecutionDetails/IndividualExecutionDetails must be UNSOLICITED."
registrationStatus="Provisionally Registered" />
<constraint
xmi:id="_oLDIJtE7Ed-BzquC8wXy7w_82027102"
name="RelatedPartiesDetailsRule"
definition="Either RelatedPartiesDetails or BulkExecutionDetails/IndividualExecutionDetails/RelatedPartiesDetails may be present, but not both."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_oK5XIdE7Ed-BzquC8wXy7w_-86056513"
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="_oK5XItE7Ed-BzquC8wXy7w_-86979123"
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="_oK5XI9E7Ed-BzquC8wXy7w_-86978193"
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="_oK5XJNE7Ed-BzquC8wXy7w_-86978625"
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="_oK5XJdE7Ed-BzquC8wXy7w_-86057057"
name="BulkExecutionDetails"
definition="General information related to the execution of investment fund orders."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="BlkExctnDtls"
complexType="_R2Dgudp-Ed-ak6NoX_4Aeg_-675591954" />
<messageBuildingBlock
xmi:id="_oK5XJtE7Ed-BzquC8wXy7w_-86977676"
name="RelatedPartyDetails"
definition="Information about parties related to the transaction."
registrationStatus="Provisionally Registered"
maxOccurs="10"
minOccurs="0"
xmlTag="RltdPtyDtls"
complexType="_QN5QFtp-Ed-ak6NoX_4Aeg_-1242436209" />
<messageBuildingBlock
xmi:id="_oK5XJ9E7Ed-BzquC8wXy7w_-86977520"
name="CopyDetails"
definition="Information provided when the message is a copy of a previous message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CpyDtls"
complexType="_Q7Vk4tp-Ed-ak6NoX_4Aeg_-1918092012" />
<messageBuildingBlock
xmi:id="_oK5XKNE7Ed-BzquC8wXy7w_-86057117"
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="setr"
messageFunctionality="054"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.