Iso20022

InvoiceTaxReportStatusAdviceV01

auth.038.001.01

The InvoiceTaxReportStatusAdvice message is sent by the matching application to the party from which it received a message. This message is used to acknowledge the InvoiceTaxReport message.

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
%% InvoiceTaxReportStatusAdviceV01 recursion level 0 with max 0
InvoiceTaxReportStatusAdviceV01 *-- "1..1" InvoiceTaxStatusReportHeader1 : StatusReportHeader
InvoiceTaxReportStatusAdviceV01 *-- "0..1" InvoiceTaxReportTransactionStatus1 : TransactionStatus
InvoiceTaxReportStatusAdviceV01 *-- "0..1" SupplementaryData1 : SupplementaryData

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

StatusReportHeader building block

Provides the status on the InvoiceTaxReport. Provides the Invoice tax status report header details. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InvoiceTaxStatusReportHeader1 recursion level 0 with max 1
class InvoiceTaxStatusReportHeader1{
    ReportStatus TaxReportingStatus1Code
}
InvoiceTaxStatusReportHeader1 *-- "0..1" TaxOrganisationIdentification1 : TaxAuthority
InvoiceTaxStatusReportHeader1 *-- "1..1" MessageIdentification1 : MessageIdentification
InvoiceTaxStatusReportHeader1 *-- "1..1" MessageIdentification1 : OriginalMessageIdentification
InvoiceTaxStatusReportHeader1 *-- "0..0" GenericValidationRuleIdentification1 : ValidationRule
%% TaxOrganisationIdentification1 recursion level 1 with max 1
class TaxOrganisationIdentification1{
    Name IsoMax140Text
}
TaxOrganisationIdentification1 *-- "0..1" PostalAddress6 : PostalAddress
TaxOrganisationIdentification1 *-- "0..1" ContactDetails2 : ContactDetails
%% MessageIdentification1 recursion level 1 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
%% MessageIdentification1 recursion level 1 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
%% GenericValidationRuleIdentification1 recursion level 1 with max 1
class GenericValidationRuleIdentification1{
    Identification IsoMax35Text
    Description IsoMax350Text
    Issuer IsoMax35Text
}
GenericValidationRuleIdentification1 *-- "0..1" IValidationRuleSchemeName1Choice : SchemeName

InvoiceTaxStatusReportHeader1 members

Member name Description Data Type / Multiplicity
TaxAuthority Party to which the TaxReport is delivered. This message block contains party details for a specific tax authority. TaxOrganisationIdentification1 - Optional 0..1
MessageIdentification Identifies the InvoiceTaxReportStatusAdvice message. MessageIdentification1 - Required 1..1
OriginalMessageIdentification Reference to the identification of the InvoiceTaxReport message. MessageIdentification1 - Required 1..1
ReportStatus Provides the status for the full report. TaxReportingStatus1Code - Required 1..1
ValidationRule Provides the details of the rule which could not be validated. GenericValidationRuleIdentification1 - Unknown 0..0

TransactionStatus building block

Provides the status on an individual transaction and the related reason if required. Provides the details of each individual invoice tax report transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InvoiceTaxReportTransactionStatus1 recursion level 0 with max 1
class InvoiceTaxReportTransactionStatus1{
    TaxReportIdentification IsoMax35Text
    Status TaxReportingStatus2Code
}
InvoiceTaxReportTransactionStatus1 *-- "0..0" GenericValidationRuleIdentification1 : ValidationRule
InvoiceTaxReportTransactionStatus1 *-- "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

InvoiceTaxReportTransactionStatus1 members

Member name Description Data Type / Multiplicity
TaxReportIdentification Report identification, for example invoice number or report number from point of sales system. IsoMax35Text - Required 1..1
Status Defines status of the reported transaction. TaxReportingStatus2Code - Required 1..1
ValidationRule Provides the details of the rule which could not be validated. GenericValidationRuleIdentification1 - Unknown 0..0
SupplementaryData Additional information that can not be captured in the structured fields and/or any other specific block. SupplementaryData1 - Unknown 0..0

SupplementaryData building block

Additional information that can not be captured in the structured fields 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 InvoiceTaxReportStatusAdviceV01 implementation follows a specific implementaiton pattern. First of all, InvoiceTaxReportStatusAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, InvoiceTaxReportStatusAdviceV01Document implements IOuterDocument. Because InvoiceTaxReportStatusAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type InvoiceTaxReportStatusAdviceV01.

classDiagram
    class IOuterRecord
    InvoiceTaxReportStatusAdviceV01 --|> IOuterRecord : Implements
    InvoiceTaxReportStatusAdviceV01Document --|> IOuterDocument~InvoiceTaxReportStatusAdviceV01~ : Implements
    class IOuterDocument~InvoiceTaxReportStatusAdviceV01~ {
        InvoiceTaxReportStatusAdviceV01 Message
     }

Document wrapper for serialization

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

classDiagram
    InvoiceTaxReportStatusAdviceV01Document *-- InvoiceTaxReportStatusAdviceV01 : 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.038.001.01">
    <InvcTaxRptStsAdvc>
        <StsRptHdr>
            <!-- StatusReportHeader inner content -->
        </StsRptHdr>
        <TxSts>
            <!-- TransactionStatus inner content -->
        </TxSts>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </InvcTaxRptStsAdvc>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_HjF1skshEeWvyKllQkSXyA"
  name="InvoiceTaxReportStatusAdviceV01"
  definition="The InvoiceTaxReportStatusAdvice message is sent by the matching application to the party from which it received a message.&#xD;&#xA;This message is used to acknowledge the InvoiceTaxReport message."
  registrationStatus="Registered"
  messageSet="_i2UsEd9iEeSE_fKK4lPHMA"
  xmlTag="InvcTaxRptStsAdvc"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_uitmYE53Eeaine-lsNAGsA"
    name="StatusReportHeader"
    definition="Provides the status on the InvoiceTaxReport."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="StsRptHdr"
    complexType="_I_Tr4U52Eeaine-lsNAGsA" />
  <messageBuildingBlock
    xmi:id="_PM8n8E54Eeaine-lsNAGsA"
    name="TransactionStatus"
    definition="Provides the status on an individual transaction and the related reason if required."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="TxSts"
    complexType="_8pkzYU53Eeaine-lsNAGsA" />
  <messageBuildingBlock
    xmi:id="_XlusIE2ZEea-HpmqkM55Lg"
    name="SupplementaryData"
    definition="Additional information that can not be captured in the structured fields and/or any other specific&#xD;&#xA;block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="auth"
    messageFunctionality="038"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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