Iso20022

ContractRegistrationStatementV01

auth.022.001.01

The ContractRegistrationStatement message is sent by the registration agent to the reporting party, in response to a request or at a pre-agreed date, to send a statement of the operations related to the registered contract subject to currency control.

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
%% ContractRegistrationStatementV01 recursion level 0 with max 0
ContractRegistrationStatementV01 *-- "1..1" CurrencyControlHeader2 : GroupHeader
ContractRegistrationStatementV01 *-- "1..1" ContractRegistrationStatement1 : Statement
ContractRegistrationStatementV01 *-- "0..1" SupplementaryData1 : SupplementaryData

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

GroupHeader building block

Characteristics shared by all individual items included in the message. Characteristics shared by all individual items included in the currency control message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CurrencyControlHeader2 recursion level 0 with max 1
class CurrencyControlHeader2{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    NumberOfItems IsoMax15NumericText
}
CurrencyControlHeader2 *-- "1..1" PartyIdentification77 : ReceivingParty
CurrencyControlHeader2 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : RegistrationAgent
%% PartyIdentification77 recursion level 1 with max 1
class PartyIdentification77{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification77 *-- "0..1" PostalAddress19 : PostalAddress
PartyIdentification77 *-- "0..1" IParty11Choice : Identification
PartyIdentification77 *-- "0..1" ContactDetails2 : ContactDetails
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification

CurrencyControlHeader2 members

Member name Description Data Type / Multiplicity
MessageIdentification Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.
CreationDateTime Date and time at which the message was created. IsoISODateTime - Required 1..1
NumberOfItems Number of individual items contained in the message. IsoMax15NumericText - Required 1..1
ReceivingParty Party that receives the message. PartyIdentification77 - Required 1..1
RegistrationAgent Agent which sends the message. BranchAndFinancialInstitutionIdentification5 - Required 1..1

Statement building block

Provides the contract registration statement, which includes all journals on the activities related to the contract. Statement of the journal entries for all activities related to the registered currency control contract. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContractRegistrationStatement1 recursion level 0 with max 1
class ContractRegistrationStatement1{
    StatementIdentification IsoMax35Text
    TotalContractTurnoverSum IsoActiveCurrencyAndAmount
}
ContractRegistrationStatement1 *-- "1..1" TradeParty2 : ReportingParty
ContractRegistrationStatement1 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : RegistrationAgent
ContractRegistrationStatement1 *-- "1..1" ReportingPeriod1 : ReportingPeriod
ContractRegistrationStatement1 *-- "1..1" RegisteredContract5 : RegisteredContract
ContractRegistrationStatement1 *-- "0..0" TransactionCertificate1 : TransactionJournal
ContractRegistrationStatement1 *-- "0..0" SupportingDocument1 : SupportingDocumentJournal
ContractRegistrationStatement1 *-- "0..0" SupportingDocument1 : AdditionalSupportingDocumentJournal
ContractRegistrationStatement1 *-- "0..0" GenericValidationRuleIdentification1 : RegulatoryRuleValidation
ContractRegistrationStatement1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% TradeParty2 recursion level 1 with max 1
TradeParty2 *-- "1..1" PartyIdentification77 : PartyIdentification
TradeParty2 *-- "0..1" LegalOrganisation2 : LegalOrganisation
TradeParty2 *-- "0..0" TaxParty3 : TaxParty
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% ReportingPeriod1 recursion level 1 with max 1
class ReportingPeriod1{
    Type QueryType3Code
}
ReportingPeriod1 *-- "1..1" DatePeriodDetails1 : FromToDate
ReportingPeriod1 *-- "1..1" TimePeriodDetails1 : FromToTime
%% RegisteredContract5 recursion level 1 with max 1
class RegisteredContract5{
    OriginalContractRegistrationRequest IsoMax35Text
    LoanPrincipalAmount IsoActiveCurrencyAndAmount
    EstimatedDateIndicator IsoTrueFalseIndicator
    InterCompanyLoan IsoTrueFalseIndicator
    AdditionalInformation IsoMax1025Text
}
RegisteredContract5 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : IssuerFinancialInstitution
RegisteredContract5 *-- "1..1" IUnderlyingContract1Choice : Contract
RegisteredContract5 *-- "0..0" ContractBalance1 : ContractBalance
RegisteredContract5 *-- "0..1" IPaymentScheduleType1Choice : PaymentScheduleType
RegisteredContract5 *-- "1..1" DocumentIdentification29 : RegisteredContractIdentification
RegisteredContract5 *-- "0..1" DocumentIdentification22 : PreviousRegisteredContractIdentification
RegisteredContract5 *-- "0..0" RegisteredContractJournal1 : RegisteredContractJournal
RegisteredContract5 *-- "0..0" RegisteredContractAmendment1 : Amendment
RegisteredContract5 *-- "1..1" RegisteredContractCommunication1 : Submission
RegisteredContract5 *-- "1..1" RegisteredContractCommunication1 : Delivery
%% TransactionCertificate1 recursion level 1 with max 1
class TransactionCertificate1{
    TransactionIdentification IsoMax35Text
    BankAccountDomiciliationCountry CountryCode
}
TransactionCertificate1 *-- "1..1" DocumentIdentification28 : Certificate
TransactionCertificate1 *-- "0..1" CashAccount24 : Account
TransactionCertificate1 *-- "0..1" DocumentAmendment1 : Amendment
TransactionCertificate1 *-- "1..0" TransactionCertificateRecord1 : CertificateRecord
TransactionCertificate1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% SupportingDocument1 recursion level 1 with max 1
class SupportingDocument1{
    SupportingDocumentIdentification IsoMax35Text
    OriginalRequestIdentification IsoMax35Text
}
SupportingDocument1 *-- "1..1" DocumentIdentification28 : Certificate
SupportingDocument1 *-- "1..1" PartyIdentification77 : AccountOwner
SupportingDocument1 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : AccountServicer
SupportingDocument1 *-- "0..1" DocumentAmendment1 : Amendment
SupportingDocument1 *-- "1..1" IContractRegistrationReference1Choice : ContractReference
SupportingDocument1 *-- "1..0" SupportingDocumentEntry1 : Entry
SupportingDocument1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% SupportingDocument1 recursion level 1 with max 1
class SupportingDocument1{
    SupportingDocumentIdentification IsoMax35Text
    OriginalRequestIdentification IsoMax35Text
}
SupportingDocument1 *-- "1..1" DocumentIdentification28 : Certificate
SupportingDocument1 *-- "1..1" PartyIdentification77 : AccountOwner
SupportingDocument1 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : AccountServicer
SupportingDocument1 *-- "0..1" DocumentAmendment1 : Amendment
SupportingDocument1 *-- "1..1" IContractRegistrationReference1Choice : ContractReference
SupportingDocument1 *-- "1..0" SupportingDocumentEntry1 : Entry
SupportingDocument1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% GenericValidationRuleIdentification1 recursion level 1 with max 1
class GenericValidationRuleIdentification1{
    Identification IsoMax35Text
    Description IsoMax350Text
    Issuer IsoMax35Text
}
GenericValidationRuleIdentification1 *-- "0..1" IValidationRuleSchemeName1Choice : SchemeName
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

ContractRegistrationStatement1 members

Member name Description Data Type / Multiplicity
StatementIdentification Unique identification, as assigned by the account servicer, to unambiguously identify the contract registration statement. IsoMax35Text - Optional 0..1
ReportingParty Party registering the currency control contract. TradeParty2 - Required 1..1
RegistrationAgent Agent which registers the currency control contract. BranchAndFinancialInstitutionIdentification5 - Required 1..1
ReportingPeriod Specifies the period for which the statement is provided. ReportingPeriod1 - Required 1..1
RegisteredContract Registered currency control contract. RegisteredContract5 - Required 1..1
TransactionJournal Journal of the transactions recorded under the registered currency control contract. TransactionCertificate1 - Unknown 0..0
SupportingDocumentJournal Journal of the supporting documents recorded under the registered currency control contract. SupportingDocument1 - Unknown 0..0
AdditionalSupportingDocumentJournal Journal of additional supporting documents recorded under the registered currency control contract. SupportingDocument1 - Unknown 0..0
RegulatoryRuleValidation Details on the currency control rule against which has been violated. GenericValidationRuleIdentification1 - Unknown 0..0
TotalContractTurnoverSum Total turn over amount recorded under the currency control contract for the amount of all. IsoActiveCurrencyAndAmount - Required 1..1
SupplementaryData Additional information that cannot be captured in the structured elements and/or any other specific block. SupplementaryData1 - Unknown 0..0

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 ContractRegistrationStatementV01 implementation follows a specific implementaiton pattern. First of all, ContractRegistrationStatementV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ContractRegistrationStatementV01Document implements IOuterDocument. Because ContractRegistrationStatementV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ContractRegistrationStatementV01.

classDiagram
    class IOuterRecord
    ContractRegistrationStatementV01 --|> IOuterRecord : Implements
    ContractRegistrationStatementV01Document --|> IOuterDocument~ContractRegistrationStatementV01~ : Implements
    class IOuterDocument~ContractRegistrationStatementV01~ {
        ContractRegistrationStatementV01 Message
     }

Document wrapper for serialization

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

classDiagram
    ContractRegistrationStatementV01Document *-- ContractRegistrationStatementV01 : 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:auth.022.001.01">
    <CtrctRegnStmt>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <Stmt>
            <!-- Statement inner content -->
        </Stmt>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CtrctRegnStmt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_CHHT4NnQEeS--7IJLPC9lw"
  nextVersions="_bf9R222PEei3KuUgpx7Xcw"
  name="ContractRegistrationStatementV01"
  definition="The ContractRegistrationStatement message is sent by the registration agent to the reporting party, in response to a request or at a pre-agreed date, to send a statement of the operations related to the registered contract subject to currency control."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CtrctRegnStmt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_RtrZEdnQEeS--7IJLPC9lw"
    nextVersions="_bf9R3W2PEei3KuUgpx7Xcw"
    name="GroupHeader"
    definition="Characteristics shared by all individual items included in the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_7ILmFjm6EeWDb47rJ6ki4Q" />
  <messageBuildingBlock
    xmi:id="_J5DJsNnREeS--7IJLPC9lw"
    nextVersions="_bf9R322PEei3KuUgpx7Xcw"
    name="Statement"
    definition="Provides the contract registration statement, which includes all journals on the activities related to the contract."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="Stmt"
    complexType="_M2smkNnREeS--7IJLPC9lw" />
  <messageBuildingBlock
    xmi:id="_sAFV4dnQEeS--7IJLPC9lw"
    nextVersions="_bf9R4W2PEei3KuUgpx7Xcw"
    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="auth"
    messageFunctionality="022"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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