Report Filing Service

FormatReportAsync

FormatReportAsync

Represents a request to format the header of a single report in an asynchronous operation.

The following routes are available for this service:
POST	/async/elma/reports/format

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Represents an ELMA report.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Report:
    """
    Represents an ELMA report.
    """

    # @ApiMember(Description="The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.", IsRequired=true, Name="Id")
    id: Optional[str] = None
    """
    The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.
    """


    # @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
    data: Optional[str] = None
    """
    The XML-content of the report.
    """


# @Api(Description="Represents a PEM-encoded certificate.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PemCertificate:
    """
    Represents a PEM-encoded certificate.
    """

    # @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
    id: Optional[str] = None
    """
    The unique identifier (e.g. the file name) of the certificate.
    """


    # @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
    content: Optional[str] = None
    """
    The PEM-encoded content of the certificate.
    """


    # @ApiMember(Description="The description of the certificate.", Name="Description")
    description: Optional[str] = None
    """
    The description of the certificate.
    """


    # @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    tags: Optional[List[str]] = None
    """
    Tags to label or identify the certificate.
    """


# @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElmaCredential(IElmaCredential):
    """
    Represents the credentials of a user to authenticate the access of an ELMA server.
    """

    # @ApiMember(Description="The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id")
    id: Optional[str] = None
    """
    The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.
    """


    # @ApiMember(Description="The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)", IsRequired=true, Name="Certificate")
    # @Required()
    # @StringLength(2147483647)
    certificate: Optional[PemCertificate] = None
    """
    The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)
    """


    # @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")
    # @Required()
    # @StringLength(11)
    auth_steuernummer: Optional[str] = None
    """
    The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
    """


    # @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
    # @Required()
    # @StringLength(10)
    account_id: Optional[str] = None
    """
    The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
    """


    # @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
    password: Optional[str] = None
    """
    The password to protect the certificate from unauthorized access.
    """


# @Api(Description="Specifies a request to format a report header.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormatReportBase(IReturn[FormatResponse], IPost, ISingleFormatRequest, IAuthenticateRequest):
    """
    Specifies a request to format a report header.
    """

    # @ApiMember(Description="The report to format.", IsRequired=true, Name="Report")
    report: Optional[Report] = None
    """
    The report to format.
    """


    # @ApiMember(Description="The credential to gain access to an ELMA server.", IsRequired=true, Name="Credential")
    credential: Optional[ElmaCredential] = None
    """
    The credential to gain access to an ELMA server.
    """
    @staticmethod
    def response_type(): return FormatResponse


# @Api(Description="Encapsulates the results of formatting a report")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormatResponse:
    """
    Encapsulates the results of formatting a report
    """

    # @ApiMember(Description="The unique identifier of the report that was processed.", Name="Id")
    id: Optional[str] = None
    """
    The unique identifier of the report that was processed.
    """


    # @ApiMember(Description="The formatted XML-based report content.", Name="Xml")
    xml: Optional[str] = None
    """
    The formatted XML-based report content.
    """


    # @ApiMember(Description="The status of the formatting operation.", Name="ResponseStatus")
    response_status: Optional[ResponseStatus] = None
    """
    The status of the formatting operation.
    """


# @Api(Description="Represents a request to format the header of a single report in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormatReportAsync(FormatReportBase):
    """
    Represents a request to format the header of a single report in an asynchronous operation.
    """

    pass

Python FormatReportAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /async/elma/reports/format HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormatReportAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Requests">
  <Credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
    <d2p1:AccountId>String</d2p1:AccountId>
    <d2p1:AuthSteuernummer>String</d2p1:AuthSteuernummer>
    <d2p1:Certificate xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
      <d3p1:Content>String</d3p1:Content>
      <d3p1:Description>String</d3p1:Description>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:Tags>
    </d2p1:Certificate>
    <d2p1:Password>String</d2p1:Password>
  </Credential>
  <Report xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
    <d2p1:Data>String</d2p1:Data>
    <d2p1:Id>String</d2p1:Id>
  </Report>
</FormatReportAsync>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormatResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Responses">
  <Id>String</Id>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Xml>String</Xml>
</FormatResponse>