camt.088.001.02
The Net Report message is sent to a participant by a central system to provide details of the of the bi-lateral payment obligations, calculated by the central system per currency.
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 %% NetReportV02 recursion level 0 with max 0 NetReportV02 *-- "1..1" NetReportData2 : NetReportData NetReportV02 *-- "1..1" IPartyIdentification242Choice : NetServiceParticipantIdentification NetReportV02 *-- "0..1" IPartyIdentification242Choice : NetServiceCounterpartyIdentification NetReportV02 *-- "1..1" NetObligation2 : NetObligation NetReportV02 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
NetReportData building block
Specifies the meta data associated with the net report. Specifies the meta data associated with a net report. For comparison, see the ISO20022 official specification
classDiagram direction tb %% NetReportData2 recursion level 0 with max 1 class NetReportData2{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime NettingCutOffTime IsoISOTime ReportDate IsoISODate ValueDate IsoISODate ReportType IsoMax35Text NetServiceType IsoMax35Text } NetReportData2 *-- "0..1" IPartyIdentification242Choice : NetReportServicer NetReportData2 *-- "0..1" Pagination1 : MessagePagination %% IPartyIdentification242Choice recursion level 1 with max 1 %% Pagination1 recursion level 1 with max 1 class Pagination1{ PageNumber IsoMax5NumericText LastPageIndicator IsoYesNoIndicator }
NetReportData2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageIdentification | Unique and unambiguous identifier for a message, as assigned by the Sender. This unique identifier can be used for cross-referencing purposes in subsequent messages. | IsoMax35Text - Required 1..1 |
CreationDateTime | Date and time at which the net report was generated. | IsoISODateTime - Required 1..1 |
NettingCutOffTime | Provides the cut off time that has been passed, resulting in the generation of the net report. | IsoISOTime - Required 1..1 |
ReportDate | Specifies the value date on which the net report was generated. | IsoISODate - Required 1..1 |
ValueDate | Specifies the value date of the trades used in the generation of the net report. | IsoISODate - Required 1..1 |
ReportType | Specifies the type of net report, indicating how the obligations have been calculated. | IsoMax35Text - Optional 0..1 |
NetReportServicer | Describes the central system responsible for generating the net report. | IPartyIdentification242Choice - Optional 0..1 |
NetServiceType | Describes the type of netting service supporting the net report. | IsoMax35Text - Optional 0..1 |
MessagePagination | Page number of the message (within the net report) and continuation indicator to indicate that the report is to continue or that the message is the last page of the report. | Pagination1 - Optional 0..1 |
NetServiceParticipantIdentification building block
Describes the participant receiving the net report. Choice between a BIC, name and address or a LEI to identify a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification242Choice recursion level 0 with max 1
PartyIdentification242Choice members
Member name | Description | Data Type / Multiplicity |
---|
NetServiceCounterpartyIdentification building block
Describes the counterparty participant involved in (all of) the obligations of the report. Choice between a BIC, name and address or a LEI to identify a party. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyIdentification242Choice recursion level 0 with max 1
PartyIdentification242Choice members
Member name | Description | Data Type / Multiplicity |
---|
NetObligation building block
Provides the amount, direct parties or netting groups involved in the obligation. Describes the amount, direction and parties involved in a payment obligation between two participants (and their netting group or trading party) of a netting service. For comparison, see the ISO20022 official specification
classDiagram direction tb %% NetObligation2 recursion level 0 with max 1 class NetObligation2{ ObligationIdentification IsoMax35Text Amount IsoActiveCurrencyAndAmount ObligationDirection PaymentReceipt1Code TransactionsNumber IsoMax10NumericText } NetObligation2 *-- "1..1" INettingIdentification2Choice : ParticipantNettingIdentification NetObligation2 *-- "1..1" INettingIdentification2Choice : CounterpartyNettingIdentification NetObligation2 *-- "0..1" IPartyIdentification242Choice : NetServiceCounterpartyIdentification NetObligation2 *-- "0..1" SettlementParties120 : CounterpartySettlementInstructions %% INettingIdentification2Choice recursion level 1 with max 1 %% INettingIdentification2Choice recursion level 1 with max 1 %% IPartyIdentification242Choice recursion level 1 with max 1 %% SettlementParties120 recursion level 1 with max 1 SettlementParties120 *-- "0..1" IPartyIdentification242Choice : DeliveryAgent SettlementParties120 *-- "0..1" IPartyIdentification242Choice : Intermediary SettlementParties120 *-- "1..1" IPartyIdentification242Choice : ReceivingAgent SettlementParties120 *-- "0..1" IPartyIdentification242Choice : BeneficiaryInstitution
NetObligation2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
ObligationIdentification | Unique identification for the obligation. | IsoMax35Text - Required 1..1 |
Amount | Amount of the obligation. | IsoActiveCurrencyAndAmount - Required 1..1 |
ParticipantNettingIdentification | Describes the party or netting group (of the participant receiving the report) involved in the calculation of the obligation. | INettingIdentification2Choice - Required 1..1 |
ObligationDirection | Specifies the direction of the obligation. | PaymentReceipt1Code - Required 1..1 |
CounterpartyNettingIdentification | Describes the party or netting group (of the counterparty in the obligation) involved in the calculation of the obligation. | INettingIdentification2Choice - Required 1..1 |
NetServiceCounterpartyIdentification | Describes the counterparty participant involved in the obligation. | IPartyIdentification242Choice - Optional 0..1 |
CounterpartySettlementInstructions | Specifies the standard settlement instructions used to issue a payment to the counterparty in order to settle the obligation. | SettlementParties120 - Optional 0..1 |
TransactionsNumber | Number of transactions used to calculate the obligation. This is used in reconciliation between the net report obligation and the previously provided transaction status updates. | IsoMax10NumericText - Optional 0..1 |
SupplementaryData 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 %% SupplementaryData1 recursion level 0 with max 1 class SupplementaryData1{ PlaceAndName IsoMax350Text } SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope %% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the NetReportV02 implementation follows a specific implementaiton pattern. First of all, NetReportV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, NetReportV02Document implements IOuterDocument. Because NetReportV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type NetReportV02.
classDiagram class IOuterRecord NetReportV02 --|> IOuterRecord : Implements NetReportV02Document --|> IOuterDocument~NetReportV02~ : Implements class IOuterDocument~NetReportV02~ { NetReportV02 Message }
Document wrapper for serialization
The only real purpose NetReportV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.088.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using NetReportV02.ToDocument() method. The returned NetReportV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram NetReportV02Document *-- NetReportV02 : 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:camt.088.001.02">
<NetRpt>
<NetRptData>
<!-- NetReportData inner content -->
</NetRptData>
<NetSvcPtcptId>
<!-- NetServiceParticipantIdentification inner content -->
</NetSvcPtcptId>
<NetSvcCtrPtyId>
<!-- NetServiceCounterpartyIdentification inner content -->
</NetSvcCtrPtyId>
<NetOblgtn>
<!-- NetObligation inner content -->
</NetOblgtn>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</NetRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_kBNA9QM-Ee2nqoJcXIhTdw"
previousVersion="_2YFYQJUlEeaYkf5FCqYMeA"
name="NetReportV02"
definition="The Net Report message is sent to a participant by a central system to provide details of the of the bi-lateral payment obligations, calculated by the central system per currency."
registrationStatus="Registered"
messageSet="_wiatARJsEeSstbhSoCHcWw"
xmlTag="NetRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_kBNA9wM-Ee2nqoJcXIhTdw"
previousVersion="_FPkMEJU1EeaYkf5FCqYMeA"
name="CounterpartyIdentificationRule"
definition="NetServiceCounterpartyIdentification must only be used at this level if all of the underlying obligations are with a single counterparty."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_kBNA-QM-Ee2nqoJcXIhTdw"
previousVersion="_bs5gUJUrEeaYkf5FCqYMeA"
name="NetReportData"
definition="Specifies the meta data associated with the net report."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="NetRptData"
complexType="_CWAzsQN1Ee2-vqzwMUAewg" />
<messageBuildingBlock
xmi:id="_kBNA-wM-Ee2nqoJcXIhTdw"
previousVersion="_TX-x4JUtEeaYkf5FCqYMeA"
name="NetServiceParticipantIdentification"
definition="Describes the participant receiving the net report."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="NetSvcPtcptId"
complexType="_BSSs4QN1Ee2-vqzwMUAewg" />
<messageBuildingBlock
xmi:id="_kBNA_QM-Ee2nqoJcXIhTdw"
previousVersion="_98aukJU0EeaYkf5FCqYMeA"
name="NetServiceCounterpartyIdentification"
definition="Describes the counterparty participant involved in (all of) the obligations of the report."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="NetSvcCtrPtyId"
complexType="_BSSs4QN1Ee2-vqzwMUAewg" />
<messageBuildingBlock
xmi:id="_kBNA_wM-Ee2nqoJcXIhTdw"
previousVersion="_0OAIgJU0EeaYkf5FCqYMeA"
name="NetObligation"
definition="Provides the amount, direct parties or netting groups involved in the obligation."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="NetOblgtn"
complexType="_Chfq8QN1Ee2-vqzwMUAewg" />
<messageBuildingBlock
xmi:id="_kBNBAQM-Ee2nqoJcXIhTdw"
previousVersion="_RA5FEJU1EeaYkf5FCqYMeA"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="camt"
messageFunctionality="088"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.