Iso20022

BankToCustomerAccountReportV01

camt.052.001.01

Scope The Bank-to-Customer Account Report message is sent by the account servicer to an account owner or to a party authorised by the account owner to receive the message. It can be used to inform the account owner, or authorised party, of the entries reported to the account, and/or to provide the owner with balance information on the account at a given point in time. Usage The Bank-to-Customer Account Report message can contain reports for more than 1 account. It provides information for cash management and/or reconciliation. It can be used to:

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
%% BankToCustomerAccountReportV01 recursion level 0 with max 0
BankToCustomerAccountReportV01 *-- "1..1" GroupHeader23 : GroupHeader
BankToCustomerAccountReportV01 *-- "1..1" AccountReport9 : Report

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

GroupHeader building block

Common information for the message. Set of elements providing further details on the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% GroupHeader23 recursion level 0 with max 1
class GroupHeader23{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    AdditionalInformation IsoMax500Text
}
GroupHeader23 *-- "0..1" PartyIdentification8 : MessageRecipient
GroupHeader23 *-- "0..1" Pagination : MessagePagination
%% PartyIdentification8 recursion level 1 with max 1
class PartyIdentification8{
    Name IsoMax70Text
    CountryOfResidence CountryCode
}
PartyIdentification8 *-- "0..1" PostalAddress1 : PostalAddress
PartyIdentification8 *-- "0..1" IParty2Choice : Identification
%% Pagination recursion level 1 with max 1
class Pagination{
    PageNumber IsoMax5NumericText
    LastPageIndicator IsoYesNoIndicator
}

GroupHeader23 members

Member name Description Data Type / Multiplicity
MessageIdentification Point to point reference assigned by the account servicing institution and sent to the account owner to unambiguously identify the message.
CreationDateTime Date and time at which the message was created by the account servicer. IsoISODateTime - Required 1..1
MessageRecipient Party that is entitled by the account owner to receive information about movements in the account.
MessagePagination Pagination of the message.
AdditionalInformation Further details on the message. IsoMax500Text - Optional 0..1

Report building block

