Report Filing Service
| POST | /async/elma/reports/sign |
|---|
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 sign a report using the security certificate from the provided credential.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SignReportBase(IReturn[SigningResponse], IPost):
"""
Specifies a request to sign a report using the security certificate from the provided credential.
"""
# @ApiMember(Description="The report to sign.", IsRequired=true, Name="Report")
report: Optional[Report] = None
"""
The report to sign.
"""
# @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
credential: Optional[ElmaCredential] = None
"""
The credential to gain access on the ELMA server.
"""
@staticmethod
def response_type(): return SigningResponse
# @Api(Description="Represents a signature of an ELMA report.The RSASSA-PSS1 algorithm is used to create the signature.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Signature:
"""
Represents a signature of an ELMA report.The RSASSA-PSS1 algorithm is used to create the signature.
"""
# @ApiMember(Description="The conventional ELMA file name of the signature. The format of the ELMA formula is as follows: m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml.sig 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 signature. The format of the ELMA formula is as follows: m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml.sig 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 underlying raw data content of the signature.", IsRequired=true, Name="Data")
data: Optional[bytes] = None
"""
The underlying raw data content of the signature.
"""
# @Api(Description="Encapsulates the results of signing a report.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SigningResponse:
"""
Encapsulates the results of signing a report.
"""
# @ApiMember(Description="The report that was signed.", Name="Report")
report: Optional[Report] = None
"""
The report that was signed.
"""
# @ApiMember(Description="The signature obtained from signing the report.", Name="Report")
signature: Optional[Signature] = None
"""
The signature obtained from signing the report.
"""
# @ApiMember(Description="The status of the signing operation.", Name="ResponseStatus")
response_status: Optional[ResponseStatus] = None
"""
The status of the signing operation.
"""
# @Api(Description="Represents a request to sign a report in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SignReportAsync(SignReportBase):
"""
Represents a request to sign a report in an asynchronous operation.
"""
pass
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/elma/reports/sign HTTP/1.1
Host: reportfiling.pwc.de
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"report":{"id":"String","data":"String"},"credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"report":{"id":"String","data":"String"},"signature":{"id":"String","data":"AA=="},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}