/* Options:
Date: 2024-11-26 01:35:11
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.staging.pwc.de

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: ValidateReport.*
//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 validate a report.
*/
@Route(Path="/sync/elma/reports/validate", Verbs="POST")
@Api(Description="Represents a request to validate a report.")
open class ValidateReport : ValidateReportBase(), IReturn<ValidationResponse>
{
    companion object { private val responseType = ValidationResponse::class.java }
    override fun getResponseType(): Any? = ValidateReport.responseType
}

/**
* Encapsulates the results of validating a report
*/
@Api(Description="Encapsulates the results of validating a report")
open class ValidationResponse
{
    /**
    * 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")
    var id:String? = null

    /**
    * The errors encountered during the report validation operation.
    */
    @ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")
    var validationErrors:ArrayList<ValidationError> = ArrayList<ValidationError>()

    /**
    * The status of the validation operation.
    */
    @ApiMember(Description="The status of the validation operation.", Name="ResponseStatus")
    var responseStatus:ResponseStatus? = 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_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.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_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.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
}

/**
* Specifies a request to validate a report.
*/
@Api(Description="Specifies a request to validate a report.")
open class ValidateReportBase : IPost
{
    /**
    * The report to validate.
    */
    @ApiMember(Description="The report to validate.", IsRequired=true, Name="Report")
    var report:Report? = null
}

/**
* 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
}