Tax Filing Service
| POST | /ValidiereAsync | An asynchronous service to validate tax data. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* An asynchronous service to validate tax data.
*/
@Api(Description="An asynchronous service to validate tax data.")
open class ValidiereAsync : BearbeiteVorgangBase()
{
/**
* The tax data to process.
*/
@ApiMember(Description="The tax data to process.", Name="Data")
@SerializedName("data") var Data:TaxData? = null
}
/**
* A base service to process tax data.
*/
@Api(Description="A base service to process tax data.")
open class BearbeiteVorgangBase : IPost
{
/**
* The tax data to process.
*/
@ApiMember(Description="The tax data to process.", Name="Data")
@SerializedName("data") var Data:TaxData? = null
}
/**
* Represents a structure that encapsulates a tax declaration.
*/
@Api(Description="Represents a structure that encapsulates a tax declaration.")
open class TaxData
{
/**
* The unique identifier of the tax data.
*/
@ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
var id:String? = null
/**
* The XML-based tax declaration.
*/
@ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
var content:String? = null
}
/**
* A type that encapsulates the return values from the ERiC API function that processes tax data.
*/
@Api(Description="A type that encapsulates the return values from the ERiC API function that processes tax data.")
open class BearbeiteVorgangResponse : EricFehlerCodeResponse()
{
/**
* The return value of the process.
*/
@ApiMember(Description="The return value of the process.")
var rueckgabe:EricBearbeiteVorgang? = null
/**
* The server response of the process.
*/
@ApiMember(Description="The server response of the process.")
var serverantwort:Elster? = null
/**
* If available, the PDF-based files to represent generated transfer prototocols.
*/
@ApiMember(Description="If available, the PDF-based files to represent generated transfer prototocols.")
var transferProtocols:ArrayList<BinaryFile> = ArrayList<BinaryFile>()
/**
* The status code that the ERiC API function returns.
*/
@ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
var statusCode:EricFehlerCode? = null
/**
* The status message that the ERiC API function returns.
*/
@ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
var statusText:String? = null
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
var id:String? = null
/**
* The position of the response element in an indexed collection.
*/
@ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
var index:Int? = null
/**
* Metadata that contains structured error information on the service response.
*/
@ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
var responseStatus:ResponseStatus? = null
}
/**
* Represent a base response that encapsulate any ERiC API function return value.
*/
@Api(Description="Represent a base response that encapsulate any ERiC API function return value.")
open class EricFehlerCodeResponse : ServiceReponseBase()
{
/**
* The status code that the ERiC API function returns.
*/
@ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
var statusCode:EricFehlerCode? = null
/**
* The status message that the ERiC API function returns.
*/
@ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
var statusText:String? = null
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
var id:String? = null
/**
* The position of the response element in an indexed collection.
*/
@ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
var index:Int? = null
/**
* Metadata that contains structured error information on the service response.
*/
@ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
var responseStatus:ResponseStatus? = null
}
/**
* Specifies a service response from an ERiC service operation.
*/
@Api(Description="Specifies a service response from an ERiC service operation.")
open class ServiceReponseBase : IHasIndex
{
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
var id:String? = null
/**
* The position of the response element in an indexed collection.
*/
@ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
var index:Int? = null
/**
* Metadata that contains structured error information on the service response.
*/
@ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
var responseStatus:ResponseStatus? = null
}
/**
* Enumeration of ERiC API error codes.
*/
enum class EricFehlerCode(val value:Int)
{
EricOk(0),
EricGlobalUnknown(610001001),
EricGlobalPruefFehler(610001002),
EricGlobalHinweise(610001003),
EricGlobalFehlermeldungNichtVorhanden(610001007),
EricGlobalKeineDatenVorhanden(610001008),
EricGlobalNichtGenuegendArbeitsspeicher(610001013),
EricGlobalDateiNichtGefunden(610001014),
EricGlobalHerstellerIdNichtErlaubt(610001016),
EricGlobalIllegalState(610001017),
EricGlobalFunktionNichtErlaubt(610001018),
EricGlobalEchtfallNichtErlaubt(610001019),
EricGlobalNoVersandInBetaVersion(610001020),
EricGlobalTestmerkerUngueltig(610001025),
EricGlobalDatensatzZuGross(610001026),
EricGlobalVerschluesselungsParameterNichtErlaubt(610001027),
EricGlobalNurPortalzertifikatErlaubt(610001028),
EricGlobalAbrufcodeNichtErlaubt(610001029),
EricGlobalErrorXmlCreate(610001030),
EricGlobalTextpuffergroesseFix(610001031),
EricGlobalInternerFehler(610001032),
EricGlobalArithmetikfehler(610001033),
EricGlobalSteuernummerUngueltig(610001034),
EricGlobalSteuernummerFalscheLaenge(610001035),
EricGlobalSteuernummerNichtNumerisch(610001036),
EricGlobalLandesnummerUnbekannt(610001037),
EricGlobalBufanrUnbekannt(610001038),
EricGlobalLandesnummerBufanr(610001039),
EricGlobalPufferZugriffskonflikt(610001040),
EricGlobalPufferUeberlauf(610001041),
EricGlobalDatenartversionUnbekannt(610001042),
EricGlobalDatenartversionXmlInkonsistent(610001044),
EricGlobalCommondataNichtVerfuegbar(610001045),
EricGlobalLogException(610001046),
EricGlobalTransportschluesselNichtErlaubt(610001047),
EricGlobalOeffentlicherSchluesselUngueltig(610001048),
EricGlobalTransportschluesselTypFalsch(610001049),
EricGlobalPufferUngleicherInstanz(610001050),
EricGlobalVorsatzUngueltig(610001051),
EricGlobalDateizugriffVerweigert(610001053),
EricGlobalUngueltigeInstanz(610001080),
EricGlobalNichtInitialisiert(610001081),
EricGlobalMehrfacheInitialisierung(610001082),
EricGlobalFehlerInitialisierung(610001083),
EricGlobalUnknownParameterError(610001102),
EricGlobalCheckCorruptedNds(610001108),
EricGlobalVerschluesselungsParameterNichtAngegeben(610001206),
EricGlobalSendFlagMehrAlsEines(610001209),
EricGlobalUngueltigeFlagKombination(610001218),
EricGlobalErsteSeiteDruckNichtUnterstuetzt(610001220),
EricGlobalUngueltigerParameter(610001222),
EricGlobalDruckFuerVerfahrenNichtErlaubt(610001224),
EricGlobalVersandArtNichtUnterstuetzt(610001225),
EricGlobalUngueltigeParameterVersion(610001226),
EricGlobalTransferhandle(610001227),
EricGlobalPlugininitialisierung(610001228),
EricGlobalInkompatibleVersionen(610001229),
EricGlobalVerschluesselungsverfahrenNichtUnterstuetzt(610001230),
EricGlobalMehrfachaufrufeNichtUnterstuetzt(610001231),
EricGlobalUtiCountryNotSupported(610001404),
EricGlobalIbanFormalerFehler(610001501),
EricGlobalIbanLaendercodeFehler(610001502),
EricGlobalIbanLandesformatFehler(610001503),
EricGlobalIbanPruefzifferFehler(610001504),
EricGlobalBicFormalerFehler(610001510),
EricGlobalBicLaendercodeFehler(610001511),
EricGlobalZulassungsnummerZuLang(610001519),
EricGlobalIdnummerUngueltig(610001525),
EricGlobalNullParameter(610001526),
EricGlobalEwazUngueltig(610001527),
EricGlobalEwazLandeskuerzelUnbekannt(610001528),
EricGlobalUpdateNecessary(610001851),
EricGlobalEinstellungNameUngueltig(610001860),
EricGlobalEinstellungWertUngueltig(610001861),
EricGlobalErrDekodieren(610001862),
EricGlobalFunktionNichtUnterstuetzt(610001863),
EricGlobalNutzdatenticketsNichtEindeutig(610001865),
EricGlobalNutzdatenheaderversionenUneinheitlich(610001866),
EricGlobalBundeslaenderUneinheitlich(610001867),
EricGlobalZeitraeumeUneinheitlich(610001868),
EricGlobalNutzdatenheaderEmpfaengerNichtKorrekt(610001869),
EricTransferComError(610101200),
EricTransferVorgangNichtUnterstuetzt(610101201),
EricTransferErrXmlTheader(610101210),
EricTransferErrParam(610101251),
EricTransferErrDatenteilendnotfound(610101253),
EricTransferErrBegindatenlieferant(610101255),
EricTransferErrEnddatenlieferant(610101256),
EricTransferErrBegintransportschluessel(610101257),
EricTransferErrEndtransportschluessel(610101258),
EricTransferErrBegindatengroesse(610101259),
EricTransferErrEnddatengroesse(610101260),
EricTransferErrSend(610101271),
EricTransferErrNotencrypted(610101274),
EricTransferErrProxyconnect(610101276),
EricTransferErrConnectserver(610101278),
EricTransferErrNoresponse(610101279),
EricTransferErrProxyauth(610101280),
EricTransferErrSendInit(610101282),
EricTransferErrTimeout(610101283),
EricTransferErrProxyportInvalid(610101284),
EricTransferErrOther(610101291),
EricTransferErrXmlNheader(610101292),
EricTransferErrXmlEncoding(610101293),
EricTransferErrEndsiguser(610101294),
EricTransferErrXmltagNichtGefunden(610101295),
EricTransferErrDatenteilfehler(610101297),
EricTransferEidZertifikatfehler(610101500),
EricTransferEidKeinkonto(610101510),
EricTransferEidIdnrnichteindeutig(610101511),
EricTransferEidServerfehler(610101512),
EricTransferEidKeinclient(610101520),
EricTransferEidClientfehler(610101521),
EricTransferEidFehlendefelder(610101522),
EricTransferEidIdentifikationabgebrochen(610101523),
EricTransferEidNpablockiert(610101524),
EricCryptErrorCreateKey(610201016),
EricCryptEInvalidHandle(610201101),
EricCryptEMaxSession(610201102),
EricCryptEBusy(610201103),
EricCryptEOutOfMem(610201104),
EricCryptEPsePath(610201105),
EricCryptEPinWrong(610201106),
EricCryptEPinLocked(610201107),
EricCryptEP7Read(610201108),
EricCryptEP7Decode(610201109),
EricCryptEP7Recipient(610201110),
EricCryptEP12Read(610201111),
EricCryptEP12Decode(610201112),
EricCryptEP12SigKey(610201113),
EricCryptEP12EncKey(610201114),
EricCryptEP11SigKey(610201115),
EricCryptEP11EncKey(610201116),
EricCryptEXmlParse(610201117),
EricCryptEXmlSigAdd(610201118),
EricCryptEXmlSigTag(610201119),
EricCryptEXmlSigSign(610201120),
EricCryptEEncodeUnknown(610201121),
EricCryptEEncodeError(610201122),
EricCryptEXmlInit(610201123),
EricCryptEEncrypt(610201124),
EricCryptEDecrypt(610201125),
EricCryptEP11SlotEmpty(610201126),
EricCryptENoSigEncKey(610201127),
EricCryptELoadDll(610201128),
EricCryptENoService(610201129),
EricCryptEEsiclException(610201130),
EricCryptETokenTypeMismatch(610201144),
EricCryptEP12Create(610201146),
EricCryptEVerifyCertChain(610201147),
EricCryptEP11EngineLoaded(610201148),
EricCryptEUserCancel(610201149),
EricCryptZertifikat(610201200),
EricCryptSignatur(610201201),
EricCryptNichtUnterstuetztesPseFormat(610201203),
EricCryptPinBenoetigt(610201205),
EricCryptPinStaerkeNichtAusreichend(610201206),
EricCryptEIntern(610201208),
EricCryptZertifikatspfadKeinVerzeichnis(610201209),
EricCryptZertifikatsdateiExistiertBereits(610201210),
EricCryptPinEnthaeltUngueltigeZeichen(610201211),
EricCryptEInvalidParamAbc(610201212),
EricCryptCorrupted(610201213),
EricCryptEidkarteNichtUnterstuetzt(610201214),
EricCryptEScSlotEmpty(610201215),
EricCryptEScNoApplet(610201216),
EricCryptEScSession(610201217),
EricCryptEP11NoSigCert(610201218),
EricCryptEP11InitFailed(610201219),
EricCryptEP11NoEncCert(610201220),
EricCryptEP12NoSigCert(610201221),
EricCryptEP12NoEncCert(610201222),
EricCryptEScEncKey(610201223),
EricCryptEScNoSigCert(610201224),
EricCryptEScNoEncCert(610201225),
EricCryptEScInitFailed(610201226),
EricCryptEScSigKey(610201227),
EricIoFehler(610301001),
EricIoDateiInkorrekt(610301005),
EricIoParseFehler(610301006),
EricIoNdsGenerierungFehlgeschlagen(610301007),
EricIoMasterdatenserviceNichtVerfuegbar(610301010),
EricIoSteuerzeichenImNds(610301014),
EricIoVersionsinformationenNichtGefunden(610301031),
EricIoFalschesVerfahren(610301104),
EricIoReaderMehrfacheSteuerfaelle(610301105),
EricIoReaderUnerwarteteElemente(610301106),
EricIoReaderFormaleFehler(610301107),
EricIoReaderFalschesEncoding(610301108),
EricIoReaderMehrfacheNutzdatenElemente(610301109),
EricIoReaderMehrfacheNutzdatenblockElemente(610301110),
EricIoUnbekannteDatenart(610301111),
EricIoReaderUntersachbereichUngueltig(610301114),
EricIoReaderZuVieleNutzdatenblockElemente(610301115),
EricIoReaderSteuerzeichenImTransferheader(610301150),
EricIoReaderSteuerzeichenImNutzdatenheader(610301151),
EricIoReaderSteuerzeichenInDenNutzdaten(610301152),
EricIoReaderZuVieleAnhaenge(610301190),
EricIoReaderAnhangZuGross(610301191),
EricIoReaderAnhaengeZuGross(610301192),
EricIoReaderSchemaValidierungsfehler(610301200),
EricIoReaderUnbekannteXmlEntity(610301201),
EricIoDatenteilnotfound(610301252),
EricIoDatenteilendnotfound(610301253),
EricIoUebergabeparameterFehlerhaft(610301300),
EricIoUngueltigeUtF8Sequenz(610301400),
EricIoUngueltigeZeichenInParameter(610301401),
EricPrintInternerFehler(610501001),
EricPrintDruckvorlageNichtGefunden(610501002),
EricPrintUngueltigerDateiPfad(610501004),
EricPrintInitialisierungFehlerhaft(610501007),
EricPrintAusgabezielUnbekannt(610501008),
EricPrintAbbruchDruckvorbereitung(610501009),
EricPrintAbbruchGenerierung(610501010),
EricPrintSteuerfallNichtUnterstuetzt(610501011),
EricPrintFusstextZuLang(610501012),
}
/**
* Represents a structure that contains the first output of the ERiC tax data submission process.
*/
@Api(Description="Represents a structure that contains the first output of the ERiC tax data submission process.")
open class EricBearbeiteVorgang
{
/**
* Information from the successful processing a tax declaration.
*/
@ApiMember(Description="Information from the successful processing a tax declaration.")
var erfolg:Erfolg? = null
/**
* Gets or sets information on all data deliveries, including deliveries that have not been confirmed by the server.
*/
@ApiMember(Description="Gets or sets information on all data deliveries, including deliveries that have not been confirmed by the server.")
var transfers:Transfers? = null
/**
* Error rules that result from the processing of a tax declaration.
*/
@ApiMember(Description="Error rules that result from the processing of a tax declaration.")
var fehlerRegelpruefungen:ArrayList<FehlerRegelpruefung> = ArrayList<FehlerRegelpruefung>()
/**
* Hints that result the processing of a tax declaration.
*/
@ApiMember(Description="Hints that result the processing of a tax declaration.")
var hinweise:ArrayList<Hinweis> = ArrayList<Hinweis>()
}
/**
* Represents information returned from a successful tax declaration process.
*/
@Api(Description="Represents information returned from a successful tax declaration process.")
open class Erfolg
{
/**
* The generated tele-number for the successful tax declaration process.
*/
@ApiMember(Description="The generated tele-number for the successful tax declaration process.")
var telenummer:ArrayList<String> = ArrayList<String>()
/**
* The classification key for the successful tax declaration process.
*/
@ApiMember(Description="The classification key for the successful tax declaration process.")
var ordnungsbegriffe:ArrayList<String> = ArrayList<String>()
}
/**
* Represents information on all data deliveries, including deliveries that have not been confirmed by the server. For more information, see the ERiC developer manual in the 'TransferTicket' section.
*/
@Api(Description="Represents information on all data deliveries, including deliveries that have not been confirmed by the server. For more information, see the ERiC developer manual in the 'TransferTicket' section.")
open class Transfers
{
/**
* Contains information on all data deliveries, including deliveries that have not been confirmed by the server.
*/
@ApiMember(Description="Contains information on all data deliveries, including deliveries that have not been confirmed by the server.")
var transferList:ArrayList<Transfer> = ArrayList<Transfer>()
}
/**
* Represents information on the delivery.
*/
@Api(Description="Represents information on the delivery.")
open class Transfer
{
/**
* The ticket of the transfer.
*/
@ApiMember(Description="The ticket of the transfer.")
var transferTicket:String? = null
}
/**
* Represents information on an ERiC reference.
*/
@Api(Description="Represents information on an ERiC reference.")
open class FehlerRegelpruefung
{
/**
* The user data ticket of the reference.
*/
@ApiMember(Description="The user data ticket of the reference.")
var nutzdatenticket:String? = null
/**
* The field identifier of the reference.
*/
@ApiMember(Description="The field identifier of the reference.")
var feldidentifikator:String? = null
/**
* The multi-line index of the reference.
*/
@ApiMember(Description="The multi-line index of the reference.")
var mehrfachzeilenindex:String? = null
/**
* The delivery number form of the reference.
*/
@ApiMember(Description="The delivery number form of the reference.")
var lfdNrVordruck:String? = null
/**
* Indicates the line number of the error field mentioned in the form.
*/
@ApiMember(Description="Indicates the line number of the error field mentioned in the form.")
var vordruckZeilennummer:String? = null
/**
* Specifies the value of one or more index fields that identify the context of error messages.
*/
@ApiMember(Description="Specifies the value of one or more index fields that identify the context of error messages.")
var semantischeIndexes:ArrayList<SemantischerIndex> = ArrayList<SemantischerIndex>()
/**
* The sub-subject-area of the reference.
*/
@ApiMember(Description="The sub-subject-area of the reference.")
var untersachbereich:String? = null
/**
* The private identification number of the reference.
*/
@ApiMember(Description="The private identification number of the reference.")
var privateKennnummer:String? = null
/**
* The name of the rule that applies to the reference.
*/
@ApiMember(Description="The name of the rule that applies to the reference.")
var regelName:String? = null
/**
* The technical error identifier of the reference.
*/
@ApiMember(Description="The technical error identifier of the reference.")
var fachlicheFehlerId:String? = null
/**
* The textual details of the reference.
*/
@ApiMember(Description="The textual details of the reference.")
var text:String? = null
}
/**
* Represents value of an index field, which identfies the context about an error message.
*/
@Api(Description="Represents value of an index field, which identfies the context about an error message.")
open class SemantischerIndex
{
/**
* The name of the index field.
*/
@ApiMember(Description="The name of the index field.")
var name:String? = null
/**
* The value of the index field.
*/
@ApiMember(Description="The value of the index field.")
var value:String? = null
}
open class Hinweis
{
/**
* The user data ticket of the reference.
*/
@ApiMember(Description="The user data ticket of the reference.")
var nutzdatenticket:String? = null
/**
* The field identifier of the reference.
*/
@ApiMember(Description="The field identifier of the reference.")
var feldidentifikator:String? = null
/**
* The multi-line index of the reference.
*/
@ApiMember(Description="The multi-line index of the reference.")
var mehrfachzeilenindex:String? = null
/**
* The delivery number form of the reference.
*/
@ApiMember(Description="The delivery number form of the reference.")
var lfdNrVordruck:String? = null
/**
* Indicates the line number of the error field mentioned in the form.
*/
@ApiMember(Description="Indicates the line number of the error field mentioned in the form.")
var vordruckZeilennummer:String? = null
/**
* Specifies the value of one or more index fields that identify the context of error messages.
*/
@ApiMember(Description="Specifies the value of one or more index fields that identify the context of error messages.")
var semantischeIndexes:ArrayList<SemantischerIndex> = ArrayList<SemantischerIndex>()
/**
* The sub-subject-area of the reference.
*/
@ApiMember(Description="The sub-subject-area of the reference.")
var untersachbereich:String? = null
/**
* The private identification number of the reference.
*/
@ApiMember(Description="The private identification number of the reference.")
var privateKennnummer:String? = null
/**
* The name of the rule that applies to the reference.
*/
@ApiMember(Description="The name of the rule that applies to the reference.")
var regelName:String? = null
/**
* The technical note identifier of the reference.
*/
@ApiMember(Description="The technical note identifier of the reference.")
var fachlicheHinweisId:String? = null
/**
* The textual details of the reference.
*/
@ApiMember(Description="The textual details of the reference.")
var text:String? = null
}
/**
* Represents an ELSTER document.
*/
@Api(Description="Represents an ELSTER document.")
open class Elster
{
/**
* The transfer header part of the ELSTER document.
*/
@ApiMember(Description="The transfer header part of the ELSTER document.", IsRequired=true)
var transferHeader:TransferHeader? = null
/**
* The data (facts) part of the ELSTER document.
*/
@ApiMember(Description="The data (facts) part of the ELSTER document.")
var datenTeil:DatenTeil? = null
}
/**
* Represents the transfer header part of an ELSTER document.
*/
@Api(Description="Represents the transfer header part of an ELSTER document.")
open class TransferHeader
{
/**
* The version of the transfer header.
*/
@ApiMember(Description="The version of the transfer header.", IsRequired=true)
var version:String? = null
/**
* The tax operation used in the ELSTER process.
*/
@ApiMember(Description="The tax operation used in the ELSTER process.", IsRequired=true)
var verfahren:Verfahren? = null
/**
* The tax data type of the ELSTER process.
*/
@ApiMember(Description="The tax data type of the ELSTER process.", IsRequired=true)
var datenArt:Datenart? = null
/**
* The authentification procedure of the ELSTER process.
*/
@ApiMember(Description="The authentification procedure of the ELSTER process.", IsRequired=true)
var vorgang:Vorgang? = null
/**
* The ticket identifier after a successful ELSTER process.
*/
@ApiMember(Description="The ticket identifier after a successful ELSTER process.")
var transferTicket:String? = null
/**
* The flag that indicates whether the tax declaration or filing is a test case. For production purposes, this value should not be set.
*/
@ApiMember(Description="The flag that indicates whether the tax declaration or filing is a test case. For production purposes, this value should not be set.")
var testmerker:Testmerker? = null
/**
* The signature and associated information on the compressed, encrypted, base64-encoded content of the the data part of a tax declaration / statement.
*/
@ApiMember(Description="The signature and associated information on the compressed, encrypted, base64-encoded content of the the data part of a tax declaration / statement.")
var sigUser:SigUser? = null
/**
* The receiving ELSTER server.
*/
@ApiMember(Description="The receiving ELSTER server.")
var empfaenger:Empfaenger? = null
/**
* The identifier of the software manufacturer, through whose software the tax declaration is filed.
*/
@ApiMember(Description="The identifier of the software manufacturer, through whose software the tax declaration is filed.", IsRequired=true)
var herstellerID:String? = null
/**
* The details of the provider that submits tax data.
*/
@ApiMember(Description="The details of the provider that submits tax data.", IsRequired=true)
var datenLieferant:String? = null
/**
* The date of receipt of the tax data.
*/
@ApiMember(Description="The date of receipt of the tax data.")
var eingangsDatum:Date? = null
/**
* The encryption data required for authenticated transmission of tax data.
*/
@ApiMember(Description="The encryption data required for authenticated transmission of tax data.")
var datei:Datei? = null
/**
* The return code of the transfer header and is included in the response XML of the ELSTER server. The value should never be set by the data provider.
*/
@ApiMember(Description="The return code of the transfer header and is included in the response XML of the ELSTER server. The value should never be set by the data provider.")
var rc:RC? = null
/**
* The details of the software that submits the tax data.
*/
@ApiMember(Description="The details of the software that submits the tax data.")
var versionClient:String? = null
/**
* Data extensions to the transfer header.
*/
@ApiMember(Description="Data extensions to the transfer header.")
var zusatz:Zusatz? = null
}
/**
* Auflistung der gültigen Verfahren
*/
enum class Verfahren
{
ElsterAnmeldung,
ElsterBereitstellung,
ElsterBilanz,
ElsterBRM,
ElsterBRMOrg,
ElsterDatenabholung,
ElsterErklaerung,
ElsterExtern,
ElsterFSE,
ElsterKapESt,
ElsterKMV,
ElsterKontoabfrage,
ElsterLavendel,
ElsterLohn,
ElsterLohn2,
ElsterNachricht,
ElsterSignatur,
ElsterVollmachtDB,
}
/**
* Auflistung aller gültigen Datenarten.
*/
enum class Datenart
{
Anlage34a,
AnpassungVorauszahlung,
AntragUStVerguetung4a,
AbrufcodeAntrag,
AenderungAdresse,
AbrufcodeStorno,
AbrufvollmachtAnlage,
AbrufvollmachtUpdate,
AenderungBankverbindung,
AntraegeRechteLoeschen,
AntraegeUndRechte,
Aufzeichnung146a,
BetPG,
Bilanz,
Belegnachreichung,
BsbMitteilung,
BzSt2,
C19Mitteilung,
DUeAbmelden,
DUeAnmelden,
DUeUmmelden,
Einspruch,
EinspruchNachtrag,
EinspruchRuecknahme,
ELeVAntragELStAM,
ELeVErmaessigung,
ELeVGetrenntlebend,
ELeVSteuerklassenwechsel,
ELeVWiederaufnahmeEhe,
EpAntwort,
EpBescheid,
EpMitteilung,
EpKurzmitteilung,
ElsterErklaerungDaten,
ElsterKMVDaten,
ElsterLohn2Daten,
ElsterLohnDaten,
ElsterVaStDaten,
ElsterDIVADaten,
ElsterDIVDaten,
ElsterEPBescheidDaten,
ElsterEPMitteilungDaten,
EpStBescheidAbholung,
EpStMitteilungAbholung,
Erbschaftsteuer,
ESt,
EStbeschraenkt,
Euer,
EUn,
Fein,
ForschungZulAntrag,
KStAntragOptionPersG,
FlhMitteilung,
FreistellungKapitalertraegeBV,
Fristverlaengerung,
FsEVerein,
Gewerbemeldung,
GdbMitteilung,
Gewinnermittlung13aEStG,
GewSt,
GewStZ,
GrundsteuerBW,
GrundsteuerBY,
GrundsteuerHE,
GrundsteuerHH,
GrundsteuerNI,
Grundsteuerwert,
InvStG56Abs5,
InvStG51Feststellung,
KapEStA,
KapEStInvStG,
KapG,
KapGAus,
KkvMitteilung,
Kontoabfrage,
Kontoinformation,
KSt,
KStZ,
KttAnmeldungHH,
KttAnzeigeHH,
Lohnersatzleistung,
LohnersatzMitteilung,
LStA,
LStB,
LStHVVMAnlage,
LStHVVMUpdate,
OghMitteilung,
VermoegenswirksameLeistung,
VmWiderruf,
VollmachtDetails,
VNoVMVRegistrierung,
VNoVMVUpdate,
VNoVMVLoeschung,
VollfAAnlage,
VollfAUpdate,
VMoVMVStBAnlage,
VMoVMVStBUpdate,
VMoVMVFreischaltung,
VagMitteilung,
DivaDatenBZSt,
DivaEinwilligungAnlageBRM,
DivaEinwilligungFreisch,
DivaEinwilligungUpdateBRM,
DivaWiderrufBRM,
DivaErgebnisliste,
LStHVDivaAdresseBRM,
VmErgebnisListeVNSicht,
PersG,
PostfachAnfrage,
PostfachStatus,
ProtokollAnforderung,
Registrierung,
Schenkungsteuer,
SonstigeNachrichten,
SpezRechtAntrag,
SpezRechtFreischaltung,
SpezRechtListe,
SpezRechtStorno,
SpezRechtTeilnahme,
StAb50a,
Statusabfrage,
UnentgeltlicheDepotuebertragung,
UenstAnmeldungBE,
UenstAnzeigeBE,
USt,
UStVA,
UStDV,
UStSV,
VgnAnmeldungHB,
VgnAnmeldungBE,
VgnAnmeldungHH,
VgnAnzeigeHH,
WtbAnmeldungHB,
Zmdo,
ElsterVollmachtDaten,
MitteilungAbholung,
}
/**
* Hauptinformation ob die Daten authentifiziert wurden (send-Auth) oder nicht (send-NoSig)
*/
enum class Vorgang
{
SendAuth,
SendAuthPart,
SendNoSig,
SendNoSigPart,
}
/**
* Kennzeichnung der Datenlieferung ob es sich um einen Testfall handelt, gilt fuer die gesamte Datenlieferung. Ein Echtfall enthält dieses Element nicht. Ein Testfall muss mit einem Testmerker versehen werden, damit er nicht wie ein Echtfall verarbeitet wird. Handelt es sich um Daten, die nur zum Testen des Frontends versendet wurden, müssen sie nicht mehr weiter verarbeitet werden.
*/
enum class Testmerker(val value:Int)
{
TM010000001(10000001),
TM080000001(80000001),
TM160000001(160000001),
TM160000002(160000002),
TM220000000(220000000),
TM220002000(220002000),
TM230000001(230000001),
TM240000000(240000000),
TM370000001(370000001),
TM520000000(520000000),
TM700000001(700000001),
TM700000004(700000004),
}
/**
* Represents the signature and associated information of the compressed, encrypted, base64-encoded content of the data part of the tax declaration/statement.
*/
@Api(Description="Represents the signature and associated information of the compressed, encrypted, base64-encoded content of the data part of the tax declaration/statement.")
open class SigUser
{
/**
* The content of the data. Currently supported: Raw XML (text), XElement or IXmlSerializable
*/
@ApiMember(Description="The content of the data. Currently supported: Raw XML (text), XElement or IXmlSerializable")
var inhalt:Object? = null
}
/**
* Represents a receiver of tax data.
*/
@Api(Description="Represents a receiver of tax data.")
open class Empfaenger
{
/**
* The identifier of the receiver.
*/
@ApiMember(Description="The identifier of the receiver.")
var id:String? = null
/**
* The destination of the receiver.
*/
@ApiMember(Description="The destination of the receiver.")
var ziel:Bundesland? = null
}
/**
* Einheitliche Abkürzungen fuer die Bundesländer bzw. alternative Empfänger
*/
enum class Bundesland
{
Bw,
By,
Be,
Bb,
Hb,
Hh,
He,
Mv,
Ni,
Nw,
Rp,
Sl,
Sn,
St,
Sh,
Th,
Ec,
Bf,
Cs,
Cd,
Cm,
Cn,
Ds,
Op,
Tk,
Zf,
}
/**
* Represents information on the encryption of tax data.
*/
@Api(Description="Represents information on the encryption of tax data.")
open class Datei
{
/**
* The type of data encryption used.
*/
@ApiMember(Description="The type of data encryption used.")
var verschluesselung:Verschluesselungsart? = null
/**
* The type of data compression used.
*/
@ApiMember(Description="The type of data compression used.")
var kompression:Kompression? = null
/**
* The transport key used in the encryption.
*/
@ApiMember(Description="The transport key used in the encryption.")
var transportSchluessel:String? = null
/**
* [Documentation unavailable]
*/
@ApiMember(Description="[Documentation unavailable]")
var erstellung:Erstellung? = null
}
/**
* Protokoll der Verschluesselung. Es kann vorkommen, dass verschieden Verschluesselungsarten eingesetzt werden, eine Unterscheidung ist hier nötig, um das richtige Entschluesselungstool anzusteuern. Mit welcher Verschluesselungsart wurden die Inhalte von den Elementen 'DatenLieferant' und ggf. 'SigUser' im TransferHeader und dem Element 'DatenTeil' verschluesselt
*/
enum class Verschluesselungsart
{
Pkcs7v15,
Pkcs7v15enveloped,
NoBasE64,
CmsEncryptedData,
CmsEnvelopedData,
EnvelopedDataRsaOaepAes128GZipB64,
}
/**
* Mit welcher Kompression wurden die Inhalte von den Elementen DatenLieferant und ggf. SigUser im TransferHeader und dem Element DatenTeil komprimiert.
*/
enum class Kompression
{
Gzip,
NoBasE64,
}
/**
* [Documentation unavailable]
*/
@Api(Description="[Documentation unavailable]")
open class Erstellung
{
/**
* [Documentation unavailable]
*/
@ApiMember(Description="[Documentation unavailable]")
var eric:EricTyp? = null
}
/**
* [Documentation unavailable]
*/
@Api(Description="[Documentation unavailable]")
open class EricTyp
{
/**
* The content of the data. Currently supported: Raw XML (text), XmlElement, XElement or IXmlSerializable
*/
@ApiMember(Description="The content of the data. Currently supported: Raw XML (text), XmlElement, XElement or IXmlSerializable")
var inhalt:Object? = null
}
/**
* Represents an ERiC return code.
*/
@Api(Description="Represents an ERiC return code.")
open class RC
{
/**
* The return value of the return code.
*/
@ApiMember(Description="The return value of the return code.")
var rueckgabe:Rueckgabe? = null
/**
* The internal value of the return code.
*/
@ApiMember(Description="The internal value of the return code.")
var stack:Stack? = null
}
/**
* Represents an external error stack.
*/
@Api(Description="Represents an external error stack.")
open class Rueckgabe
{
/**
* The external error code. Either a zero (0) if no external errors occurred; otherwise an error number.
*/
@ApiMember(Description="The external error code. Either a zero (0) if no external errors occurred; otherwise an error number.")
var code:String? = null
/**
* The external error message.
*/
@ApiMember(Description="The external error message.")
var text:String? = null
}
/**
* Represents an internal error stack.
*/
@Api(Description="Represents an internal error stack.")
open class Stack
{
/**
* The internal error code. Either a zero (0) if no internal errors occurred; otherwise an error number.
*/
@ApiMember(Description="The internal error code. Either a zero (0) if no internal errors occurred; otherwise an error number.")
var code:String? = null
/**
* The external error message.
*/
@ApiMember(Description="The external error message.")
var text:String? = null
}
/**
* Represents an ERiC extension.
*/
@Api(Description="Represents an ERiC extension.")
open class Zusatz
{
/**
* The user-customizable items for the extension. Data providers can use these items for their own extensions/information.
*/
@ApiMember(Description="The user-customizable items for the extension. Data providers can use these items for their own extensions/information.")
var infos:ArrayList<String> = ArrayList<String>()
/**
* The ELSTER items for the extension. They can be included in the response XML from the ELSTER server, if special information must be returned to the user after data submission. For example, for authenticated submission, information about impending certificate expiration etc. It must not be supplied by the data provider (even when empty).
*/
@ApiMember(Description="The ELSTER items for the extension. They can be included in the response XML from the ELSTER server, if special information must be returned to the user after data submission. For example, for authenticated submission, information about impending certificate expiration etc. It must not be supplied by the data provider (even when empty).")
var elsterInfos:ArrayList<String> = ArrayList<String>()
}
/**
* Represents the data part of an ELSTER document.
*/
@Api(Description="Represents the data part of an ELSTER document.")
open class DatenTeil
{
/**
* The blocks of tax data of the ELSTER document.
*/
@ApiMember(Description="The blocks of tax data of the ELSTER document.", IsRequired=true)
var nutzdatenbloecke:ArrayList<Nutzdatenblock> = ArrayList<Nutzdatenblock>()
}
/**
* Represents a block of tax data.
*/
@Api(Description="Represents a block of tax data.")
open class Nutzdatenblock
{
/**
* The header part of the block.
*/
@ApiMember(Description="The header part of the block.", IsRequired=true)
var nutzdatenHeader:NutzdatenHeader? = null
/**
* The data part of the block.
*/
@ApiMember(Description="The data part of the block.", IsRequired=true)
var nutzdaten:Nutzdaten? = null
}
/**
* Represents the header of a tax data.
*/
@Api(Description="Represents the header of a tax data.")
open class NutzdatenHeader
{
/**
* The version of the header.
*/
@ApiMember(Description="The version of the header.", IsRequired=true)
var version:String? = null
/**
* The ticket identifier of the header.
*/
@ApiMember(Description="The ticket identifier of the header.", IsRequired=true)
var nutzdatenTicket:String? = null
/**
* The receiver of the header.
*/
@ApiMember(Description="The receiver of the header.", IsRequired=true)
var empfaenger:NDHEmpfaenger? = null
/**
* The software manufacturer, through whose software the tax declaration or filing is submitted.
*/
@ApiMember(Description="The software manufacturer, through whose software the tax declaration or filing is submitted.", IsRequired=true)
var hersteller:Hersteller? = null
/**
* The details of the data provider (e.g. taxpayer, tax consulant or firm), who produced the tax data and it must not necessarily be the same person declared in the TransferHeader section.
*/
@ApiMember(Description="The details of the data provider (e.g. taxpayer, tax consulant or firm), who produced the tax data and it must not necessarily be the same person declared in the TransferHeader section.")
var datenLieferant:String? = null
/**
* The return code of the header.
*/
@ApiMember(Description="The return code of the header.")
var rc:RC? = null
/**
* The data extensions of the header.
*/
@ApiMember(Description="The data extensions of the header.")
var zusatz:Zusatz? = null
}
/**
* Represents a receiver of tax data.
*/
@Api(Description="Represents a receiver of tax data.")
open class NDHEmpfaenger
{
/**
* The identifier of the receiver.
*/
@ApiMember(Description="The identifier of the receiver.")
var id:EmpfaengerID? = null
/**
* The value of the receiver.
*/
@ApiMember(Description="The value of the receiver.")
var value:String? = null
}
/**
* Represents a receriver ID
*/
enum class EmpfaengerID
{
L,
F,
}
/**
* Represents a manufacturer/vendor of tax software.
*/
@Api(Description="Represents a manufacturer/vendor of tax software.")
open class Hersteller
{
/**
* The product name of the tax software produced by the manufacturer.
*/
@ApiMember(Description="The product name of the tax software produced by the manufacturer.")
var produktName:String? = null
/**
* The product version of the tax software produced by the manufacturer.
*/
@ApiMember(Description="The product version of the tax software produced by the manufacturer.")
var produktVersion:String? = null
}
/**
* Represents an encapsulation of tax data content.
*/
@Api(Description="Represents an encapsulation of tax data content.")
open class Nutzdaten
{
/**
* The content of the tax data. This varies by tax declaration. Currently supported formats: Raw XML (text), XElement, and IXmlSerializable
*/
@ApiMember(Description="The content of the tax data. This varies by tax declaration. Currently supported formats: Raw XML (text), XElement, and IXmlSerializable", IsRequired=true)
var inhalt:Object? = null
}
/**
* Represents a file that contains raw data content in bytes
*/
@Api(Description="Represents a file that contains raw data content in bytes")
open class BinaryFile : FileBase()
{
/**
* The attributes of the file.
*/
@ApiMember(Description="The attributes of the file.", Name="Metadata")
var metadata:FileMetadata? = null
/**
* The name of the file without information on its directory path.
*/
@ApiMember(Description="The name of the file without information on its directory path.", Name="Name")
var name:String? = null
/**
* The raw data content of the file.
*/
@ApiMember(Description="The raw data content of the file.", Name="Content")
var content:ByteArray? = null
}
/**
* Represents a base class for a file with raw data.
*/
@Api(Description="Represents a base class for a file with raw data.")
open class FileBase
{
/**
* The raw data content of the file.
*/
@ApiMember(Description="The raw data content of the file.", Name="Content")
var content:ByteArray? = null
}
/**
* Represents information about a file or directory.
*/
@Api(Description="Represents information about a file or directory.")
open class FileMetadata : IFileMetadata
{
/**
* The name of the file.For files, gets the name of the file.For directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.
*/
@ApiMember(Description="The name of the file.\nFor files, gets the name of the file.\nFor directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.", Name="Name")
var name:String? = null
/**
* The full path of the directory or file.
*/
@ApiMember(Description="The full path of the directory or file.", Name="FullName")
var fullName:String? = null
/**
* The time the current file or directory was last accessed.
*/
@ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")
var lastAccessTime:Date? = null
/**
* The name of the file.
*/
@ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")
var lastAccessTimeUtc:Date? = null
/**
* The time when the current file or directory was last written to.
*/
@ApiMember(Description="The time when the current file or directory was last written to.", Name="LastAccessTime")
var lastWriteTime:Date? = null
/**
* The time, in coordinated universal time (UTC), when the current file or directory was last written to.
*/
@ApiMember(Description="The time, in coordinated universal time (UTC), when the current file or directory was last written to.", Name="LastWriteTimeUtc")
var lastWriteTimeUtc:Date? = null
/**
* The size, in bytes, of the current file.
*/
@ApiMember(Description="The size, in bytes, of the current file.", Name="Length")
var length:Long? = null
/**
* The size, in bytes, of the current file.
*/
@ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")
var userId:Int? = null
/**
* The file group id.
*/
@ApiMember(Description="The file group id.", Name="GroupId")
var groupId:Int? = null
/**
* A value that indicates whether the others can read from this file.
*/
@ApiMember(Description="A value that indicates whether the others can read from this file.", Name="OthersCanRead")
var othersCanRead:Boolean? = null
/**
* A value that indicates whether the group members can execute this file.
*/
@ApiMember(Description="A value that indicates whether the group members can execute this file.", Name="GroupCanExecute")
var groupCanExecute:Boolean? = null
/**
* A value that indicates whether the group members can write into this file.
*/
@ApiMember(Description="A value that indicates whether the group members can write into this file.", Name="GroupCanWrite")
var groupCanWrite:Boolean? = null
/**
* A value that indicates whether the group members can read from this file.
*/
@ApiMember(Description="A value that indicates whether the group members can read from this file.", Name="GroupCanRead")
var groupCanRead:Boolean? = null
/**
* A value that indicates whether the owner can execute this file.
*/
@ApiMember(Description="A value that indicates whether the owner can execute this file.", Name="OwnerCanExecute")
var ownerCanExecute:Boolean? = null
/**
* A value that indicates whether the owner can write into this file.
*/
@ApiMember(Description="A value that indicates whether the owner can write into this file.", Name="OwnerCanWrite")
var ownerCanWrite:Boolean? = null
/**
* A value that indicates whether the owner can read from this file.
*/
@ApiMember(Description="A value that indicates whether the owner can read from this file.", Name="OthersCanRead")
var ownerCanRead:Boolean? = null
/**
* A value that indicates whether others can read from this file.
*/
@ApiMember(Description="A value that indicates whether others can read from this file.", Name="OthersCanExecute")
var othersCanExecute:Boolean? = null
/**
* A value that indicates whether others can write into this file.
*/
@ApiMember(Description="A value that indicates whether others can write into this file.", Name="OthersCanWrite")
var othersCanWrite:Boolean? = null
/**
* Extensions to the file attributes.
*/
@ApiMember(Description="Extensions to the file attributes.", Name="Extensions")
var extensions:HashMap<String,String> = HashMap<String,String>()
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ValidiereAsync HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"data":{"id":"String","content":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"rueckgabe":{"erfolg":{"telenummer":["String"],"ordnungsbegriffe":["String"]},"transfers":{"transferList":[{"transferTicket":"String"}]},"fehlerRegelpruefungen":[{"nutzdatenticket":"String","feldidentifikator":"String","mehrfachzeilenindex":"String","lfdNrVordruck":"String","vordruckZeilennummer":"String","semantischeIndexes":[{"name":"String","value":"String"}],"untersachbereich":"String","privateKennnummer":"String","regelName":"String","fachlicheFehlerId":"String","text":"String"}],"hinweise":[{"nutzdatenticket":"String","feldidentifikator":"String","mehrfachzeilenindex":"String","lfdNrVordruck":"String","vordruckZeilennummer":"String","semantischeIndexes":[{"name":"String","value":"String"}],"untersachbereich":"String","privateKennnummer":"String","regelName":"String","fachlicheHinweisId":"String","text":"String"}]},"serverantwort":{"transferHeader":{"version":"String","verfahren":"ElsterAnmeldung","datenArt":"34a","vorgang":"send-Auth","transferTicket":"String","testmerker":"0","sigUser":{"inhalt":{}},"empfaenger":{"id":"String","ziel":"BW"},"herstellerID":"String","datenLieferant":"String","eingangsDatum":"\/Date(-62135596800000-0000)\/","datei":{"verschluesselung":"PKCS#7v1.5","kompression":"GZIP","transportSchluessel":"String","erstellung":{"eric":{"inhalt":{}}}},"rc":{"rueckgabe":{"code":"String","text":"String"},"stack":{"code":"String","text":"String"}},"versionClient":"String","zusatz":{"infos":["String"],"elsterInfos":["String"]}},"datenTeil":{"nutzdatenbloecke":[{"nutzdatenHeader":{"version":"String","nutzdatenTicket":"String","empfaenger":{"id":"L","value":"String"},"hersteller":{"produktName":"String","produktVersion":"String"},"datenLieferant":"String","rc":{"rueckgabe":{"code":"String","text":"String"},"stack":{"code":"String","text":"String"}},"zusatz":{"infos":["String"],"elsterInfos":["String"]}},"nutzdaten":{"inhalt":{}}}]}},"transferProtocols":[{"metadata":{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","length":0,"userId":0,"groupId":0,"othersCanRead":false,"groupCanExecute":false,"groupCanWrite":false,"groupCanRead":false,"ownerCanExecute":false,"ownerCanWrite":false,"ownerCanRead":false,"othersCanExecute":false,"othersCanWrite":false,"extensions":{"String":"String"}},"name":"String","content":"AA=="}],"statusCode":"ERIC_OK","statusText":"String","id":"String","index":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}