""" Options:
Date: 2025-04-17 19:49:29
Version: 8.60
Tip: To override a DTO option, remove "#" prefix before updating
BaseUrl: https://reportfiling.staging.pwc.de
#GlobalNamespace:
#AddServiceStackTypes: True
#AddResponseStatus: False
#AddImplicitVersion:
#AddDescriptionAsComments: True
IncludeTypes: FormatReportAsync.*
#ExcludeTypes:
#DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum
#DataClass:
#DataClassJson:
"""
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 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.
"""
class IAuthenticateRequest:
credential: Optional[ElmaCredential] = None
# @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="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)
report: Optional[Report] = None
"""
The report to format.
"""
# @ApiMember(Description="Provides credential information to the header.", IsRequired=true)
credential: Optional[ElmaCredential] = None
"""
Provides credential information to the header.
"""
@staticmethod
def response_type(): return FormatResponse
class ISingleFormatRequest:
report: Optional[Report] = None
class IElmaCredential:
certificate: Optional[PemCertificate] = None
auth_steuernummer: Optional[str] = None
account_id: Optional[str] = None
password: Optional[str] = None
# @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.
"""
# @Route("/async/elma/reports/format", "POST")
# @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, IReturn[FormatResponse]):
"""
Represents a request to format the header of a single report in an asynchronous operation.
"""
pass