BankToCustomerAccountReportV04

camt.052.001.04

Scope The BankToCustomerAccountReport 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 BankToCustomerAccountReport message can contain reports for more than one account. It provides information for cash management and/or reconciliation. It can be used to:

report pending and booked items;
provide balance information. It can include underlying details of transactions that have been included in the entry. 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). For a statement, the Bank-to-Customer Account Statement message should be used.

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
%% BankToCustomerAccountReportV04 recursion level 0 with max 0
BankToCustomerAccountReportV04 *-- "1..1" GroupHeader58 : GroupHeader
BankToCustomerAccountReportV04 *-- "1..1" AccountReport16 : Report
BankToCustomerAccountReportV04 *-- "0..1" SupplementaryData1 : SupplementaryData

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

GroupHeader building block

Common information for the message. Provides further details on the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% GroupHeader58 recursion level 0 with max 1
class GroupHeader58{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    AdditionalInformation IsoMax500Text
}
GroupHeader58 *-- "0..1" PartyIdentification43 : MessageRecipient
GroupHeader58 *-- "0..1" Pagination : MessagePagination
GroupHeader58 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% Pagination recursion level 1 with max 1
class Pagination{
    PageNumber IsoMax5NumericText
    LastPageIndicator IsoYesNoIndicator
}
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
    MessageIdentification IsoMax35Text
    MessageNameIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}

GroupHeader58 members

Member name	Description	Data Type / Multiplicity
MessageIdentification	Point to point reference, as assigned by the account servicing institution, and sent to the account owner or the party authorised to receive the message, to unambiguously identify the message.	Usage: The account servicing institution has to make sure that MessageIdentification is unique per account owner for a pre-agreed period.
CreationDateTime	Date and time at which the message was created.	IsoISODateTime - Required 1..1
MessageRecipient	Party authorised by the account owner to receive information about movements on the account.	Usage: MessageRecipient should only be identified when different from the account owner.
MessagePagination	Provides details on the page number of the message.
OriginalBusinessQuery	Unique identification, as assigned by the original requestor, to unambiguously identify the business query message.	OriginalBusinessQuery1 - Optional 0..1
AdditionalInformation	Further details of the message.	IsoMax500Text - Optional 0..1

Report building block

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

classDiagram
   direction tb
