Report Filing Service
| POST | /sync/elma/reports/sign |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
/**
* 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;
}
/**
* Represents a PEM-encoded certificate.
*/
// @Api(Description="Represents a PEM-encoded certificate.")
class PemCertificate implements IConvertible
{
/**
* The unique identifier (e.g. the file name) of the certificate.
*/
// @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
String? id;
/**
* The PEM-encoded content of the certificate.
*/
// @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
String? content;
/**
* The description of the certificate.
*/
// @ApiMember(Description="The description of the certificate.", Name="Description")
String? description;
/**
* Tags to label or identify the certificate.
*/
// @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
List<String>? tags;
PemCertificate({this.id,this.content,this.description,this.tags});
PemCertificate.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
content = json['content'];
description = json['description'];
tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'content': content,
'description': description,
'tags': JsonConverters.toJson(tags,'List<String>',context!)
};
getTypeName() => "PemCertificate";
TypeContext? context = _ctx;
}
/**
* Represents the credentials of a user to authenticate the access of an ELMA server.
*/
// @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
class ElmaCredential implements IElmaCredential, IConvertible
{
/**
* The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
*/
// @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")
String? id;
/**
* 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 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)
PemCertificate? certificate;
/**
* 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 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)
String? authSteuernummer;
/**
* The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
*/
// @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)
String? accountId;
/**
* The password to protect the certificate from unauthorized access.
*/
// @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
String? password;
ElmaCredential({this.id,this.certificate,this.authSteuernummer,this.accountId,this.password});
ElmaCredential.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
certificate = JsonConverters.fromJson(json['certificate'],'PemCertificate',context!);
authSteuernummer = json['authSteuernummer'];
accountId = json['accountId'];
password = json['password'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'certificate': JsonConverters.toJson(certificate,'PemCertificate',context!),
'authSteuernummer': authSteuernummer,
'accountId': accountId,
'password': password
};
getTypeName() => "ElmaCredential";
TypeContext? context = _ctx;
}
/**
* Specifies a request to sign a report using the security certificate from the provided credential.
*/
// @Api(Description="Specifies a request to sign a report using the security certificate from the provided credential.")
abstract class SignReportBase implements IPost
{
/**
* The report to sign.
*/
// @ApiMember(Description="The report to sign.", IsRequired=true, Name="Report")
Report? report;
/**
* The credential to gain access on the ELMA server.
*/
// @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
ElmaCredential? credential;
SignReportBase({this.report,this.credential});
SignReportBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
report = JsonConverters.fromJson(json['report'],'Report',context!);
credential = JsonConverters.fromJson(json['credential'],'ElmaCredential',context!);
return this;
}
Map<String, dynamic> toJson() => {
'report': JsonConverters.toJson(report,'Report',context!),
'credential': JsonConverters.toJson(credential,'ElmaCredential',context!)
};
getTypeName() => "SignReportBase";
TypeContext? context = _ctx;
}
/**
* Represents a signature of an ELMA report.The RSASSA-PSS1 algorithm is used to create the signature.
*/
// @Api(Description="Represents a signature of an ELMA report.The RSASSA-PSS1 algorithm is used to create the signature.")
class Signature implements IConvertible
{
/**
* 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 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")
String? id;
/**
* The underlying raw data content of the signature.
*/
// @ApiMember(Description="The underlying raw data content of the signature.", IsRequired=true, Name="Data")
Uint8List? data;
Signature({this.id,this.data});
Signature.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
data = JsonConverters.fromJson(json['data'],'Uint8List',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'data': JsonConverters.toJson(data,'Uint8List',context!)
};
getTypeName() => "Signature";
TypeContext? context = _ctx;
}
/**
* Encapsulates the results of signing a report.
*/
// @Api(Description="Encapsulates the results of signing a report.")
class SigningResponse implements IConvertible
{
/**
* The report that was signed.
*/
// @ApiMember(Description="The report that was signed.", Name="Report")
Report? report;
/**
* The signature obtained from signing the report.
*/
// @ApiMember(Description="The signature obtained from signing the report.", Name="Report")
Signature? signature;
/**
* The status of the signing operation.
*/
// @ApiMember(Description="The status of the signing operation.", Name="ResponseStatus")
ResponseStatus? responseStatus;
SigningResponse({this.report,this.signature,this.responseStatus});
SigningResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
report = JsonConverters.fromJson(json['report'],'Report',context!);
signature = JsonConverters.fromJson(json['signature'],'Signature',context!);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'report': JsonConverters.toJson(report,'Report',context!),
'signature': JsonConverters.toJson(signature,'Signature',context!),
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "SigningResponse";
TypeContext? context = _ctx;
}
/**
* Represents a request to sign a report.
*/
// @Api(Description="Represents a request to sign a report.")
class SignReport extends SignReportBase implements IConvertible
{
SignReport();
SignReport.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() => "SignReport";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'reportfiling.pwc.de', types: <String, TypeInfo> {
'Report': TypeInfo(TypeOf.Class, create:() => Report()),
'PemCertificate': TypeInfo(TypeOf.Class, create:() => PemCertificate()),
'ElmaCredential': TypeInfo(TypeOf.Class, create:() => ElmaCredential()),
'SignReportBase': TypeInfo(TypeOf.AbstractClass),
'Signature': TypeInfo(TypeOf.Class, create:() => Signature()),
'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
'SigningResponse': TypeInfo(TypeOf.Class, create:() => SigningResponse()),
'SignReport': TypeInfo(TypeOf.Class, create:() => SignReport()),
});
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 /sync/elma/reports/sign HTTP/1.1
Host: reportfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
}
}
}