Report Filing Service
| POST | /sync/elma/reports/validate |
|---|
import 'package:servicestack/servicestack.dart';
/**
* Represents an ELMA report.
*/
// @Api(Description="Represents an ELMA report.")
class Report implements IConvertible
{
/**
* 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 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")
String? id;
/**
* The XML-content of the report.
*/
// @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
String? data;
Report({this.id,this.data});
Report.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
data = json['data'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'data': data
};
getTypeName() => "Report";
TypeContext? context = _ctx;
}
/**
* Specifies a request to validate a report.
*/
// @Api(Description="Specifies a request to validate a report.")
abstract class ValidateReportBase implements IPost
{
/**
* The report to validate.
*/
// @ApiMember(Description="The report to validate.", IsRequired=true, Name="Report")
Report? report;
ValidateReportBase({this.report});
ValidateReportBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
report = JsonConverters.fromJson(json['report'],'Report',context!);
return this;
}
Map<String, dynamic> toJson() => {
'report': JsonConverters.toJson(report,'Report',context!)
};
getTypeName() => "ValidateReportBase";
TypeContext? context = _ctx;
}
/**
* Represents a failure encountered during the validation of an ELMA report against its XML schema.
*/
// @Api(Description="Represents a failure encountered during the validation of an ELMA report against its XML schema. ")
class ValidationError implements IConvertible
{
/**
* The unique identifier of the validation faílure. This is equivalent to the file name of the validated report.
*/
// @ApiMember(Description="The unique identifier of the validation faílure.\n This is equivalent to the file name of the validated report.", Name="Id")
String? id;
/**
* The message of the validation failure.
*/
// @ApiMember(Description="The message of the validation failure.", Name="Message")
String? message;
/**
* The severity of the validation faílure.
*/
// @ApiMember(Description="The severity of the validation faílure.", Name="Severity")
XmlSeverityType? severity;
/**
* The line number indicating where the error occurred.
*/
// @ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
int? lineNumber;
/**
* The line position indicating where the error occurred.
*/
// @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
int? linePosition;
ValidationError({this.id,this.message,this.severity,this.lineNumber,this.linePosition});
ValidationError.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
message = json['message'];
severity = JsonConverters.fromJson(json['severity'],'XmlSeverityType',context!);
lineNumber = json['lineNumber'];
linePosition = json['linePosition'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'message': message,
'severity': JsonConverters.toJson(severity,'XmlSeverityType',context!),
'lineNumber': lineNumber,
'linePosition': linePosition
};
getTypeName() => "ValidationError";
TypeContext? context = _ctx;
}
/**
* Encapsulates the results of validating a report
*/
// @Api(Description="Encapsulates the results of validating a report")
class ValidationResponse implements IConvertible
{
/**
* The unique identifier of the report that was processed.The identifier is usually the filename.
*/
// @ApiMember(Description="The unique identifier of the report that was processed.\nThe identifier is usually the filename.", Name="Id")
String? id;
/**
* The errors encountered during the report validation operation.
*/
// @ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")
List<ValidationError>? validationErrors;
/**
* The status of the validation operation.
*/
// @ApiMember(Description="The status of the validation operation.", Name="ResponseStatus")
ResponseStatus? responseStatus;
ValidationResponse({this.id,this.validationErrors,this.responseStatus});
ValidationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
validationErrors = JsonConverters.fromJson(json['validationErrors'],'List<ValidationError>',context!);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'validationErrors': JsonConverters.toJson(validationErrors,'List<ValidationError>',context!),
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "ValidationResponse";
TypeContext? context = _ctx;
}
/**
* Represents a request to validate a report.
*/
// @Api(Description="Represents a request to validate a report.")
class ValidateReport extends ValidateReportBase implements IConvertible
{
ValidateReport();
ValidateReport.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "ValidateReport";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
'Report': TypeInfo(TypeOf.Class, create:() => Report()),
'ValidateReportBase': TypeInfo(TypeOf.AbstractClass),
'ValidationError': TypeInfo(TypeOf.Class, create:() => ValidationError()),
'XmlSeverityType': TypeInfo(TypeOf.Class, create:() => XmlSeverityType()),
'ValidationResponse': TypeInfo(TypeOf.Class, create:() => ValidationResponse()),
'List<ValidationError>': TypeInfo(TypeOf.Class, create:() => <ValidationError>[]),
'ValidateReport': TypeInfo(TypeOf.Class, create:() => ValidateReport()),
});
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 /sync/elma/reports/validate HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"report":{"id":"String","data":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}