Report Filing Service

BatchFormatReportFilesAsync

FormatReportsBatchAsync

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

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Represents a request to format the headers of report files in an asynchronous operation.
*/
@Api(Description="Represents a request to format the headers of report files in an asynchronous operation.")
open class BatchFormatReportFilesAsync : BatchFormatReportsBase()
{
}

/**
* Specifies a request to format report headers.
*/
@Api(Description="Specifies a request to format report headers.")
open class BatchFormatReportsBase : IPost, IBatchFormatRequest, IAuthenticateRequest
{
    /**
    * The reports to format.
    */
    @ApiMember(Description="The reports to format.", IsRequired=true, Name="Reports")
    var reports:ArrayList<Report> = ArrayList<Report>()

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

/**
* Represents an ELMA report.
*/
@Api(Description="Represents an ELMA report.")
open class Report
{
    /**
    * 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")
    var id:String? = null

    /**
    * The XML-content of the report.
    */
    @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
    @SerializedName("data") var Data:String? = null
}

/**
* 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.")
open class ElmaCredential : IElmaCredential
{
    /**
    * 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")
    var id:String? = null

    /**
    * 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)
    var certificate:PemCertificate? = null

    /**
    * 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)
    var authSteuernummer:String? = null

    /**
    * 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)
    var accountId:String? = null

    /**
    * The password to protect the certificate from unauthorized access.
    */
    @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
    var password:String? = null
}

/**
* Represents a PEM-encoded certificate.
*/
@Api(Description="Represents a PEM-encoded certificate.")
open class PemCertificate
{
    /**
    * 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")
    var id:String? = null

    /**
    * The PEM-encoded content of the certificate.
    */
    @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
    var content:String? = null

    /**
    * The description of the certificate.
    */
    @ApiMember(Description="The description of the certificate.", Name="Description")
    var description:String? = null

    /**
    * Tags to label or identify the certificate.
    */
    @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    var tags:ArrayList<String> = ArrayList<String>()
}

Kotlin BatchFormatReportFilesAsync DTOs

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

HTTP + OTHER

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

POST /async/elma/files/reports/batch/format HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}}]