setr.009.001.04
Scope The SubscriptionBulkOrderConfirmation message is sent by an executing party, for example, a transfer agent, to the instructing party, for example, an investment manager or its authorised representative, to confirm the details of the execution of a SubscriptionBulkOrder instruction. Usage The SubscriptionBulkOrderConfirmation message is used to confirm the execution of all individual orders. There is usually one bulk confirmation message for one bulk order message. Each individual order confirmation specified is identified in DealReference. The reference of the original individual order is specified in OrderReference. The message identification of the SubscriptionBulkOrder message in which the individual order was conveyed may also be quoted in RelatedReference. A SubscriptionBulkOrder must in all cases be responded to by a SubscriptionBulkOrderConfirmation and in no circumstances by a SubscriptionOrderConfirmation. If the executing party needs to confirm a SubscriptionOrder instruction, then the SubscriptionOrderConfirmation must be used. When the message is used to convey a confirmation amendment/s, the AmendmentIndicator must be present with the value ‘true’ or ‘1’. When this is the case, the message must only contain a confirmation amendment/s and not contain both a confirmation amendment/s and a ‘new’ confirmation/s.
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 %% SubscriptionBulkOrderConfirmationV04 recursion level 0 with max 0 SubscriptionBulkOrderConfirmationV04 *-- "1..1" MessageIdentification1 : MessageIdentification SubscriptionBulkOrderConfirmationV04 *-- "0..1" AdditionalReference9 : PoolReference SubscriptionBulkOrderConfirmationV04 *-- "0..1" AdditionalReference8 : PreviousReference SubscriptionBulkOrderConfirmationV04 *-- "0..1" AdditionalReference8 : RelatedReference SubscriptionBulkOrderConfirmationV04 *-- "1..1" SubscriptionBulkExecution4 : BulkExecutionDetails SubscriptionBulkOrderConfirmationV04 *-- "0..1" CopyInformation4 : CopyDetails SubscriptionBulkOrderConfirmationV04 *-- "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 the 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 %% AdditionalReference9 recursion level 0 with max 1 class AdditionalReference9{ Reference IsoMax35Text MessageName IsoMax35Text } AdditionalReference9 *-- "0..1" PartyIdentification113 : ReferenceIssuer %% PartyIdentification113 recursion level 1 with max 1 class PartyIdentification113{ LEI IsoLEIIdentifier } PartyIdentification113 *-- "1..1" IPartyIdentification90Choice : Party
AdditionalReference9 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Reference | Reference identifying a set of messages. | IsoMax35Text - Required 1..1 |
ReferenceIssuer | Issuer of the reference. | PartyIdentification113 - Optional 0..1 |
MessageName | Name of the 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 %% AdditionalReference8 recursion level 0 with max 1 class AdditionalReference8{ Reference IsoMax35Text MessageName IsoMax35Text } AdditionalReference8 *-- "0..1" PartyIdentification113 : ReferenceIssuer %% PartyIdentification113 recursion level 1 with max 1 class PartyIdentification113{ LEI IsoLEIIdentifier } PartyIdentification113 *-- "1..1" IPartyIdentification90Choice : Party
AdditionalReference8 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Reference | Reference issued by a party to identify an instruction, transaction or a message. | IsoMax35Text - Required 1..1 |
ReferenceIssuer | Issuer of the reference. | PartyIdentification113 - Optional 0..1 |
MessageName | Name of the 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 %% AdditionalReference8 recursion level 0 with max 1 class AdditionalReference8{ Reference IsoMax35Text MessageName IsoMax35Text } AdditionalReference8 *-- "0..1" PartyIdentification113 : ReferenceIssuer %% PartyIdentification113 recursion level 1 with max 1 class PartyIdentification113{ LEI IsoLEIIdentifier } PartyIdentification113 *-- "1..1" IPartyIdentification90Choice : Party
AdditionalReference8 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Reference | Reference issued by a party to identify an instruction, transaction or a message. | IsoMax35Text - Required 1..1 |
ReferenceIssuer | Issuer of the reference. | PartyIdentification113 - Optional 0..1 |
MessageName | Name of the message. | IsoMax35Text - Optional 0..1 |
BulkExecutionDetails building block
General information related to the execution of the orders. Execution of a subscription order. For comparison, see the ISO20022 official specification
classDiagram direction tb %% SubscriptionBulkExecution4 recursion level 0 with max 1 class SubscriptionBulkExecution4{ AmendmentIndicator IsoYesNoIndicator MasterReference IsoMax35Text OrderDateTime IsoISODateTime ReceivedDateTime IsoISODateTime RequestedFutureTradeDate IsoISODate RequestedSettlementCurrency ActiveCurrencyCode RequestedNAVCurrency ActiveOrHistoricCurrencyCode TotalSettlementAmount IsoActiveCurrencyAndAmount } SubscriptionBulkExecution4 *-- "0..1" IPlaceOfTradeIdentification1Choice : PlaceOfTrade SubscriptionBulkExecution4 *-- "0..1" ICancellationRight1Choice : CancellationRight SubscriptionBulkExecution4 *-- "1..1" FinancialInstrument57 : FinancialInstrumentDetails SubscriptionBulkExecution4 *-- "1..0" SubscriptionExecution12 : IndividualExecutionDetails SubscriptionBulkExecution4 *-- "0..1" PaymentTransaction70 : BulkCashSettlementDetails %% IPlaceOfTradeIdentification1Choice recursion level 1 with max 1 %% ICancellationRight1Choice recursion level 1 with max 1 %% FinancialInstrument57 recursion level 1 with max 1 class FinancialInstrument57{ Name IsoMax350Text ShortName IsoMax35Text SupplementaryIdentification IsoMax35Text ClassType IsoMax35Text SecuritiesForm FormOfSecurity1Code DistributionPolicy DistributionPolicy1Code ProductGroup IsoMax140Text } FinancialInstrument57 *-- "1..1" ISecurityIdentification25Choice : Identification FinancialInstrument57 *-- "0..1" Series1 : SeriesIdentification %% SubscriptionExecution12 recursion level 1 with max 1 class SubscriptionExecution12{ OrderReference IsoMax35Text ClientReference IsoMax35Text DealReference IsoMax35Text UnitsNumber IsoDecimalNumber Rounding RoundingDirection2Code NetAmount IsoActiveCurrencyAndAmount GrossAmount IsoActiveCurrencyAndAmount SettlementAmount IsoActiveCurrencyAndAmount CashSettlementDate IsoISODate SettlementMethod DeliveryReceiptType2Code PartiallyExecutedIndicator IsoYesNoIndicator BestExecution BestExecution1Code CumDividendIndicator IsoYesNoIndicator IncomePreference IncomePreference1Code LetterIntentReference IsoMax35Text AccumulationRightReference IsoMax35Text PhysicalDeliveryIndicator IsoYesNoIndicator Refund IsoActiveCurrencyAndAmount SubscriptionInterest IsoActiveCurrencyAndAmount NonStandardSettlementInformation IsoMax350Text PartialSettlementOfUnits IsoPercentageRate FinancialAdvice FinancialAdvice1Code NegotiatedTrade NegotiatedTrade1Code LateReport LateReport1Code PartialSettlementOfCash IsoPercentageRate } SubscriptionExecution12 *-- "0..10" IFundOrderType4Choice : OrderType SubscriptionExecution12 *-- "1..1" InvestmentAccount58 : InvestmentAccountDetails SubscriptionExecution12 *-- "0..0" IndividualPerson31 : BeneficiaryDetails SubscriptionExecution12 *-- "1..1" IDateAndDateTimeChoice : TradeDateTime SubscriptionExecution12 *-- "1..1" UnitPrice22 : DealingPriceDetails SubscriptionExecution12 *-- "0..2" UnitPrice22 : InformativePriceDetails SubscriptionExecution12 *-- "0..1" IProfitAndLoss2Choice : InterimProfitAmount SubscriptionExecution12 *-- "0..0" ForeignExchangeTerms33 : ForeignExchangeDetails SubscriptionExecution12 *-- "0..1" TotalFeesAndTaxes40 : TransactionOverhead SubscriptionExecution12 *-- "0..1" InformativeTax1 : InformativeTaxDetails SubscriptionExecution12 *-- "0..1" FundSettlementParameters12 : SettlementAndCustodyDetails SubscriptionExecution12 *-- "0..1" DeliveryParameters3 : PhysicalDeliveryDetails SubscriptionExecution12 *-- "0..4" InvestmentFundsOrderBreakdown2 : StaffClientBreakdown SubscriptionExecution12 *-- "0..1" PaymentTransaction70 : CashSettlementDetails SubscriptionExecution12 *-- "0..10" Intermediary39 : RelatedPartyDetails SubscriptionExecution12 *-- "0..1" Equalisation1 : Equalisation SubscriptionExecution12 *-- "0..0" ISourceOfCash1Choice : SourceOfCash SubscriptionExecution12 *-- "0..1" ICustomerConductClassification1Choice : CustomerConductClassification SubscriptionExecution12 *-- "0..1" ITransactionChannelType1Choice : TransactionChannelType SubscriptionExecution12 *-- "0..1" ISignatureType1Choice : SignatureType SubscriptionExecution12 *-- "0..1" OrderWaiver1 : OrderWaiverDetails %% PaymentTransaction70 recursion level 1 with max 1 PaymentTransaction70 *-- "1..1" IPaymentInstrument20Choice : PaymentInstrument
SubscriptionBulkExecution4 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
AmendmentIndicator | Indicates whether the confirmation is an amendment of a previous confirmation. | IsoYesNoIndicator - Optional 0..1 |
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 or its agent. | IsoISODateTime - Optional 0..1 |
ReceivedDateTime | Date and time the order was received by the executing party, for example, the transfer agent. | 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 the investor with respect to the investment fund order. | ICancellationRight1Choice - Optional 0..1 |
FinancialInstrumentDetails | Investment fund class to which the investment fund order execution is related. | FinancialInstrument57 - Required 1..1 |
IndividualExecutionDetails | Execution of a subscription order. | SubscriptionExecution12 - 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 |
BulkCashSettlementDetails | Payment process for the transfer of cash from the debtor to the creditor. | PaymentTransaction70 - 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 %% CopyInformation4 recursion level 0 with max 1 class CopyInformation4{ CopyIndicator IsoYesNoIndicator OriginalReceiver IsoAnyBICIdentifier }
CopyInformation4 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. | IsoAnyBICIdentifier - 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 SubscriptionBulkOrderConfirmationV04 implementation follows a specific implementaiton pattern. First of all, SubscriptionBulkOrderConfirmationV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SubscriptionBulkOrderConfirmationV04Document implements IOuterDocument. Because SubscriptionBulkOrderConfirmationV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SubscriptionBulkOrderConfirmationV04.
classDiagram class IOuterRecord SubscriptionBulkOrderConfirmationV04 --|> IOuterRecord : Implements SubscriptionBulkOrderConfirmationV04Document --|> IOuterDocument~SubscriptionBulkOrderConfirmationV04~ : Implements class IOuterDocument~SubscriptionBulkOrderConfirmationV04~ { SubscriptionBulkOrderConfirmationV04 Message }
Document wrapper for serialization
The only real purpose SubscriptionBulkOrderConfirmationV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.009.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SubscriptionBulkOrderConfirmationV04.ToDocument() method. The returned SubscriptionBulkOrderConfirmationV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram SubscriptionBulkOrderConfirmationV04Document *-- SubscriptionBulkOrderConfirmationV04 : 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.009.001.04">
<SbcptBlkOrdrConf>
<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>
<CpyDtls>
<!-- CopyDetails inner content -->
</CpyDtls>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</SbcptBlkOrdrConf>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Aab6hTbLEead9bDRE_1DAQ"
previousVersion="_zVj4wNE7Ed-BzquC8wXy7w_616882747"
name="SubscriptionBulkOrderConfirmationV04"
definition="Scope
The SubscriptionBulkOrderConfirmation message is sent by an executing party, for example, a transfer agent, to the instructing party, for example, an investment manager or its authorised representative, to confirm the details of the execution of a SubscriptionBulkOrder instruction.
Usage
The SubscriptionBulkOrderConfirmation message is used to confirm the execution of all individual orders.
There is usually one bulk confirmation message for one bulk order message.
Each individual order confirmation specified is identified in DealReference. The reference of the original individual order is specified in OrderReference. The message identification of the SubscriptionBulkOrder message in which the individual order was conveyed may also be quoted in RelatedReference.
A SubscriptionBulkOrder must in all cases be responded to by a SubscriptionBulkOrderConfirmation and in no circumstances by a SubscriptionOrderConfirmation.
If the executing party needs to confirm a SubscriptionOrder instruction, then the SubscriptionOrderConfirmation must be used.
When the message is used to convey a confirmation amendment/s, the AmendmentIndicator must be present with the value ‘true’ or ‘1’. When this is the case, the message must only contain a confirmation amendment/s and not contain both a confirmation amendment/s and a ‘new’ confirmation/s."
registrationStatus="Registered"
messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
xmlTag="SbcptBlkOrdrConf"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_Aab6hzbLEead9bDRE_1DAQ"
previousVersion="_zVtpwdE7Ed-BzquC8wXy7w_920721761"
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="_Aab6iTbLEead9bDRE_1DAQ"
previousVersion="_zVtpxNE7Ed-BzquC8wXy7w_-1160723324"
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" />
<messageBuildingBlock
xmi:id="_Aab6jzbLEead9bDRE_1DAQ"
previousVersion="_zVj4wdE7Ed-BzquC8wXy7w_-725950414"
name="MessageIdentification"
definition="Reference that uniquely identifies the message from a business application standpoint."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgId"
complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
<messageBuildingBlock
xmi:id="_Aab6kTbLEead9bDRE_1DAQ"
previousVersion="_zVj4wtE7Ed-BzquC8wXy7w_1301211464"
name="PoolReference"
definition="Collective reference identifying a set of messages."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PoolRef"
complexType="_N4g3EXETEea2e4bzJ8TyEw" />
<messageBuildingBlock
xmi:id="_Aab6kzbLEead9bDRE_1DAQ"
previousVersion="_zVj4w9E7Ed-BzquC8wXy7w_1303059499"
name="PreviousReference"
definition="Reference to a linked message that was previously sent."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="PrvsRef"
complexType="_udnPoTbsEead9bDRE_1DAQ" />
<messageBuildingBlock
xmi:id="_Aab6lTbLEead9bDRE_1DAQ"
previousVersion="_zVj4xNE7Ed-BzquC8wXy7w_1313217658"
name="RelatedReference"
definition="Reference to a linked message that was previously received."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="RltdRef"
complexType="_udnPoTbsEead9bDRE_1DAQ" />
<messageBuildingBlock
xmi:id="_Aab6lzbLEead9bDRE_1DAQ"
previousVersion="_zVj4xdE7Ed-BzquC8wXy7w_-1660193120"
name="BulkExecutionDetails"
definition="General information related to the execution of the orders."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="BlkExctnDtls"
complexType="_Vji3MTk7EeapUO0vUIo9Xw" />
<messageBuildingBlock
xmi:id="_Aab6mzbLEead9bDRE_1DAQ"
previousVersion="_zVj4x9E7Ed-BzquC8wXy7w_1758354425"
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="_7VUJ8degEeSA_uUacqhl1Q" />
<messageBuildingBlock
xmi:id="_Aab6nTbLEead9bDRE_1DAQ"
previousVersion="_zVtpwNE7Ed-BzquC8wXy7w_1761122916"
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="009"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.