/* Options:
Date: 2025-04-10 13:40:42
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.pwc.de
//Package:
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion:
//AddDescriptionAsComments: True
IncludeTypes: BatchSubmitReportsAsync.*
//ExcludeTypes:
//InitializeCollections: True
//TreatTypesAsStrings:
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*,com.google.gson.annotations.*,com.google.gson.reflect.*
*/
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Represents a request to submit reports to the ELMA server.
*/
@Route(Path="/async/elma/reports/batch/submit", Verbs="POST")
@Api(Description="Represents a request to submit reports to the ELMA server.")
open class BatchSubmitReportsAsync : BatchSubmitReportsBase(), IReturn<ArrayList<SubmissionResponse>>
{
companion object { private val responseType = object : TypeToken<ArrayList<SubmissionResponse>>(){}.type }
override fun getResponseType(): Any? = BatchSubmitReportsAsync.responseType
}
/**
* 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
}
open interface IAuthenticateRequest
{
var credential:ElmaCredential?
}
open interface IStageableRequest
{
var stagingEnabled:Boolean?
}
/**
* 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
}
open interface IUploadRequest
{
var validationEnabled:Boolean?
}
/**
* Specifies a request to submit reports to the ELMA server.
*/
@Api(Description="Specifies a request to submit reports to the ELMA server.")
open class BatchSubmitReportsBase : IPost, IAuthenticateRequest, IBatchUploadRequest, IStageableRequest
{
/**
* The reports to submit to the ELMA server.
*/
@ApiMember(Description="The reports to submit to the ELMA server.", IsRequired=true, Name="Reports")
var reports:ArrayList<Report> = ArrayList<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")
var credential:ElmaCredential? = null
/**
* Should the report data be validated before sending it to the ELMA server? true: report data is validated before submission to the ELMA server. false: report data sent without validation to the ELMA server.
*/
@ApiMember(Description="Should the report data be validated before sending it to the ELMA server? true: report data is validated before submission to the ELMA server. false: report data sent without validation to the ELMA server.", Name="ValidationEnabled")
var validationEnabled:Boolean? = null
/**
* Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.
*/
@ApiMember(Description="Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.", Name="StagingEnabled")
var stagingEnabled:Boolean? = null
}
open interface IBatchUploadRequest : IUploadRequest
{
var reports:ArrayList<Report>?
}
/**
* 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>()
}
/**
* 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. ")
open class ValidationError
{
/**
* 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")
var id:String? = null
/**
* The message of the validation failure.
*/
@ApiMember(Description="The message of the validation failure.", Name="Message")
var message:String? = null
/**
* The severity of the validation faílure.
*/
@ApiMember(Description="The severity of the validation faílure.", Name="Severity")
var severity:XmlSeverityType? = null
/**
* The line number indicating where the error occurred.
*/
@ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
var lineNumber:Int? = null
/**
* The line position indicating where the error occurred.
*/
@ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
var linePosition:Int? = null
}
open interface IElmaCredential
{
var certificate:PemCertificate?
var authSteuernummer:String?
var accountId:String?
var password:String?
}
/**
* Encapsulates the results of submitting a report
*/
@Api(Description="Encapsulates the results of submitting a report")
open class SubmissionResponse
{
/**
* The unique identifier of the report that was processed.
*/
@ApiMember(Description="The unique identifier of the report that was processed.", Name="Id")
var id:String? = null
/**
* The submitted XML-based report content.
*/
@ApiMember(Description="The submitted XML-based report content.", Name="Xml")
var xml:String? = null
/**
* The errors encountered during the validation phase of the report submission operation.
*/
@ApiMember(Description="The errors encountered during the validation phase of the report submission operation.", Name="ValidationErrors")
var validationErrors:ArrayList<ValidationError> = ArrayList<ValidationError>()
/**
* The status of the report submission operation.
*/
@ApiMember(Description="The status of the report submission operation.", Name="ResponseStatus")
var responseStatus:ResponseStatus? = null
}