Report Filing Service
| POST | /async/elma/reports/validate |
|---|
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="Specifies a request to validate a report.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidateReportBase(IReturn[ValidationResponse], IPost):
"""
Specifies a request to validate a report.
"""
# @ApiMember(Description="The report to validate.", IsRequired=true, Name="Report")
report: Optional[Report] = None
"""
The report to validate.
"""
@staticmethod
def response_type(): return ValidationResponse
# @Api(Description="Represents a failure encountered during the validation of an ELMA report against its XML schema. ")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidationError:
"""
Represents a failure encountered during the validation of an ELMA report against its XML schema.
"""
# @ApiMember(Description="The unique identifier of the validation faílure.\n This is equivalent to the file name of the validated report.", Name="Id")
id: Optional[str] = None
"""
The unique identifier of the validation faílure. This is equivalent to the file name of the validated report.
"""
# @ApiMember(Description="The message of the validation failure.", Name="Message")
message: Optional[str] = None
"""
The message of the validation failure.
"""
# @ApiMember(Description="The severity of the validation faílure.", Name="Severity")
severity: Optional[XmlSeverityType] = None
"""
The severity of the validation faílure.
"""
# @ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
line_number: int = 0
"""
The line number indicating where the error occurred.
"""
# @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
line_position: int = 0
"""
The line position indicating where the error occurred.
"""
# @Api(Description="Encapsulates the results of validating a report")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidationResponse:
"""
Encapsulates the results of validating a report
"""
# @ApiMember(Description="The unique identifier of the report that was processed.\nThe identifier is usually the filename.", Name="Id")
id: Optional[str] = None
"""
The unique identifier of the report that was processed.The identifier is usually the filename.
"""
# @ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")
validation_errors: Optional[List[ValidationError]] = None
"""
The errors encountered during the report validation operation.
"""
# @ApiMember(Description="The status of the validation operation.", Name="ResponseStatus")
response_status: Optional[ResponseStatus] = None
"""
The status of the validation operation.
"""
# @Api(Description="Represents a request to validate a report in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidateReportAsync(ValidateReportBase):
"""
Represents a request to validate a report in an asynchronous operation.
"""
pass
Python ValidateReportAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/elma/reports/validate HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
report:
{
id: String,
data: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: String,
validationErrors:
[
{
id: String,
message: String,
severity: Error,
lineNumber: 0,
linePosition: 0
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}