Report Filing Service

BatchFormatReportsAsync

FormatReportsBatchAsync

Represents a request to format the headers of reports in an asynchronous operation.

The following routes are available for this service:
POST	/async/elma/reports/batch/format

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 format report headers.
*/
// @Api(Description="Specifies a request to format report headers.")
abstract class BatchFormatReportsBase implements IPost, IBatchFormatRequest, IAuthenticateRequest
{
    /**
    * The reports to format.
    */
    // @ApiMember(Description="The reports to format.", IsRequired=true, Name="Reports")
    List<Report>? reports;

    /**
    * The credential to gain access to an ELMA server.
    */
    // @ApiMember(Description="The credential to gain access to an ELMA server.", IsRequired=true, Name="Credential")
    ElmaCredential? credential;

    BatchFormatReportsBase({this.reports,this.credential});
    BatchFormatReportsBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        reports = JsonConverters.fromJson(json['reports'],'List<Report>',context!);
        credential = JsonConverters.fromJson(json['credential'],'ElmaCredential',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'reports': JsonConverters.toJson(reports,'List<Report>',context!),
        'credential': JsonConverters.toJson(credential,'ElmaCredential',context!)
    };

    getTypeName() => "BatchFormatReportsBase";
    TypeContext? context = _ctx;
}

/**
* Represents a request to format the headers of reports in an asynchronous operation.
*/
// @Api(Description="Represents a request to format the headers of reports in an asynchronous operation.")
class BatchFormatReportsAsync extends BatchFormatReportsBase implements IConvertible
{
    BatchFormatReportsAsync();
    BatchFormatReportsAsync.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() => "BatchFormatReportsAsync";
    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()),
    'BatchFormatReportsBase': TypeInfo(TypeOf.AbstractClass),
    'List<Report>': TypeInfo(TypeOf.Class, create:() => <Report>[]),
    'BatchFormatReportsAsync': TypeInfo(TypeOf.Class, create:() => BatchFormatReportsAsync()),
});

Dart BatchFormatReportsAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /async/elma/reports/batch/format HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"reports":[{"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: application/x-msgpack
Content-Length: length

[{"id":"String","xml":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]