Tax Filing Service
| POST | /async/datenabholungen/abholungen/17/PostfachAnfrage |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* Represents the service request to retrive meta information per data group and per tax type for an account or fingerprint.
*/
@Api(Description="Represents the service request to retrive meta information per data group and per tax type for an account or fingerprint.")
public static class PostfachAnfrageAbholungRequest17Async extends PostfachAnfrageAbholungRequestBase17
{
/**
* The search criteria of the service request.
*/
@ApiMember(Description="The search criteria of the service request.")
public ArrayList<AbholungSuchkriterien> suchkriterien = null;
/**
* The name of the request data group (tax type).
*/
@ApiMember(Description="The name of the request data group (tax type).")
public Datenart datenart = null;
/**
* The authentification certificate.
*/
@ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public PortalCertificate zertifikat = null;
/**
* The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.
*/
@ApiMember(Description="The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
public String abrufCode = null;
/**
* The details of the provider that submits the tax data.
*/
@ApiMember(Description="The details of the provider that submits the tax data.", IsRequired=true, Name="DatenLieferant")
public String datenLieferant = null;
public ArrayList<AbholungSuchkriterien> getSuchkriterien() { return suchkriterien; }
public PostfachAnfrageAbholungRequest17Async setSuchkriterien(ArrayList<AbholungSuchkriterien> value) { this.suchkriterien = value; return this; }
public Datenart getDatenart() { return datenart; }
public PostfachAnfrageAbholungRequest17Async setDatenart(Datenart value) { this.datenart = value; return this; }
public PortalCertificate getZertifikat() { return zertifikat; }
public PostfachAnfrageAbholungRequest17Async setZertifikat(PortalCertificate value) { this.zertifikat = value; return this; }
public String getAbrufCode() { return abrufCode; }
public PostfachAnfrageAbholungRequest17Async setAbrufCode(String value) { this.abrufCode = value; return this; }
public String getDatenLieferant() { return datenLieferant; }
public PostfachAnfrageAbholungRequest17Async setDatenLieferant(String value) { this.datenLieferant = value; return this; }
}
/**
* Specifies the base service request to retrieve data records for one or more IDs that represent meta information per data group and type for a user account or fingerprint.
*/
@Api(Description="Specifies the base service request to retrieve data records for one or more IDs that represent meta information per data group and type for a user account or fingerprint.")
public static class PostfachAnfrageAbholungRequestBase17 extends AbholungRequestBase17
{
/**
* The search criteria of the service request.
*/
@ApiMember(Description="The search criteria of the service request.")
public ArrayList<AbholungSuchkriterien> suchkriterien = null;
/**
* The name of the request data group (tax type).
*/
@ApiMember(Description="The name of the request data group (tax type).")
public Datenart datenart = null;
/**
* The authentification certificate.
*/
@ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public PortalCertificate zertifikat = null;
/**
* The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.
*/
@ApiMember(Description="The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
public String abrufCode = null;
/**
* The details of the provider that submits the tax data.
*/
@ApiMember(Description="The details of the provider that submits the tax data.", IsRequired=true, Name="DatenLieferant")
public String datenLieferant = null;
public ArrayList<AbholungSuchkriterien> getSuchkriterien() { return suchkriterien; }
public PostfachAnfrageAbholungRequestBase17 setSuchkriterien(ArrayList<AbholungSuchkriterien> value) { this.suchkriterien = value; return this; }
public Datenart getDatenart() { return datenart; }
public PostfachAnfrageAbholungRequestBase17 setDatenart(Datenart value) { this.datenart = value; return this; }
public PortalCertificate getZertifikat() { return zertifikat; }
public PostfachAnfrageAbholungRequestBase17 setZertifikat(PortalCertificate value) { this.zertifikat = value; return this; }
public String getAbrufCode() { return abrufCode; }
public PostfachAnfrageAbholungRequestBase17 setAbrufCode(String value) { this.abrufCode = value; return this; }
public String getDatenLieferant() { return datenLieferant; }
public PostfachAnfrageAbholungRequestBase17 setDatenLieferant(String value) { this.datenLieferant = value; return this; }
}
/**
* Specifies the retrieval of data records by using provided data list IDs. Applicable for data retrieval operations v17.
*/
@Api(Description="Specifies the retrieval of data records by using provided data list IDs. Applicable for data retrieval operations v17.")
public static class AbholungRequestBase17 extends AbholungRequestBase
{
/**
* The authentification certificate.
*/
@ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public PortalCertificate zertifikat = null;
/**
* The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.
*/
@ApiMember(Description="The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
public String abrufCode = null;
/**
* The details of the provider that submits the tax data.
*/
@ApiMember(Description="The details of the provider that submits the tax data.", IsRequired=true, Name="DatenLieferant")
public String datenLieferant = null;
public PortalCertificate getZertifikat() { return zertifikat; }
public AbholungRequestBase17 setZertifikat(PortalCertificate value) { this.zertifikat = value; return this; }
public String getAbrufCode() { return abrufCode; }
public AbholungRequestBase17 setAbrufCode(String value) { this.abrufCode = value; return this; }
public String getDatenLieferant() { return datenLieferant; }
public AbholungRequestBase17 setDatenLieferant(String value) { this.datenLieferant = value; return this; }
}
/**
* Specifies the retrieval of data records by using provided data list IDs.
*/
@Api(Description="Specifies the retrieval of data records by using provided data list IDs.")
public static class AbholungRequestBase extends PhaseRequestBase implements IPost
{
/**
* The authentification certificate.
*/
@ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public PortalCertificate zertifikat = null;
/**
* The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.
*/
@ApiMember(Description="The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
public String abrufCode = null;
/**
* The details of the provider that submits the tax data.
*/
@ApiMember(Description="The details of the provider that submits the tax data.", IsRequired=true, Name="DatenLieferant")
public String datenLieferant = null;
public PortalCertificate getZertifikat() { return zertifikat; }
public AbholungRequestBase setZertifikat(PortalCertificate value) { this.zertifikat = value; return this; }
public String getAbrufCode() { return abrufCode; }
public AbholungRequestBase setAbrufCode(String value) { this.abrufCode = value; return this; }
public String getDatenLieferant() { return datenLieferant; }
public AbholungRequestBase setDatenLieferant(String value) { this.datenLieferant = value; return this; }
}
/**
* Specifies the base service request to submit data a retrieval request.
*/
@Api(Description="Specifies the base service request to submit data a retrieval request.")
public static class PhaseRequestBase implements ISendeRequest, IVeschlueselungsRequest
{
/**
* The authentification certificate.
*/
@ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public PortalCertificate zertifikat = null;
/**
* The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.
*/
@ApiMember(Description="The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
public String abrufCode = null;
/**
* The details of the provider that submits the tax data.
*/
@ApiMember(Description="The details of the provider that submits the tax data.", IsRequired=true, Name="DatenLieferant")
public String datenLieferant = null;
public PortalCertificate getZertifikat() { return zertifikat; }
public PhaseRequestBase setZertifikat(PortalCertificate value) { this.zertifikat = value; return this; }
public String getAbrufCode() { return abrufCode; }
public PhaseRequestBase setAbrufCode(String value) { this.abrufCode = value; return this; }
public String getDatenLieferant() { return datenLieferant; }
public PhaseRequestBase setDatenLieferant(String value) { this.datenLieferant = value; return this; }
}
/**
* Represents a portal certificate that is protected by a password.
*/
@Api(Description="Represents a portal certificate that is protected by a password.")
public static class PortalCertificate extends FileBase implements ISecuredCertificate, IHasIndex
{
/**
* The unique identifier of the certificate.
*/
@ApiMember(Description="The unique identifier of the certificate.")
public UUID id = null;
/**
* The position of the certificate element in an indexed collection of certificates.
*/
@ApiMember(Description="The position of the certificate element in an indexed collection of certificates.")
public Integer index = null;
/**
* The password to protect the certificate from unauthorized access.
*/
@StringLength(255)
@ApiMember(Description="The password to protect the certificate from unauthorized access.")
public String pin = null;
/**
* The description of the certificate.
*/
@StringLength(2147483647)
@ApiMember(Description="The description of the certificate.")
public String description = null;
/**
* Tags that can be used to label or identify the certificate.
*/
@ApiMember(Description="Tags that can be used to label or identify the certificate.")
public ArrayList<String> tags = null;
/**
* Gets or sets the file name of the certificate.
*/
@ApiMember(Description="Gets or sets the file name of the certificate.")
public String name = null;
/**
* The raw data content of the file.
*/
@ApiMember(Description="The raw data content of the file.", Name="Content")
public byte[] content = null;
public UUID getId() { return id; }
public PortalCertificate setId(UUID value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public PortalCertificate setIndex(Integer value) { this.index = value; return this; }
public String getPin() { return pin; }
public PortalCertificate setPin(String value) { this.pin = value; return this; }
public String getDescription() { return description; }
public PortalCertificate setDescription(String value) { this.description = value; return this; }
public ArrayList<String> getTags() { return tags; }
public PortalCertificate setTags(ArrayList<String> value) { this.tags = value; return this; }
public String getName() { return name; }
public PortalCertificate setName(String value) { this.name = value; return this; }
public byte[] getContent() { return content; }
public PortalCertificate setContent(byte[] value) { this.content = value; return this; }
}
/**
* Represents a base class for a file with raw data.
*/
@Api(Description="Represents a base class for a file with raw data.")
public static class FileBase
{
/**
* The raw data content of the file.
*/
@ApiMember(Description="The raw data content of the file.", Name="Content")
public byte[] content = null;
public byte[] getContent() { return content; }
public FileBase setContent(byte[] value) { this.content = value; return this; }
}
/**
* Specifies the base request criteria to search for tax statements using data record IDs obtained from a request for meta information.
*/
@Api(Description="Specifies the base request criteria to search for tax statements using data record IDs obtained from a request for meta information.")
public static class AbholungSuchkriterien
{
/**
* Any of the data record IDs returned from a request for meta information.
*/
@ApiMember(Description="Any of the data record IDs returned from a request for meta information.", Name="Id")
public String id = null;
public String getId() { return id; }
public AbholungSuchkriterien setId(String value) { this.id = value; return this; }
}
/**
* Auflistung aller gültigen Datenarten.
*/
public static enum 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;
}
/**
* Represents a server response that encapsulates data records (tax statements) retrieved during the third phase of the data retrieval process.
*/
@Api(Description="Represents a server response that encapsulates data records (tax statements) retrieved during the third phase of the data retrieval process.")
public static class AbholungResponse17 extends PhaseResponseBase
{
/**
* The list of retrieved data records (tax statements).
*/
@ApiMember(Description="The list of retrieved data records (tax statements).", Name="Abholungen")
public ArrayList<Abholung17> abholungen = null;
/**
* The return value of the ELSTER data retrieval process.
*/
@ApiMember(Description="The return value of the ELSTER data retrieval process.", Name="Rueckgabe")
public EricBearbeiteVorgang rueckgabe = null;
/**
* The server response of the ELSTER data retrieval process.
*/
@ApiMember(Description="The server response of the ELSTER data retrieval process.", Name="Serverantwort")
public Elster serverantwort = null;
/**
* The status code that the ERiC API function returns.
*/
@ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public EricFehlerCode statusCode = null;
/**
* The status message that the ERiC API function returns.
*/
@ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public String statusText = null;
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
public String id = 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")
public Integer index = 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")
public ResponseStatus responseStatus = null;
public ArrayList<Abholung17> getAbholungen() { return abholungen; }
public AbholungResponse17 setAbholungen(ArrayList<Abholung17> value) { this.abholungen = value; return this; }
public EricBearbeiteVorgang getRueckgabe() { return rueckgabe; }
public AbholungResponse17 setRueckgabe(EricBearbeiteVorgang value) { this.rueckgabe = value; return this; }
public Elster getServerantwort() { return serverantwort; }
public AbholungResponse17 setServerantwort(Elster value) { this.serverantwort = value; return this; }
public EricFehlerCode getStatusCode() { return statusCode; }
public AbholungResponse17 setStatusCode(EricFehlerCode value) { this.statusCode = value; return this; }
public String getStatusText() { return statusText; }
public AbholungResponse17 setStatusText(String value) { this.statusText = value; return this; }
public String getId() { return id; }
public AbholungResponse17 setId(String value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public AbholungResponse17 setIndex(Integer value) { this.index = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public AbholungResponse17 setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Represents a server response type that encapsulates information from the response phase of a data retrieval process.
*/
@Api(Description="Represents a server response type that encapsulates information from the response phase of a data retrieval process.")
public static class PhaseResponseBase extends EricFehlerCodeResponse
{
/**
* The return value of the ELSTER data retrieval process.
*/
@ApiMember(Description="The return value of the ELSTER data retrieval process.", Name="Rueckgabe")
public EricBearbeiteVorgang rueckgabe = null;
/**
* The server response of the ELSTER data retrieval process.
*/
@ApiMember(Description="The server response of the ELSTER data retrieval process.", Name="Serverantwort")
public Elster serverantwort = null;
/**
* The status code that the ERiC API function returns.
*/
@ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public EricFehlerCode statusCode = null;
/**
* The status message that the ERiC API function returns.
*/
@ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public String statusText = null;
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
public String id = 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")
public Integer index = 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")
public ResponseStatus responseStatus = null;
public EricBearbeiteVorgang getRueckgabe() { return rueckgabe; }
public PhaseResponseBase setRueckgabe(EricBearbeiteVorgang value) { this.rueckgabe = value; return this; }
public Elster getServerantwort() { return serverantwort; }
public PhaseResponseBase setServerantwort(Elster value) { this.serverantwort = value; return this; }
public EricFehlerCode getStatusCode() { return statusCode; }
public PhaseResponseBase setStatusCode(EricFehlerCode value) { this.statusCode = value; return this; }
public String getStatusText() { return statusText; }
public PhaseResponseBase setStatusText(String value) { this.statusText = value; return this; }
public String getId() { return id; }
public PhaseResponseBase setId(String value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public PhaseResponseBase setIndex(Integer value) { this.index = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public PhaseResponseBase setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* 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.")
public static class EricFehlerCodeResponse extends ServiceReponseBase
{
/**
* The status code that the ERiC API function returns.
*/
@ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public EricFehlerCode statusCode = null;
/**
* The status message that the ERiC API function returns.
*/
@ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public String statusText = null;
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
public String id = 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")
public Integer index = 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")
public ResponseStatus responseStatus = null;
public EricFehlerCode getStatusCode() { return statusCode; }
public EricFehlerCodeResponse setStatusCode(EricFehlerCode value) { this.statusCode = value; return this; }
public String getStatusText() { return statusText; }
public EricFehlerCodeResponse setStatusText(String value) { this.statusText = value; return this; }
public String getId() { return id; }
public EricFehlerCodeResponse setId(String value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public EricFehlerCodeResponse setIndex(Integer value) { this.index = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public EricFehlerCodeResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Specifies a service response from an ERiC service operation.
*/
@Api(Description="Specifies a service response from an ERiC service operation.")
public static class ServiceReponseBase implements IHasIndex
{
/**
* The unique identifier of the response.
*/
@ApiMember(Description="The unique identifier of the response.", Name="Id")
public String id = 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")
public Integer index = 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")
public ResponseStatus responseStatus = null;
public String getId() { return id; }
public ServiceReponseBase setId(String value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public ServiceReponseBase setIndex(Integer value) { this.index = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public ServiceReponseBase setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Enumeration of ERiC API error codes.
*/
public static enum EricFehlerCode
{
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);
private final int value;
EricFehlerCode(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
/**
* 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.")
public static class EricBearbeiteVorgang
{
/**
* Information from the successful processing a tax declaration.
*/
@ApiMember(Description="Information from the successful processing a tax declaration.")
public 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.")
public 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.")
public ArrayList<FehlerRegelpruefung> fehlerRegelpruefungen = null;
/**
* Hints that result the processing of a tax declaration.
*/
@ApiMember(Description="Hints that result the processing of a tax declaration.")
public ArrayList<Hinweis> hinweise = null;
public Erfolg getErfolg() { return erfolg; }
public EricBearbeiteVorgang setErfolg(Erfolg value) { this.erfolg = value; return this; }
public Transfers getTransfers() { return transfers; }
public EricBearbeiteVorgang setTransfers(Transfers value) { this.transfers = value; return this; }
public ArrayList<FehlerRegelpruefung> getFehlerRegelpruefungen() { return fehlerRegelpruefungen; }
public EricBearbeiteVorgang setFehlerRegelpruefungen(ArrayList<FehlerRegelpruefung> value) { this.fehlerRegelpruefungen = value; return this; }
public ArrayList<Hinweis> getHinweise() { return hinweise; }
public EricBearbeiteVorgang setHinweise(ArrayList<Hinweis> value) { this.hinweise = value; return this; }
}
/**
* Represents information returned from a successful tax declaration process.
*/
@Api(Description="Represents information returned from a successful tax declaration process.")
public static class Erfolg
{
/**
* The generated tele-number for the successful tax declaration process.
*/
@ApiMember(Description="The generated tele-number for the successful tax declaration process.")
public ArrayList<String> telenummer = null;
/**
* The classification key for the successful tax declaration process.
*/
@ApiMember(Description="The classification key for the successful tax declaration process.")
public ArrayList<String> ordnungsbegriffe = null;
public ArrayList<String> getTelenummer() { return telenummer; }
public Erfolg setTelenummer(ArrayList<String> value) { this.telenummer = value; return this; }
public ArrayList<String> getOrdnungsbegriffe() { return ordnungsbegriffe; }
public Erfolg setOrdnungsbegriffe(ArrayList<String> value) { this.ordnungsbegriffe = value; return this; }
}
/**
* 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.")
public static 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.")
public ArrayList<Transfer> transferList = null;
public ArrayList<Transfer> getTransferList() { return transferList; }
public Transfers setTransferList(ArrayList<Transfer> value) { this.transferList = value; return this; }
}
/**
* Represents information on the delivery.
*/
@Api(Description="Represents information on the delivery.")
public static class Transfer
{
/**
* The ticket of the transfer.
*/
@ApiMember(Description="The ticket of the transfer.")
public String transferTicket = null;
public String getTransferTicket() { return transferTicket; }
public Transfer setTransferTicket(String value) { this.transferTicket = value; return this; }
}
/**
* Represents information on an ERiC reference.
*/
@Api(Description="Represents information on an ERiC reference.")
public static class FehlerRegelpruefung
{
/**
* The user data ticket of the reference.
*/
@ApiMember(Description="The user data ticket of the reference.")
public String nutzdatenticket = null;
/**
* The field identifier of the reference.
*/
@ApiMember(Description="The field identifier of the reference.")
public String feldidentifikator = null;
/**
* The multi-line index of the reference.
*/
@ApiMember(Description="The multi-line index of the reference.")
public String mehrfachzeilenindex = null;
/**
* The delivery number form of the reference.
*/
@ApiMember(Description="The delivery number form of the reference.")
public String lfdNrVordruck = 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.")
public String vordruckZeilennummer = 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.")
public ArrayList<SemantischerIndex> semantischeIndexes = null;
/**
* The sub-subject-area of the reference.
*/
@ApiMember(Description="The sub-subject-area of the reference.")
public String untersachbereich = null;
/**
* The private identification number of the reference.
*/
@ApiMember(Description="The private identification number of the reference.")
public String privateKennnummer = null;
/**
* The name of the rule that applies to the reference.
*/
@ApiMember(Description="The name of the rule that applies to the reference.")
public String regelName = null;
/**
* The technical error identifier of the reference.
*/
@ApiMember(Description="The technical error identifier of the reference.")
public String fachlicheFehlerId = null;
/**
* The textual details of the reference.
*/
@ApiMember(Description="The textual details of the reference.")
public String text = null;
public String getNutzdatenticket() { return nutzdatenticket; }
public FehlerRegelpruefung setNutzdatenticket(String value) { this.nutzdatenticket = value; return this; }
public String getFeldidentifikator() { return feldidentifikator; }
public FehlerRegelpruefung setFeldidentifikator(String value) { this.feldidentifikator = value; return this; }
public String getMehrfachzeilenindex() { return mehrfachzeilenindex; }
public FehlerRegelpruefung setMehrfachzeilenindex(String value) { this.mehrfachzeilenindex = value; return this; }
public String getLfdNrVordruck() { return lfdNrVordruck; }
public FehlerRegelpruefung setLfdNrVordruck(String value) { this.lfdNrVordruck = value; return this; }
public String getVordruckZeilennummer() { return vordruckZeilennummer; }
public FehlerRegelpruefung setVordruckZeilennummer(String value) { this.vordruckZeilennummer = value; return this; }
public ArrayList<SemantischerIndex> getSemantischeIndexes() { return semantischeIndexes; }
public FehlerRegelpruefung setSemantischeIndexes(ArrayList<SemantischerIndex> value) { this.semantischeIndexes = value; return this; }
public String getUntersachbereich() { return untersachbereich; }
public FehlerRegelpruefung setUntersachbereich(String value) { this.untersachbereich = value; return this; }
public String getPrivateKennnummer() { return privateKennnummer; }
public FehlerRegelpruefung setPrivateKennnummer(String value) { this.privateKennnummer = value; return this; }
public String getRegelName() { return regelName; }
public FehlerRegelpruefung setRegelName(String value) { this.regelName = value; return this; }
public String getFachlicheFehlerId() { return fachlicheFehlerId; }
public FehlerRegelpruefung setFachlicheFehlerId(String value) { this.fachlicheFehlerId = value; return this; }
public String getText() { return text; }
public FehlerRegelpruefung setText(String value) { this.text = value; return this; }
}
/**
* 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.")
public static class SemantischerIndex
{
/**
* The name of the index field.
*/
@ApiMember(Description="The name of the index field.")
public String name = null;
/**
* The value of the index field.
*/
@ApiMember(Description="The value of the index field.")
public String value = null;
public String getName() { return name; }
public SemantischerIndex setName(String value) { this.name = value; return this; }
public String getValue() { return value; }
public SemantischerIndex setValue(String value) { this.value = value; return this; }
}
public static class Hinweis
{
/**
* The user data ticket of the reference.
*/
@ApiMember(Description="The user data ticket of the reference.")
public String nutzdatenticket = null;
/**
* The field identifier of the reference.
*/
@ApiMember(Description="The field identifier of the reference.")
public String feldidentifikator = null;
/**
* The multi-line index of the reference.
*/
@ApiMember(Description="The multi-line index of the reference.")
public String mehrfachzeilenindex = null;
/**
* The delivery number form of the reference.
*/
@ApiMember(Description="The delivery number form of the reference.")
public String lfdNrVordruck = 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.")
public String vordruckZeilennummer = 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.")
public ArrayList<SemantischerIndex> semantischeIndexes = null;
/**
* The sub-subject-area of the reference.
*/
@ApiMember(Description="The sub-subject-area of the reference.")
public String untersachbereich = null;
/**
* The private identification number of the reference.
*/
@ApiMember(Description="The private identification number of the reference.")
public String privateKennnummer = null;
/**
* The name of the rule that applies to the reference.
*/
@ApiMember(Description="The name of the rule that applies to the reference.")
public String regelName = null;
/**
* The technical note identifier of the reference.
*/
@ApiMember(Description="The technical note identifier of the reference.")
public String fachlicheHinweisId = null;
/**
* The textual details of the reference.
*/
@ApiMember(Description="The textual details of the reference.")
public String text = null;
public String getNutzdatenticket() { return nutzdatenticket; }
public Hinweis setNutzdatenticket(String value) { this.nutzdatenticket = value; return this; }
public String getFeldidentifikator() { return feldidentifikator; }
public Hinweis setFeldidentifikator(String value) { this.feldidentifikator = value; return this; }
public String getMehrfachzeilenindex() { return mehrfachzeilenindex; }
public Hinweis setMehrfachzeilenindex(String value) { this.mehrfachzeilenindex = value; return this; }
public String getLfdNrVordruck() { return lfdNrVordruck; }
public Hinweis setLfdNrVordruck(String value) { this.lfdNrVordruck = value; return this; }
public String getVordruckZeilennummer() { return vordruckZeilennummer; }
public Hinweis setVordruckZeilennummer(String value) { this.vordruckZeilennummer = value; return this; }
public ArrayList<SemantischerIndex> getSemantischeIndexes() { return semantischeIndexes; }
public Hinweis setSemantischeIndexes(ArrayList<SemantischerIndex> value) { this.semantischeIndexes = value; return this; }
public String getUntersachbereich() { return untersachbereich; }
public Hinweis setUntersachbereich(String value) { this.untersachbereich = value; return this; }
public String getPrivateKennnummer() { return privateKennnummer; }
public Hinweis setPrivateKennnummer(String value) { this.privateKennnummer = value; return this; }
public String getRegelName() { return regelName; }
public Hinweis setRegelName(String value) { this.regelName = value; return this; }
public String getFachlicheHinweisId() { return fachlicheHinweisId; }
public Hinweis setFachlicheHinweisId(String value) { this.fachlicheHinweisId = value; return this; }
public String getText() { return text; }
public Hinweis setText(String value) { this.text = value; return this; }
}
/**
* Represents an ELSTER document.
*/
@Api(Description="Represents an ELSTER document.")
public static class Elster
{
/**
* The transfer header part of the ELSTER document.
*/
@ApiMember(Description="The transfer header part of the ELSTER document.", IsRequired=true)
public TransferHeader transferHeader = null;
/**
* The data (facts) part of the ELSTER document.
*/
@ApiMember(Description="The data (facts) part of the ELSTER document.")
public DatenTeil datenTeil = null;
public TransferHeader getTransferHeader() { return transferHeader; }
public Elster setTransferHeader(TransferHeader value) { this.transferHeader = value; return this; }
public DatenTeil getDatenTeil() { return datenTeil; }
public Elster setDatenTeil(DatenTeil value) { this.datenTeil = value; return this; }
}
/**
* Represents the transfer header part of an ELSTER document.
*/
@Api(Description="Represents the transfer header part of an ELSTER document.")
public static class TransferHeader
{
/**
* The version of the transfer header.
*/
@ApiMember(Description="The version of the transfer header.", IsRequired=true)
public String version = null;
/**
* The tax operation used in the ELSTER process.
*/
@ApiMember(Description="The tax operation used in the ELSTER process.", IsRequired=true)
public Verfahren verfahren = null;
/**
* The tax data type of the ELSTER process.
*/
@ApiMember(Description="The tax data type of the ELSTER process.", IsRequired=true)
public Datenart datenArt = null;
/**
* The authentification procedure of the ELSTER process.
*/
@ApiMember(Description="The authentification procedure of the ELSTER process.", IsRequired=true)
public Vorgang vorgang = null;
/**
* The ticket identifier after a successful ELSTER process.
*/
@ApiMember(Description="The ticket identifier after a successful ELSTER process.")
public String transferTicket = 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.")
public 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.")
public SigUser sigUser = null;
/**
* The receiving ELSTER server.
*/
@ApiMember(Description="The receiving ELSTER server.")
public 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)
public String herstellerID = null;
/**
* The details of the provider that submits tax data.
*/
@ApiMember(Description="The details of the provider that submits tax data.", IsRequired=true)
public String datenLieferant = null;
/**
* The date of receipt of the tax data.
*/
@ApiMember(Description="The date of receipt of the tax data.")
public Date eingangsDatum = null;
/**
* The encryption data required for authenticated transmission of tax data.
*/
@ApiMember(Description="The encryption data required for authenticated transmission of tax data.")
public 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.")
public 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.")
public String versionClient = null;
/**
* Data extensions to the transfer header.
*/
@ApiMember(Description="Data extensions to the transfer header.")
public Zusatz zusatz = null;
public String getVersion() { return version; }
public TransferHeader setVersion(String value) { this.version = value; return this; }
public Verfahren getVerfahren() { return verfahren; }
public TransferHeader setVerfahren(Verfahren value) { this.verfahren = value; return this; }
public Datenart getDatenArt() { return datenArt; }
public TransferHeader setDatenArt(Datenart value) { this.datenArt = value; return this; }
public Vorgang getVorgang() { return vorgang; }
public TransferHeader setVorgang(Vorgang value) { this.vorgang = value; return this; }
public String getTransferTicket() { return transferTicket; }
public TransferHeader setTransferTicket(String value) { this.transferTicket = value; return this; }
public Testmerker getTestmerker() { return testmerker; }
public TransferHeader setTestmerker(Testmerker value) { this.testmerker = value; return this; }
public SigUser getSigUser() { return sigUser; }
public TransferHeader setSigUser(SigUser value) { this.sigUser = value; return this; }
public Empfaenger getEmpfaenger() { return empfaenger; }
public TransferHeader setEmpfaenger(Empfaenger value) { this.empfaenger = value; return this; }
public String getHerstellerID() { return herstellerID; }
public TransferHeader setHerstellerID(String value) { this.herstellerID = value; return this; }
public String getDatenLieferant() { return datenLieferant; }
public TransferHeader setDatenLieferant(String value) { this.datenLieferant = value; return this; }
public Date getEingangsDatum() { return eingangsDatum; }
public TransferHeader setEingangsDatum(Date value) { this.eingangsDatum = value; return this; }
public Datei getDatei() { return datei; }
public TransferHeader setDatei(Datei value) { this.datei = value; return this; }
public RC getRc() { return rc; }
public TransferHeader setRc(RC value) { this.rc = value; return this; }
public String getVersionClient() { return versionClient; }
public TransferHeader setVersionClient(String value) { this.versionClient = value; return this; }
public Zusatz getZusatz() { return zusatz; }
public TransferHeader setZusatz(Zusatz value) { this.zusatz = value; return this; }
}
/**
* Auflistung der gültigen Verfahren
*/
public static enum Verfahren
{
ElsterAnmeldung,
ElsterBereitstellung,
ElsterBilanz,
ElsterBRM,
ElsterBRMOrg,
ElsterDatenabholung,
ElsterErklaerung,
ElsterExtern,
ElsterFSE,
ElsterKapESt,
ElsterKMV,
ElsterKontoabfrage,
ElsterLavendel,
ElsterLohn,
ElsterLohn2,
ElsterNachricht,
ElsterSignatur,
ElsterVollmachtDB;
}
/**
* Hauptinformation ob die Daten authentifiziert wurden (send-Auth) oder nicht (send-NoSig)
*/
public static enum 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.
*/
public static enum Testmerker
{
TM010000001(10000001),
TM080000001(80000001),
TM160000001(160000001),
TM160000002(160000002),
TM220000000(220000000),
TM220002000(220002000),
TM230000001(230000001),
TM240000000(240000000),
TM370000001(370000001),
TM520000000(520000000),
TM700000001(700000001),
TM700000004(700000004);
private final int value;
Testmerker(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
/**
* 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.")
public static 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")
public Object inhalt = null;
public Object getInhalt() { return inhalt; }
public SigUser setInhalt(Object value) { this.inhalt = value; return this; }
}
/**
* Represents a receiver of tax data.
*/
@Api(Description="Represents a receiver of tax data.")
public static class Empfaenger
{
/**
* The identifier of the receiver.
*/
@ApiMember(Description="The identifier of the receiver.")
public String id = null;
/**
* The destination of the receiver.
*/
@ApiMember(Description="The destination of the receiver.")
public Bundesland ziel = null;
public String getId() { return id; }
public Empfaenger setId(String value) { this.id = value; return this; }
public Bundesland getZiel() { return ziel; }
public Empfaenger setZiel(Bundesland value) { this.ziel = value; return this; }
}
/**
* Einheitliche Abkürzungen fuer die Bundesländer bzw. alternative Empfänger
*/
public static enum 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.")
public static class Datei
{
/**
* The type of data encryption used.
*/
@ApiMember(Description="The type of data encryption used.")
public Verschluesselungsart verschluesselung = null;
/**
* The type of data compression used.
*/
@ApiMember(Description="The type of data compression used.")
public Kompression kompression = null;
/**
* The transport key used in the encryption.
*/
@ApiMember(Description="The transport key used in the encryption.")
public String transportSchluessel = null;
/**
* [Documentation unavailable]
*/
@ApiMember(Description="[Documentation unavailable]")
public Erstellung erstellung = null;
public Verschluesselungsart getVerschluesselung() { return verschluesselung; }
public Datei setVerschluesselung(Verschluesselungsart value) { this.verschluesselung = value; return this; }
public Kompression getKompression() { return kompression; }
public Datei setKompression(Kompression value) { this.kompression = value; return this; }
public String getTransportSchluessel() { return transportSchluessel; }
public Datei setTransportSchluessel(String value) { this.transportSchluessel = value; return this; }
public Erstellung getErstellung() { return erstellung; }
public Datei setErstellung(Erstellung value) { this.erstellung = value; return this; }
}
/**
* 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
*/
public static enum 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.
*/
public static enum Kompression
{
Gzip,
NoBasE64;
}
/**
* [Documentation unavailable]
*/
@Api(Description="[Documentation unavailable]")
public static class Erstellung
{
/**
* [Documentation unavailable]
*/
@ApiMember(Description="[Documentation unavailable]")
public EricTyp eric = null;
public EricTyp getEric() { return eric; }
public Erstellung setEric(EricTyp value) { this.eric = value; return this; }
}
/**
* [Documentation unavailable]
*/
@Api(Description="[Documentation unavailable]")
public static 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")
public Object inhalt = null;
public Object getInhalt() { return inhalt; }
public EricTyp setInhalt(Object value) { this.inhalt = value; return this; }
}
/**
* Represents an ERiC return code.
*/
@Api(Description="Represents an ERiC return code.")
public static class RC
{
/**
* The return value of the return code.
*/
@ApiMember(Description="The return value of the return code.")
public Rueckgabe rueckgabe = null;
/**
* The internal value of the return code.
*/
@ApiMember(Description="The internal value of the return code.")
public Stack stack = null;
public Rueckgabe getRueckgabe() { return rueckgabe; }
public RC setRueckgabe(Rueckgabe value) { this.rueckgabe = value; return this; }
public Stack getStack() { return stack; }
public RC setStack(Stack value) { this.stack = value; return this; }
}
/**
* Represents an external error stack.
*/
@Api(Description="Represents an external error stack.")
public static 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.")
public String code = null;
/**
* The external error message.
*/
@ApiMember(Description="The external error message.")
public String text = null;
public String getCode() { return code; }
public Rueckgabe setCode(String value) { this.code = value; return this; }
public String getText() { return text; }
public Rueckgabe setText(String value) { this.text = value; return this; }
}
/**
* Represents an internal error stack.
*/
@Api(Description="Represents an internal error stack.")
public static 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.")
public String code = null;
/**
* The external error message.
*/
@ApiMember(Description="The external error message.")
public String text = null;
public String getCode() { return code; }
public Stack setCode(String value) { this.code = value; return this; }
public String getText() { return text; }
public Stack setText(String value) { this.text = value; return this; }
}
/**
* Represents an ERiC extension.
*/
@Api(Description="Represents an ERiC extension.")
public static 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.")
public ArrayList<String> infos = null;
/**
* 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).")
public ArrayList<String> elsterInfos = null;
public ArrayList<String> getInfos() { return infos; }
public Zusatz setInfos(ArrayList<String> value) { this.infos = value; return this; }
public ArrayList<String> getElsterInfos() { return elsterInfos; }
public Zusatz setElsterInfos(ArrayList<String> value) { this.elsterInfos = value; return this; }
}
/**
* Represents the data part of an ELSTER document.
*/
@Api(Description="Represents the data part of an ELSTER document.")
public static class DatenTeil
{
/**
* The blocks of tax data of the ELSTER document.
*/
@ApiMember(Description="The blocks of tax data of the ELSTER document.", IsRequired=true)
public ArrayList<Nutzdatenblock> nutzdatenbloecke = null;
public ArrayList<Nutzdatenblock> getNutzdatenbloecke() { return nutzdatenbloecke; }
public DatenTeil setNutzdatenbloecke(ArrayList<Nutzdatenblock> value) { this.nutzdatenbloecke = value; return this; }
}
/**
* Represents a block of tax data.
*/
@Api(Description="Represents a block of tax data.")
public static class Nutzdatenblock
{
/**
* The header part of the block.
*/
@ApiMember(Description="The header part of the block.", IsRequired=true)
public NutzdatenHeader nutzdatenHeader = null;
/**
* The data part of the block.
*/
@ApiMember(Description="The data part of the block.", IsRequired=true)
public Nutzdaten nutzdaten = null;
public NutzdatenHeader getNutzdatenHeader() { return nutzdatenHeader; }
public Nutzdatenblock setNutzdatenHeader(NutzdatenHeader value) { this.nutzdatenHeader = value; return this; }
public Nutzdaten getNutzdaten() { return nutzdaten; }
public Nutzdatenblock setNutzdaten(Nutzdaten value) { this.nutzdaten = value; return this; }
}
/**
* Represents the header of a tax data.
*/
@Api(Description="Represents the header of a tax data.")
public static class NutzdatenHeader
{
/**
* The version of the header.
*/
@ApiMember(Description="The version of the header.", IsRequired=true)
public String version = null;
/**
* The ticket identifier of the header.
*/
@ApiMember(Description="The ticket identifier of the header.", IsRequired=true)
public String nutzdatenTicket = null;
/**
* The receiver of the header.
*/
@ApiMember(Description="The receiver of the header.", IsRequired=true)
public NDHEmpfaenger empfaenger = 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)
public 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.")
public String datenLieferant = null;
/**
* The return code of the header.
*/
@ApiMember(Description="The return code of the header.")
public RC rc = null;
/**
* The data extensions of the header.
*/
@ApiMember(Description="The data extensions of the header.")
public Zusatz zusatz = null;
public String getVersion() { return version; }
public NutzdatenHeader setVersion(String value) { this.version = value; return this; }
public String getNutzdatenTicket() { return nutzdatenTicket; }
public NutzdatenHeader setNutzdatenTicket(String value) { this.nutzdatenTicket = value; return this; }
public NDHEmpfaenger getEmpfaenger() { return empfaenger; }
public NutzdatenHeader setEmpfaenger(NDHEmpfaenger value) { this.empfaenger = value; return this; }
public Hersteller getHersteller() { return hersteller; }
public NutzdatenHeader setHersteller(Hersteller value) { this.hersteller = value; return this; }
public String getDatenLieferant() { return datenLieferant; }
public NutzdatenHeader setDatenLieferant(String value) { this.datenLieferant = value; return this; }
public RC getRc() { return rc; }
public NutzdatenHeader setRc(RC value) { this.rc = value; return this; }
public Zusatz getZusatz() { return zusatz; }
public NutzdatenHeader setZusatz(Zusatz value) { this.zusatz = value; return this; }
}
/**
* Represents a receiver of tax data.
*/
@Api(Description="Represents a receiver of tax data.")
public static class NDHEmpfaenger
{
/**
* The identifier of the receiver.
*/
@ApiMember(Description="The identifier of the receiver.")
public EmpfaengerID id = null;
/**
* The value of the receiver.
*/
@ApiMember(Description="The value of the receiver.")
public String value = null;
public EmpfaengerID getId() { return id; }
public NDHEmpfaenger setId(EmpfaengerID value) { this.id = value; return this; }
public String getValue() { return value; }
public NDHEmpfaenger setValue(String value) { this.value = value; return this; }
}
/**
* Represents a receriver ID
*/
public static enum EmpfaengerID
{
L,
F;
}
/**
* Represents a manufacturer/vendor of tax software.
*/
@Api(Description="Represents a manufacturer/vendor of tax software.")
public static 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.")
public String produktName = 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.")
public String produktVersion = null;
public String getProduktName() { return produktName; }
public Hersteller setProduktName(String value) { this.produktName = value; return this; }
public String getProduktVersion() { return produktVersion; }
public Hersteller setProduktVersion(String value) { this.produktVersion = value; return this; }
}
/**
* Represents an encapsulation of tax data content.
*/
@Api(Description="Represents an encapsulation of tax data content.")
public static 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)
public Object inhalt = null;
public Object getInhalt() { return inhalt; }
public Nutzdaten setInhalt(Object value) { this.inhalt = value; return this; }
}
/**
* Represents a request to retrieve data records by means of one or more IDs.
*/
@Api(Description="Represents a request to retrieve data records by means of one or more IDs.")
public static class Abholung17 extends Abholung
{
/**
* The tax type (e.g. ESB) of the data record.
*/
@ApiMember(Description="The tax type (e.g. ESB) of the data record.")
public Steuerart steuerart = null;
/**
* The meta information of the identifier.
*/
@ApiMember(Description="The meta information of the identifier.")
public MetaInformationen17 metaInformationen = null;
/**
* Die Transfertickets der Datensaetze. Es duerfen max. 100 Bereitstellungstickets in einem Request angegeben werden.
*/
@ApiMember(Description="Die Transfertickets der Datensaetze. Es duerfen max. 100 Bereitstellungstickets in einem Request angegeben werden.")
public String bereitstellungsticket = null;
/**
* The attachments of the data records.
*/
@ApiMember(Description="The attachments of the data records.")
public Anhaenge17 anhaenge = null;
/**
* The identifier of the data record.
*/
@ApiMember(Description="The identifier of the data record.")
public String id = null;
/**
* The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.
*/
@ApiMember(Description="The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.")
public String idnr = null;
/**
* The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.
*/
@ApiMember(Description="The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.")
public Integer veranlagungsjahr = null;
/**
* The transmission path used.
*/
@ApiMember(Description="The transmission path used.")
public Uebertragungsweg uebertragungsweg = null;
/**
* The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.
*/
@ApiMember(Description="The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.")
public String encoding = null;
/**
* The client number; only applicable to the tax type 'ElsterDIVADaten'.
*/
@ApiMember(Description="The client number; only applicable to the tax type 'ElsterDIVADaten'.")
public String mandantennummer = null;
/**
* The tax number; only applicable to the tax type 'ElsterDIVADaten'.
*/
@ApiMember(Description="The tax number; only applicable to the tax type 'ElsterDIVADaten'.")
public String steuernummer = null;
/**
* The asessment date; only applicable to the tax type 'ElsterDIVADaten'.
*/
@ApiMember(Description="The asessment date; only applicable to the tax type 'ElsterDIVADaten'.")
public Date bescheiddatum = null;
/**
* Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.
*/
@ApiMember(Description="Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.")
public Datenpaket datenpaket = null;
/**
* Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations.
*/
@ApiMember(Description="Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations.")
public Download download = null;
public Steuerart getSteuerart() { return steuerart; }
public Abholung17 setSteuerart(Steuerart value) { this.steuerart = value; return this; }
public MetaInformationen17 getMetaInformationen() { return metaInformationen; }
public Abholung17 setMetaInformationen(MetaInformationen17 value) { this.metaInformationen = value; return this; }
public String getBereitstellungsticket() { return bereitstellungsticket; }
public Abholung17 setBereitstellungsticket(String value) { this.bereitstellungsticket = value; return this; }
public Anhaenge17 getAnhaenge() { return anhaenge; }
public Abholung17 setAnhaenge(Anhaenge17 value) { this.anhaenge = value; return this; }
public String getId() { return id; }
public Abholung17 setId(String value) { this.id = value; return this; }
public String getIdnr() { return idnr; }
public Abholung17 setIdnr(String value) { this.idnr = value; return this; }
public Integer getVeranlagungsjahr() { return veranlagungsjahr; }
public Abholung17 setVeranlagungsjahr(Integer value) { this.veranlagungsjahr = value; return this; }
public Uebertragungsweg getUebertragungsweg() { return uebertragungsweg; }
public Abholung17 setUebertragungsweg(Uebertragungsweg value) { this.uebertragungsweg = value; return this; }
public String getEncoding() { return encoding; }
public Abholung17 setEncoding(String value) { this.encoding = value; return this; }
public String getMandantennummer() { return mandantennummer; }
public Abholung17 setMandantennummer(String value) { this.mandantennummer = value; return this; }
public String getSteuernummer() { return steuernummer; }
public Abholung17 setSteuernummer(String value) { this.steuernummer = value; return this; }
public Date getBescheiddatum() { return bescheiddatum; }
public Abholung17 setBescheiddatum(Date value) { this.bescheiddatum = value; return this; }
public Datenpaket getDatenpaket() { return datenpaket; }
public Abholung17 setDatenpaket(Datenpaket value) { this.datenpaket = value; return this; }
public Download getDownload() { return download; }
public Abholung17 setDownload(Download value) { this.download = value; return this; }
}
/**
* Represents the request to retrieve tax assessments by means of a specfied ID.
*/
@Api(Description="Represents the request to retrieve tax assessments by means of a specfied ID.")
public static class Abholung
{
/**
* The identifier of the data record.
*/
@ApiMember(Description="The identifier of the data record.")
public String id = null;
/**
* The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.
*/
@ApiMember(Description="The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.")
public String idnr = null;
/**
* The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.
*/
@ApiMember(Description="The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.")
public Integer veranlagungsjahr = null;
/**
* The transmission path used.
*/
@ApiMember(Description="The transmission path used.")
public Uebertragungsweg uebertragungsweg = null;
/**
* The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.
*/
@ApiMember(Description="The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.")
public String encoding = null;
/**
* The client number; only applicable to the tax type 'ElsterDIVADaten'.
*/
@ApiMember(Description="The client number; only applicable to the tax type 'ElsterDIVADaten'.")
public String mandantennummer = null;
/**
* The tax number; only applicable to the tax type 'ElsterDIVADaten'.
*/
@ApiMember(Description="The tax number; only applicable to the tax type 'ElsterDIVADaten'.")
public String steuernummer = null;
/**
* The asessment date; only applicable to the tax type 'ElsterDIVADaten'.
*/
@ApiMember(Description="The asessment date; only applicable to the tax type 'ElsterDIVADaten'.")
public Date bescheiddatum = null;
/**
* Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.
*/
@ApiMember(Description="Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.")
public Datenpaket datenpaket = null;
/**
* Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations.
*/
@ApiMember(Description="Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations.")
public Download download = null;
public String getId() { return id; }
public Abholung setId(String value) { this.id = value; return this; }
public String getIdnr() { return idnr; }
public Abholung setIdnr(String value) { this.idnr = value; return this; }
public Integer getVeranlagungsjahr() { return veranlagungsjahr; }
public Abholung setVeranlagungsjahr(Integer value) { this.veranlagungsjahr = value; return this; }
public Uebertragungsweg getUebertragungsweg() { return uebertragungsweg; }
public Abholung setUebertragungsweg(Uebertragungsweg value) { this.uebertragungsweg = value; return this; }
public String getEncoding() { return encoding; }
public Abholung setEncoding(String value) { this.encoding = value; return this; }
public String getMandantennummer() { return mandantennummer; }
public Abholung setMandantennummer(String value) { this.mandantennummer = value; return this; }
public String getSteuernummer() { return steuernummer; }
public Abholung setSteuernummer(String value) { this.steuernummer = value; return this; }
public Date getBescheiddatum() { return bescheiddatum; }
public Abholung setBescheiddatum(Date value) { this.bescheiddatum = value; return this; }
public Datenpaket getDatenpaket() { return datenpaket; }
public Abholung setDatenpaket(Datenpaket value) { this.datenpaket = value; return this; }
public Download getDownload() { return download; }
public Abholung setDownload(Download value) { this.download = value; return this; }
}
/**
* Represents the transmission path.
*/
public static enum Uebertragungsweg
{
Direkt,
Link,
Sammellink;
}
/**
* The data packet from the retrieval operation.
*/
@Api(Description="The data packet from the retrieval operation.")
public static class Datenpaket
{
/**
* Encoded (compressed and encrypted) requested data record
*/
@ApiMember(Description="Encoded (compressed and encrypted) requested data record")
public String value = null;
public String getValue() { return value; }
public Datenpaket setValue(String value) { this.value = value; return this; }
}
/**
* Represents the download of requested records. The downloaded content from the web server takes place: a) with https b) on port 443 c) on datenabholung1.elster.de or datenabholung2.elster.de. The HTTP Basic Authentication mechanism according to RFC 2617 is used for authentication.
*/
@Api(Description="Represents the download of requested records. The downloaded content from the web server takes place: a) with https b) on port 443 c) on datenabholung1.elster.de or datenabholung2.elster.de. The HTTP Basic Authentication mechanism according to RFC 2617 is used for authentication.")
public static class Download
{
/**
* The link to the data on the web server.
*/
@ApiMember(Description="The link to the data on the web server.")
public String url = null;
/**
* The user name for the web server.
*/
@ApiMember(Description="The user name for the web server.")
public String benutzer = null;
/**
* Password for the web server.
*/
@ApiMember(Description="Password for the web server.")
public String passwort = null;
public String getUrl() { return url; }
public Download setUrl(String value) { this.url = value; return this; }
public String getBenutzer() { return benutzer; }
public Download setBenutzer(String value) { this.benutzer = value; return this; }
public String getPasswort() { return passwort; }
public Download setPasswort(String value) { this.passwort = value; return this; }
}
/**
* Represents the various tax types for the retrieval of data.
*/
public static enum Steuerart
{
Esb,
Gsb,
Usb,
EpBescheid,
EpMitteilung,
Gewerbesteuerbescheid,
Gewerbesteuermitteilung,
Gewmb,
DivaAnzeigeEinerLotterie,
DivaBescheid,
DivaBescheidESt,
DivaBuchmachersteuer,
DivaLotteriesteuerEinmal,
DivaLotteriesteuerMehr,
DivaSportwettensteuer,
DivaTotalisator,
OzgBescheid,
VerbindlicheAuskunft,
VerbindlicheZusage,
DivaSonstigerVA,
DivaBescheidErbSt,
DivaBescheidFEIN,
DivaBescheidGewSt,
DivaBescheidKSt,
DivaBescheidUSt,
DivaBescheidSchenkSt,
DivaTroncabgabe,
DivaVirtuelleAutomatenStB,
DivaOnlinePokerStB,
LStHVVMRM,
EinlagenrueckgewaehrVA,
FttMeldungVA,
StatusInvStGVA,
UStVEUVA,
Versva,
AltZertVA,
KapEStEntlastungVA,
PostUDLVA,
StAb50aVA,
StAbEntlastungVA,
KassenangelegenheitenVA,
KStOptVA,
SteueroasenabwehrVA,
KdbVollmachtRM,
Stbke,
VdbkdbRueckmeldungLief,
AnhangRueckmeldung,
DivaEinwilligungRM,
GlueckspielF,
OzgMitteilung,
VerbindlicheAuskunftInfoF,
EloProtokoll;
}
/**
* Represents meta information.
*/
@Api(Description="Represents meta information.")
public static class MetaInformationen17
{
/**
* List of metadata.
*/
@ApiMember(Description="List of metadata.")
public ArrayList<Meta17> meta = null;
/**
* List of meta infomation maps.
*/
@ApiMember(Description="List of meta infomation maps.")
public MetaInfoMaps17 metaInfoMaps = null;
public ArrayList<Meta17> getMeta() { return meta; }
public MetaInformationen17 setMeta(ArrayList<Meta17> value) { this.meta = value; return this; }
public MetaInfoMaps17 getMetaInfoMaps() { return metaInfoMaps; }
public MetaInformationen17 setMetaInfoMaps(MetaInfoMaps17 value) { this.metaInfoMaps = value; return this; }
}
/**
* Represents the metadata of a data record.
*/
@Api(Description="Represents the metadata of a data record.")
public static class Meta17
{
/**
* The type of metadata, e.g. datei [file]
*/
@ApiMember(Description="The type of metadata, e.g. datei [file]")
public String name = null;
/**
* The encoding of the metadata (text or base64)
*/
@ApiMember(Description="The encoding of the metadata (text or base64)")
public Coding coding = null;
/**
* The content of the metadata
*/
@ApiMember(Description="The content of the metadata")
public String value = null;
public String getName() { return name; }
public Meta17 setName(String value) { this.name = value; return this; }
public Coding getCoding() { return coding; }
public Meta17 setCoding(Coding value) { this.coding = value; return this; }
public String getValue() { return value; }
public Meta17 setValue(String value) { this.value = value; return this; }
}
/**
* Specifies the encoding of the metadata.
*/
public static enum Coding
{
Text,
Base64;
}
/**
* Represents a list of meta information maps.
*/
public static class MetaInfoMaps17
{
}
/**
* Represents a list of attachments.
*/
public static class Anhaenge17
{
}
}
Java PostfachAnfrageAbholungRequest17Async DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/datenabholungen/abholungen/17/PostfachAnfrage HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: application/json
Content-Type: application/json
Content-Length: length
{"suchkriterien":[{"id":"String"}],"datenart":"34a","zertifikat":{"id":"00000000000000000000000000000000","index":0,"pin":"String","description":"String","tags":["String"],"name":"String","content":"AA=="},"abrufCode":"String","datenLieferant":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"abholungen":[{"steuerart":"ESB","metaInformationen":{"meta":[{"name":"String","coding":"text","value":"String"}],"metaInfoMaps":[{"typ":"String","meta":[{"name":"String","coding":"text","value":"String"}]}]},"bereitstellungsticket":"String","anhaenge":[{"metadatenAnhang":[{"schluesselAnhang":{"dateibezeichnungID":"String","dateibezeichnungKurz":"String","value":"String"},"wertAnhang":{"dateibezeichnungID":"String","dateibezeichnungKurz":"String","value":"String"}}],"dateibezeichnung":"String","dateityp":"String","dateiinhalt":"String"}],"id":"String","idnr":"String","veranlagungsjahr":0,"uebertragungsweg":"direkt","encoding":"String","mandantennummer":"String","steuernummer":"String","bescheiddatum":"\/Date(-62135596800000-0000)\/","datenpaket":{"value":"String"},"download":{"url":"String","benutzer":"String","passwort":"String"}}],"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":{}}}]}},"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"}}}