%% AccountReport16 recursion level 0 with max 1
class AccountReport16{
    Identification IsoMax35Text
    ElectronicSequenceNumber IsoNumber
    LegalSequenceNumber IsoNumber
    CreationDateTime IsoISODateTime
    CopyDuplicateIndicator CopyDuplicate1Code
    AdditionalReportInformation IsoMax500Text
}
AccountReport16 *-- "0..1" Pagination : ReportPagination
AccountReport16 *-- "0..1" DateTimePeriodDetails : FromToDate
AccountReport16 *-- "0..1" IReportingSource1Choice : ReportingSource
AccountReport16 *-- "1..1" CashAccount25 : Account
AccountReport16 *-- "0..1" CashAccount24 : RelatedAccount
AccountReport16 *-- "0..0" AccountInterest3 : Interest
AccountReport16 *-- "0..0" CashBalance3 : Balance
AccountReport16 *-- "0..1" TotalTransactions4 : TransactionsSummary
AccountReport16 *-- "0..0" ReportEntry4 : Entry
%% Pagination recursion level 1 with max 1
class Pagination{
    PageNumber IsoMax5NumericText
    LastPageIndicator IsoYesNoIndicator
}
%% DateTimePeriodDetails recursion level 1 with max 1
class DateTimePeriodDetails{
    FromDateTime IsoISODateTime
    ToDateTime IsoISODateTime
}
%% IReportingSource1Choice recursion level 1 with max 1
%% CashAccount25 recursion level 1 with max 1
class CashAccount25{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount25 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount25 *-- "0..1" ICashAccountType2Choice : Type
CashAccount25 *-- "0..1" PartyIdentification43 : Owner
CashAccount25 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : Servicer
%% CashAccount24 recursion level 1 with max 1
class CashAccount24{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount24 *-- "0..1" ICashAccountType2Choice : Type
%% AccountInterest3 recursion level 1 with max 1
class AccountInterest3{
    Reason IsoMax35Text
}
AccountInterest3 *-- "0..1" IInterestType1Choice : Type
AccountInterest3 *-- "0..0" Rate3 : Rate
AccountInterest3 *-- "0..1" DateTimePeriodDetails : FromToDate
AccountInterest3 *-- "0..1" TaxCharges2 : Tax
%% CashBalance3 recursion level 1 with max 1
class CashBalance3{
    Amount IsoActiveOrHistoricCurrencyAndAmount
    CreditDebitIndicator CreditDebitCode
}
CashBalance3 *-- "1..1" BalanceType12 : Type
CashBalance3 *-- "0..1" CreditLine2 : CreditLine
CashBalance3 *-- "1..1" IDateAndDateTimeChoice : Date
CashBalance3 *-- "0..0" CashBalanceAvailability2 : Availability
%% TotalTransactions4 recursion level 1 with max 1
TotalTransactions4 *-- "0..1" NumberAndSumOfTransactions4 : TotalEntries
TotalTransactions4 *-- "0..1" NumberAndSumOfTransactions1 : TotalCreditEntries
TotalTransactions4 *-- "0..1" NumberAndSumOfTransactions1 : TotalDebitEntries
TotalTransactions4 *-- "0..0" TotalsPerBankTransactionCode3 : TotalEntriesPerBankTransactionCode
%% ReportEntry4 recursion level 1 with max 1
class ReportEntry4{
    EntryReference IsoMax35Text
    Amount IsoActiveOrHistoricCurrencyAndAmount
    CreditDebitIndicator CreditDebitCode
    ReversalIndicator IsoTrueFalseIndicator
    Status EntryStatus2Code
    AccountServicerReference IsoMax35Text
    CommissionWaiverIndicator IsoYesNoIndicator
    AdditionalEntryInformation IsoMax500Text
}
ReportEntry4 *-- "0..1" IDateAndDateTimeChoice : BookingDate
ReportEntry4 *-- "0..1" IDateAndDateTimeChoice : ValueDate
ReportEntry4 *-- "0..0" CashBalanceAvailability2 : Availability
ReportEntry4 *-- "1..1" BankTransactionCodeStructure4 : BankTransactionCode
ReportEntry4 *-- "0..1" MessageIdentification2 : AdditionalInformationIndicator
ReportEntry4 *-- "0..1" AmountAndCurrencyExchange3 : AmountDetails
ReportEntry4 *-- "0..1" Charges4 : Charges
ReportEntry4 *-- "0..1" ITechnicalInputChannel1Choice : TechnicalInputChannel
ReportEntry4 *-- "0..1" TransactionInterest3 : Interest
ReportEntry4 *-- "0..1" CardEntry1 : CardTransaction
ReportEntry4 *-- "0..0" EntryDetails3 : EntryDetails

AccountReport16 members

Member name	Description	Data Type / Multiplicity
Identification	Unique identification, as assigned by the account servicer, to unambiguously identify the account report.	IsoMax35Text - Required 1..1
ReportPagination	Provides details on the page number of the report. Usage: The pagination of the report is only allowed when agreed between the parties.	Pagination - Optional 0..1
ElectronicSequenceNumber	Sequential number of the report, as assigned by the account servicer.	Usage: The sequential number is increased incrementally for each report sent electronically.
LegalSequenceNumber	Legal sequential number of the report, as assigned by the account servicer. It is increased incrementally for each report sent.	IsoNumber - Optional 0..1
CreationDateTime	Date and time at which the message was created.	IsoISODateTime - Required 1..1
FromToDate	Range of time between a start date and an end date for which the account report is issued.	DateTimePeriodDetails - Optional 0..1
CopyDuplicateIndicator	Indicates whether the document is a copy, a duplicate, or a duplicate of a copy.	CopyDuplicate1Code - Optional 0..1
ReportingSource	Specifies the application used to generate the reporting.	IReportingSource1Choice - Optional 0..1
Account	Unambiguous identification of the account to which credit and debit entries are made.	CashAccount25 - Required 1..1
RelatedAccount	Identifies the parent account of the account for which the report has been issued.	CashAccount24 - Optional 0..1
Interest	Provides general interest information that applies to the account at a particular moment in time.	AccountInterest3 - Unknown 0..0
Balance	Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account at a specific point in time.	CashBalance3 - Unknown 0..0
TransactionsSummary	Provides summary information on entries.	TotalTransactions4 - Optional 0..1
Entry	Set of elements used to specify an entry in the report.	Usage: At least one reference must be provided to identify the entry and its underlying transaction(s).
AdditionalReportInformation	Further details of the account report.	IsoMax500Text - 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 BankToCustomerAccountReportV04 implementation follows a specific implementaiton pattern. First of all, BankToCustomerAccountReportV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, BankToCustomerAccountReportV04Document implements IOuterDocument. Because BankToCustomerAccountReportV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type BankToCustomerAccountReportV04.

classDiagram
    class IOuterRecord
    BankToCustomerAccountReportV04 --|> IOuterRecord : Implements
    BankToCustomerAccountReportV04Document --|> IOuterDocument~BankToCustomerAccountReportV04~ : Implements
    class IOuterDocument~BankToCustomerAccountReportV04~ {
        BankToCustomerAccountReportV04 Message
     }

Document wrapper for serialization

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

classDiagram
    BankToCustomerAccountReportV04Document *-- BankToCustomerAccountReportV04 : 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.04">
    <BkToCstmrAcctRpt>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <Rpt>
            <!-- Report inner content -->
        </Rpt>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </BkToCstmrAcctRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_363KoSGnEeKjd4jizyIDGA"
  nextVersions="_p79NsRPdEeSVo-TFVwFHvA"
  previousVersion="_rta40FkyEeGeoaLUQk__nA_560918446"
  name="BankToCustomerAccountReportV04"
  definition="Scope&#xD;&#xA;The BankToCustomerAccountReport 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 BankToCustomerAccountReport message can contain reports for more than one 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, the Bank-to-Customer Account Statement message should be used."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="BkToCstmrAcctRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_363KoyGnEeKjd4jizyIDGA"
    nextVersions="_p79NsxPdEeSVo-TFVwFHvA"
    name="MessageOrReportPaginationRule"
    definition="MessagePagination may be present or ReportPagination may be present, but not both."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition&gt;&lt;SimpleRule xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;SimpleRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;OR&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/GroupHeader/MessagePagination&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/Report[*]/ReportPagination&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;/SimpleRule&gt;&lt;/RuleDefinition&gt;" />
  <constraint
    xmi:id="_D_Vy4SHZEeKGEZlIMFwKzg"
    nextVersions="_p79NtRPdEeSVo-TFVwFHvA"
    name="SupplementaryDataRule"
    definition="The SupplementaryData building block at message level must not be used to provide additional information about a transaction. The SupplementaryData element at transaction level should be used for that purpose."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_363KpyGnEeKjd4jizyIDGA"
    nextVersions="_p79NtxPdEeSVo-TFVwFHvA"
    name="GroupHeader"
    definition="Common information for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_s-L9JFkyEeGeoaLUQk__nA_460842520" />
  <messageBuildingBlock
    xmi:id="_363KqyGnEeKjd4jizyIDGA"
    nextVersions="_p79NuRPdEeSVo-TFVwFHvA"
    name="Report"
    definition="Reports on a cash account."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="Rpt"
    complexType="_kc1gISGxEeKjd4jizyIDGA" />
  <messageBuildingBlock
    xmi:id="_363KryGnEeKjd4jizyIDGA"
    nextVersions="_p79NuxPdEeSVo-TFVwFHvA"
    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="052"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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