Reports on a cash account. Set of elements providing further details on the account report. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AccountReport9 recursion level 0 with max 1
class AccountReport9{
    Identification IsoMax35Text
    ElectronicSequenceNumber IsoNumber
    LegalSequenceNumber IsoNumber
    CreationDateTime IsoISODateTime
    CopyDuplicateIndicator CopyDuplicate1Code
    AdditionalReportInformation IsoMax500Text
}
AccountReport9 *-- "0..1" DateTimePeriodDetails : FromToDate
AccountReport9 *-- "1..1" CashAccount13 : Account
AccountReport9 *-- "0..1" CashAccount7 : RelatedAccount
AccountReport9 *-- "0..0" AccountInterest1 : Interest
AccountReport9 *-- "0..0" CashBalance1 : Balance
AccountReport9 *-- "0..1" TotalTransactions1 : TransactionsSummary
AccountReport9 *-- "0..0" ReportEntry1 : Entry
%% DateTimePeriodDetails recursion level 1 with max 1
class DateTimePeriodDetails{
    FromDateTime IsoISODateTime
    ToDateTime IsoISODateTime
}
%% CashAccount13 recursion level 1 with max 1
class CashAccount13{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount13 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount13 *-- "0..1" CashAccountType2 : Type
CashAccount13 *-- "0..1" PartyIdentification8 : Owner
CashAccount13 *-- "0..1" BranchAndFinancialInstitutionIdentification3 : Servicer
%% CashAccount7 recursion level 1 with max 1
class CashAccount7{
    Currency CurrencyCode
    Name IsoMax70Text
}
CashAccount7 *-- "1..1" IAccountIdentification3Choice : Identification
CashAccount7 *-- "0..1" CashAccountType2 : Type
%% AccountInterest1 recursion level 1 with max 1
class AccountInterest1{
    Reason IsoMax35Text
}
AccountInterest1 *-- "0..1" IInterestType1Choice : Type
AccountInterest1 *-- "0..0" Rate1 : Rate
AccountInterest1 *-- "0..1" DateTimePeriodDetails : FromToDate
%% CashBalance1 recursion level 1 with max 1
class CashBalance1{
    Amount IsoCurrencyAndAmount
    CreditDebitIndicator CreditDebitCode
}
CashBalance1 *-- "1..1" IBalanceType1Choice : Type
CashBalance1 *-- "0..1" CreditLine1 : CreditLine
CashBalance1 *-- "1..1" IDateAndDateTimeChoice : Date
CashBalance1 *-- "0..0" CashBalanceAvailability1 : Availability
%% TotalTransactions1 recursion level 1 with max 1
TotalTransactions1 *-- "0..1" NumberAndSumOfTransactions2 : TotalEntries
TotalTransactions1 *-- "0..1" NumberAndSumOfTransactions1 : TotalCreditEntries
TotalTransactions1 *-- "0..1" NumberAndSumOfTransactions1 : TotalDebitEntries
TotalTransactions1 *-- "0..0" NumberAndSumOfTransactionsPerBankTransactionCode1 : TotalEntriesPerBankTransactionCode
%% ReportEntry1 recursion level 1 with max 1
class ReportEntry1{
    Amount IsoCurrencyAndAmount
    CreditDebitIndicator CreditDebitCode
    ReversalIndicator IsoTrueFalseIndicator
    Status EntryStatus2Code
    AccountServicerReference IsoMax35Text
    CommissionWaiverIndicator IsoYesNoIndicator
    AdditionalEntryInformation IsoMax500Text
}
ReportEntry1 *-- "0..1" IDateAndDateTimeChoice : BookingDate
ReportEntry1 *-- "0..1" IDateAndDateTimeChoice : ValueDate
ReportEntry1 *-- "0..0" CashBalanceAvailability1 : Availability
ReportEntry1 *-- "1..1" BankTransactionCodeStructure1 : BankTransactionCode
ReportEntry1 *-- "0..1" MessageIdentification2 : AdditionalInformationIndicator
ReportEntry1 *-- "0..0" BatchInformation1 : Batch
ReportEntry1 *-- "0..1" AmountAndCurrencyExchange2 : AmountDetails
ReportEntry1 *-- "0..0" ChargesInformation3 : Charges
ReportEntry1 *-- "0..0" TransactionInterest1 : Interest
ReportEntry1 *-- "0..0" EntryTransaction1 : TransactionDetails

AccountReport9 members

Member name Description Data Type / Multiplicity
Identification Unique and unambiguous identification of the account report, assigned by the account servicer. IsoMax35Text - Required 1..1
ElectronicSequenceNumber Sequential number of the report, assigned by the account servicer. It is increased incrementally for each report sent electronically. IsoNumber - Optional 0..1
LegalSequenceNumber Legal sequential number of the report, assigned by the account servicer. It is increased incrementally for each report sent.
CreationDateTime Date and time at which the report was created. IsoISODateTime - Required 1..1
FromToDate Range of time between the start date and the end date for which the account report is issued. DateTimePeriodDetails - Optional 0..1
CopyDuplicateIndicator Specifies if this document is a copy, a duplicate, or a duplicate of a copy. CopyDuplicate1Code - Optional 0..1
Account Business relationship between two entities; one entity is the account owner, the other entity is the account servicer. CashAccount13 - Required 1..1
RelatedAccount Identifies the parent account of the reported account. CashAccount7 - Optional 0..1
Interest Provides general interest information that applies to the account at a particular moment in time. AccountInterest1 - Unknown 0..0
Balance Set of elements defining the balance(s). CashBalance1 - Unknown 0..0
TransactionsSummary Set of element providing summary information on entries. TotalTransactions1 - Optional 0..1
Entry Specifies the elements of an entry in the report.
AdditionalReportInformation Further details on the account report. IsoMax500Text - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    BankToCustomerAccountReportV01 --|> IOuterRecord : Implements
    BankToCustomerAccountReportV01Document --|> IOuterDocument~BankToCustomerAccountReportV01~ : Implements
    class IOuterDocument~BankToCustomerAccountReportV01~ {
        BankToCustomerAccountReportV01 Message
     }

Document wrapper for serialization

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

classDiagram
    BankToCustomerAccountReportV01Document *-- BankToCustomerAccountReportV01 : 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.052.001.01">
    <BkToCstmrAcctRptV01>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <Rpt>
            <!-- Report inner content -->
        </Rpt>
    </BkToCstmrAcctRptV01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_HpTM0tE-Ed-BzquC8wXy7w_1604757380"
  nextVersions="_II5S49E-Ed-BzquC8wXy7w_620541391"
  name="BankToCustomerAccountReportV01"
  definition="Scope&#xD;&#xA;The Bank-to-Customer Account Report message is sent by the account servicer to an account owner or to a party authorised by the account owner to receive the message. It can be used to inform the account owner, or authorised party, of the entries reported to the account, and/or to provide the owner with balance information on the account at a given point in time.&#xD;&#xA;Usage&#xD;&#xA;The Bank-to-Customer Account Report message can contain reports for more than 1 account. It provides information for cash management and/or reconciliation. It can be used to:&#xD;&#xA;- report pending and booked items;&#xD;&#xA;- provide balance information&#xD;&#xA;It can include underlying details of transactions that have been included in the entry.&#xD;&#xA;It is possible that the receiver of the message is not the account owner, but a party entitled by the account owner to receive the account information (also known as recipient).&#xD;&#xA;For a statement that is required due to local legal stipulations, the Bank-to-Customer Account Statement message should be used."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="BkToCstmrAcctRptV01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_HpTM09E-Ed-BzquC8wXy7w_-825021148"
    name="GroupHeader"
    definition="Common information for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_PynpV9p-Ed-ak6NoX_4Aeg_-1593387431" />
  <messageBuildingBlock
    xmi:id="_HpTM1NE-Ed-BzquC8wXy7w_-1335280264"
    name="Report"
    definition="Reports on a cash account."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="Rpt"
    complexType="_RToJFNp-Ed-ak6NoX_4Aeg_1717615709" />
  <messageDefinitionIdentifier
    businessArea="camt"
    messageFunctionality="052"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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