Tax Filing Service
| POST | /async/datenabholungen/abholungen/17/PostfachAnfrage |
|---|
import Foundation
import ServiceStack
/**
* 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 class PostfachAnfrageAbholungRequest17Async : PostfachAnfrageAbholungRequestBase17
{
/**
* The search criteria of the service request.
*/
// @ApiMember(Description="The search criteria of the service request.")
public var suchkriterien:[AbholungSuchkriterien] = []
/**
* The name of the request data group (tax type).
*/
// @ApiMember(Description="The name of the request data group (tax type).")
public var datenart:Datenart?
/**
* The authentification certificate.
*/
// @ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public var zertifikat:PortalCertificate
/**
* 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 var abrufCode:String
/**
* 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 var datenLieferant:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case suchkriterien
case datenart
case zertifikat
case abrufCode
case datenLieferant
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
suchkriterien = try container.decodeIfPresent([AbholungSuchkriterien].self, forKey: .suchkriterien) ?? []
datenart = try container.decodeIfPresent(Datenart.self, forKey: .datenart)
zertifikat = try container.decodeIfPresent(PortalCertificate.self, forKey: .zertifikat)
abrufCode = try container.decodeIfPresent(String.self, forKey: .abrufCode)
datenLieferant = try container.decodeIfPresent(String.self, forKey: .datenLieferant)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if suchkriterien.count > 0 { try container.encode(suchkriterien, forKey: .suchkriterien) }
if datenart != nil { try container.encode(datenart, forKey: .datenart) }
if zertifikat != nil { try container.encode(zertifikat, forKey: .zertifikat) }
if abrufCode != nil { try container.encode(abrufCode, forKey: .abrufCode) }
if datenLieferant != nil { try container.encode(datenLieferant, forKey: .datenLieferant) }
}
}
/**
* 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 class PostfachAnfrageAbholungRequestBase17 : AbholungRequestBase17
{
/**
* The search criteria of the service request.
*/
// @ApiMember(Description="The search criteria of the service request.")
public var suchkriterien:[AbholungSuchkriterien] = []
/**
* The name of the request data group (tax type).
*/
// @ApiMember(Description="The name of the request data group (tax type).")
public var datenart:Datenart?
/**
* The authentification certificate.
*/
// @ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public var zertifikat:PortalCertificate
/**
* 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 var abrufCode:String
/**
* 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 var datenLieferant:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case suchkriterien
case datenart
case zertifikat
case abrufCode
case datenLieferant
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
suchkriterien = try container.decodeIfPresent([AbholungSuchkriterien].self, forKey: .suchkriterien) ?? []
datenart = try container.decodeIfPresent(Datenart.self, forKey: .datenart)
zertifikat = try container.decodeIfPresent(PortalCertificate.self, forKey: .zertifikat)
abrufCode = try container.decodeIfPresent(String.self, forKey: .abrufCode)
datenLieferant = try container.decodeIfPresent(String.self, forKey: .datenLieferant)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if suchkriterien.count > 0 { try container.encode(suchkriterien, forKey: .suchkriterien) }
if datenart != nil { try container.encode(datenart, forKey: .datenart) }
if zertifikat != nil { try container.encode(zertifikat, forKey: .zertifikat) }
if abrufCode != nil { try container.encode(abrufCode, forKey: .abrufCode) }
if datenLieferant != nil { try container.encode(datenLieferant, forKey: .datenLieferant) }
}
}
/**
* 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 class AbholungRequestBase17 : AbholungRequestBase
{
/**
* The authentification certificate.
*/
// @ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public var zertifikat:PortalCertificate
/**
* 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 var abrufCode:String
/**
* 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 var datenLieferant:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case zertifikat
case abrufCode
case datenLieferant
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
zertifikat = try container.decodeIfPresent(PortalCertificate.self, forKey: .zertifikat)
abrufCode = try container.decodeIfPresent(String.self, forKey: .abrufCode)
datenLieferant = try container.decodeIfPresent(String.self, forKey: .datenLieferant)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if zertifikat != nil { try container.encode(zertifikat, forKey: .zertifikat) }
if abrufCode != nil { try container.encode(abrufCode, forKey: .abrufCode) }
if datenLieferant != nil { try container.encode(datenLieferant, forKey: .datenLieferant) }
}
}
/**
* 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 class AbholungRequestBase : PhaseRequestBase, IPost
{
/**
* The authentification certificate.
*/
// @ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public var zertifikat:PortalCertificate
/**
* 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 var abrufCode:String
/**
* 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 var datenLieferant:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case zertifikat
case abrufCode
case datenLieferant
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
zertifikat = try container.decodeIfPresent(PortalCertificate.self, forKey: .zertifikat)
abrufCode = try container.decodeIfPresent(String.self, forKey: .abrufCode)
datenLieferant = try container.decodeIfPresent(String.self, forKey: .datenLieferant)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if zertifikat != nil { try container.encode(zertifikat, forKey: .zertifikat) }
if abrufCode != nil { try container.encode(abrufCode, forKey: .abrufCode) }
if datenLieferant != nil { try container.encode(datenLieferant, forKey: .datenLieferant) }
}
}
/**
* 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 class PhaseRequestBase : ISendeRequest, IVeschlueselungsRequest, Codable
{
/**
* The authentification certificate.
*/
// @ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
public var zertifikat:PortalCertificate
/**
* 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 var abrufCode:String
/**
* 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 var datenLieferant:String
required public init(){}
}
/**
* Represents a portal certificate that is protected by a password.
*/
// @Api(Description="Represents a portal certificate that is protected by a password.")
public class PortalCertificate : FileBase, ISecuredCertificate, IHasIndex
{
/**
* The unique identifier of the certificate.
*/
// @ApiMember(Description="The unique identifier of the certificate.")
public var id:String
/**
* 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 var index:Int
/**
* The password to protect the certificate from unauthorized access.
*/
// @StringLength(255)
// @ApiMember(Description="The password to protect the certificate from unauthorized access.")
public var pin:String
/**
* The description of the certificate.
*/
// @StringLength(Int32.max)
// @ApiMember(Description="The description of the certificate.")
public var Description:String
/**
* 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 var tags:[String] = []
/**
* Gets or sets the file name of the certificate.
*/
// @ApiMember(Description="Gets or sets the file name of the certificate.")
public var name:String
/**
* The raw data content of the file.
*/
// @ApiMember(Description="The raw data content of the file.", Name="Content")
public var content:[UInt8] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case index
case pin
case Description
case tags
case name
case content
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
id = try container.decodeIfPresent(String.self, forKey: .id)
index = try container.decodeIfPresent(Int.self, forKey: .index)
pin = try container.decodeIfPresent(String.self, forKey: .pin)
Description = try container.decodeIfPresent(String.self, forKey: .Description)
tags = try container.decodeIfPresent([String].self, forKey: .tags) ?? []
name = try container.decodeIfPresent(String.self, forKey: .name)
content = try container.decodeIfPresent([UInt8].self, forKey: .content) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if id != nil { try container.encode(id, forKey: .id) }
if index != nil { try container.encode(index, forKey: .index) }
if pin != nil { try container.encode(pin, forKey: .pin) }
if Description != nil { try container.encode(Description, forKey: .Description) }
if tags.count > 0 { try container.encode(tags, forKey: .tags) }
if name != nil { try container.encode(name, forKey: .name) }
if content.count > 0 { try container.encode(content, forKey: .content) }
}
}
/**
* Represents a base class for a file with raw data.
*/
// @Api(Description="Represents a base class for a file with raw data.")
public class FileBase : Codable
{
/**
* The raw data content of the file.
*/
// @ApiMember(Description="The raw data content of the file.", Name="Content")
public var content:[UInt8] = []
required public init(){}
}
/**
* 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 class AbholungSuchkriterien : Codable
{
/**
* 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 var id:String
required public init(){}
}
/**
* Auflistung aller gültigen Datenarten.
*/
public enum Datenart : String, Codable
{
case Anlage34a
case AnpassungVorauszahlung
case AntragUStVerguetung4a
case AbrufcodeAntrag
case AenderungAdresse
case AbrufcodeStorno
case AbrufvollmachtAnlage
case AbrufvollmachtUpdate
case AenderungBankverbindung
case AntraegeRechteLoeschen
case AntraegeUndRechte
case Aufzeichnung146a
case BetPG
case Bilanz
case Belegnachreichung
case BSBMitteilung
case BZSt2
case C19Mitteilung
case DUeAbmelden
case DUeAnmelden
case DUeUmmelden
case Einspruch
case EinspruchNachtrag
case EinspruchRuecknahme
case ELeVAntragELStAM
case ELeVErmaessigung
case ELeVGetrenntlebend
case ELeVSteuerklassenwechsel
case ELeVWiederaufnahmeEhe
case EPAntwort
case EPBescheid
case EPMitteilung
case EPKurzmitteilung
case ElsterErklaerungDaten
case ElsterKMVDaten
case ElsterLohn2Daten
case ElsterLohnDaten
case ElsterVaStDaten
case ElsterDIVADaten
case ElsterDIVDaten
case ElsterEPBescheidDaten
case ElsterEPMitteilungDaten
case EPStBescheidAbholung
case EPStMitteilungAbholung
case Erbschaftsteuer
case ESt
case EStbeschraenkt
case EUER
case EUn
case FEIN
case ForschungZulAntrag
case KStAntragOptionPersG
case FLHMitteilung
case FreistellungKapitalertraegeBV
case Fristverlaengerung
case FsEVerein
case Gewerbemeldung
case GDBMitteilung
case Gewinnermittlung13aEStG
case GewSt
case GewStZ
case GrundsteuerBW
case GrundsteuerBY
case GrundsteuerHE
case GrundsteuerHH
case GrundsteuerNI
case Grundsteuerwert
case InvStG56Abs5
case InvStG51Feststellung
case KapEStA
case KapEStInvStG
case KapG
case KapGAus
case KKVMitteilung
case Kontoabfrage
case Kontoinformation
case KSt
case KStZ
case KTTAnmeldungHH
case KTTAnzeigeHH
case Lohnersatzleistung
case LohnersatzMitteilung
case LStA
case LStB
case LStHVVMAnlage
case LStHVVMUpdate
case OGHMitteilung
case VermoegenswirksameLeistung
case VMWiderruf
case VollmachtDetails
case VNoVMVRegistrierung
case VNoVMVUpdate
case VNoVMVLoeschung
case VollfAAnlage
case VollfAUpdate
case VMoVMVStBAnlage
case VMoVMVStBUpdate
case VMoVMVFreischaltung
case VAGMitteilung
case DIVADatenBZSt
case DivaEinwilligungAnlageBRM
case DivaEinwilligungFreisch
case DivaEinwilligungUpdateBRM
case DivaWiderrufBRM
case DivaErgebnisliste
case LStHVDivaAdresseBRM
case VMErgebnisListeVNSicht
case PersG
case PostfachAnfrage
case PostfachStatus
case ProtokollAnforderung
case Registrierung
case Schenkungsteuer
case SonstigeNachrichten
case SpezRechtAntrag
case SpezRechtFreischaltung
case SpezRechtListe
case SpezRechtStorno
case SpezRechtTeilnahme
case StAb50a
case Statusabfrage
case UnentgeltlicheDepotuebertragung
case UENSTAnmeldungBE
case UENSTAnzeigeBE
case USt
case UStVA
case UStDV
case UStSV
case VGNAnmeldungHB
case VGNAnmeldungBE
case VGNAnmeldungHH
case VGNAnzeigeHH
case WTBAnmeldungHB
case ZMDO
case ElsterVollmachtDaten
case 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 class AbholungResponse17 : PhaseResponseBase
{
/**
* The list of retrieved data records (tax statements).
*/
// @ApiMember(Description="The list of retrieved data records (tax statements).", Name="Abholungen")
public var abholungen:[Abholung17] = []
/**
* The return value of the ELSTER data retrieval process.
*/
// @ApiMember(Description="The return value of the ELSTER data retrieval process.", Name="Rueckgabe")
public var rueckgabe:EricBearbeiteVorgang
/**
* The server response of the ELSTER data retrieval process.
*/
// @ApiMember(Description="The server response of the ELSTER data retrieval process.", Name="Serverantwort")
public var serverantwort:Elster
/**
* The status code that the ERiC API function returns.
*/
// @ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public var statusCode:EricFehlerCode
/**
* The status message that the ERiC API function returns.
*/
// @ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public var statusText:String
/**
* The unique identifier of the response.
*/
// @ApiMember(Description="The unique identifier of the response.", Name="Id")
public var id:String
/**
* 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 var index:Int
/**
* 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 var responseStatus:ResponseStatus
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case abholungen
case rueckgabe
case serverantwort
case statusCode
case statusText
case id
case index
case responseStatus
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
abholungen = try container.decodeIfPresent([Abholung17].self, forKey: .abholungen) ?? []
rueckgabe = try container.decodeIfPresent(EricBearbeiteVorgang.self, forKey: .rueckgabe)
serverantwort = try container.decodeIfPresent(Elster.self, forKey: .serverantwort)
statusCode = try container.decodeIfPresent(EricFehlerCode.self, forKey: .statusCode)
statusText = try container.decodeIfPresent(String.self, forKey: .statusText)
id = try container.decodeIfPresent(String.self, forKey: .id)
index = try container.decodeIfPresent(Int.self, forKey: .index)
responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if abholungen.count > 0 { try container.encode(abholungen, forKey: .abholungen) }
if rueckgabe != nil { try container.encode(rueckgabe, forKey: .rueckgabe) }
if serverantwort != nil { try container.encode(serverantwort, forKey: .serverantwort) }
if statusCode != nil { try container.encode(statusCode, forKey: .statusCode) }
if statusText != nil { try container.encode(statusText, forKey: .statusText) }
if id != nil { try container.encode(id, forKey: .id) }
if index != nil { try container.encode(index, forKey: .index) }
if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
}
}
/**
* 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 class PhaseResponseBase : EricFehlerCodeResponse
{
/**
* The return value of the ELSTER data retrieval process.
*/
// @ApiMember(Description="The return value of the ELSTER data retrieval process.", Name="Rueckgabe")
public var rueckgabe:EricBearbeiteVorgang
/**
* The server response of the ELSTER data retrieval process.
*/
// @ApiMember(Description="The server response of the ELSTER data retrieval process.", Name="Serverantwort")
public var serverantwort:Elster
/**
* The status code that the ERiC API function returns.
*/
// @ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public var statusCode:EricFehlerCode
/**
* The status message that the ERiC API function returns.
*/
// @ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public var statusText:String
/**
* The unique identifier of the response.
*/
// @ApiMember(Description="The unique identifier of the response.", Name="Id")
public var id:String
/**
* 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 var index:Int
/**
* 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 var responseStatus:ResponseStatus
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case rueckgabe
case serverantwort
case statusCode
case statusText
case id
case index
case responseStatus
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
rueckgabe = try container.decodeIfPresent(EricBearbeiteVorgang.self, forKey: .rueckgabe)
serverantwort = try container.decodeIfPresent(Elster.self, forKey: .serverantwort)
statusCode = try container.decodeIfPresent(EricFehlerCode.self, forKey: .statusCode)
statusText = try container.decodeIfPresent(String.self, forKey: .statusText)
id = try container.decodeIfPresent(String.self, forKey: .id)
index = try container.decodeIfPresent(Int.self, forKey: .index)
responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if rueckgabe != nil { try container.encode(rueckgabe, forKey: .rueckgabe) }
if serverantwort != nil { try container.encode(serverantwort, forKey: .serverantwort) }
if statusCode != nil { try container.encode(statusCode, forKey: .statusCode) }
if statusText != nil { try container.encode(statusText, forKey: .statusText) }
if id != nil { try container.encode(id, forKey: .id) }
if index != nil { try container.encode(index, forKey: .index) }
if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
}
}
/**
* 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 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")
public var statusCode:EricFehlerCode
/**
* The status message that the ERiC API function returns.
*/
// @ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public var statusText:String
/**
* The unique identifier of the response.
*/
// @ApiMember(Description="The unique identifier of the response.", Name="Id")
public var id:String
/**
* 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 var index:Int
/**
* 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 var responseStatus:ResponseStatus
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case statusCode
case statusText
case id
case index
case responseStatus
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
statusCode = try container.decodeIfPresent(EricFehlerCode.self, forKey: .statusCode)
statusText = try container.decodeIfPresent(String.self, forKey: .statusText)
id = try container.decodeIfPresent(String.self, forKey: .id)
index = try container.decodeIfPresent(Int.self, forKey: .index)
responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if statusCode != nil { try container.encode(statusCode, forKey: .statusCode) }
if statusText != nil { try container.encode(statusText, forKey: .statusText) }
if id != nil { try container.encode(id, forKey: .id) }
if index != nil { try container.encode(index, forKey: .index) }
if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
}
}
/**
* Specifies a service response from an ERiC service operation.
*/
// @Api(Description="Specifies a service response from an ERiC service operation.")
public class ServiceReponseBase : IHasIndex, Codable
{
/**
* The unique identifier of the response.
*/
// @ApiMember(Description="The unique identifier of the response.", Name="Id")
public var id:String
/**
* 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 var index:Int
/**
* 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 var responseStatus:ResponseStatus
required public init(){}
}
/**
* Enumeration of ERiC API error codes.
*/
public enum EricFehlerCode : Int, Codable
{
case ERIC_OK = 0
case ERIC_GLOBAL_UNKNOWN = 610001001
case ERIC_GLOBAL_PRUEF_FEHLER = 610001002
case ERIC_GLOBAL_HINWEISE = 610001003
case ERIC_GLOBAL_FEHLERMELDUNG_NICHT_VORHANDEN = 610001007
case ERIC_GLOBAL_KEINE_DATEN_VORHANDEN = 610001008
case ERIC_GLOBAL_NICHT_GENUEGEND_ARBEITSSPEICHER = 610001013
case ERIC_GLOBAL_DATEI_NICHT_GEFUNDEN = 610001014
case ERIC_GLOBAL_HERSTELLER_ID_NICHT_ERLAUBT = 610001016
case ERIC_GLOBAL_ILLEGAL_STATE = 610001017
case ERIC_GLOBAL_FUNKTION_NICHT_ERLAUBT = 610001018
case ERIC_GLOBAL_ECHTFALL_NICHT_ERLAUBT = 610001019
case ERIC_GLOBAL_NO_VERSAND_IN_BETA_VERSION = 610001020
case ERIC_GLOBAL_TESTMERKER_UNGUELTIG = 610001025
case ERIC_GLOBAL_DATENSATZ_ZU_GROSS = 610001026
case ERIC_GLOBAL_VERSCHLUESSELUNGS_PARAMETER_NICHT_ERLAUBT = 610001027
case ERIC_GLOBAL_NUR_PORTALZERTIFIKAT_ERLAUBT = 610001028
case ERIC_GLOBAL_ABRUFCODE_NICHT_ERLAUBT = 610001029
case ERIC_GLOBAL_ERROR_XML_CREATE = 610001030
case ERIC_GLOBAL_TEXTPUFFERGROESSE_FIX = 610001031
case ERIC_GLOBAL_INTERNER_FEHLER = 610001032
case ERIC_GLOBAL_ARITHMETIKFEHLER = 610001033
case ERIC_GLOBAL_STEUERNUMMER_UNGUELTIG = 610001034
case ERIC_GLOBAL_STEUERNUMMER_FALSCHE_LAENGE = 610001035
case ERIC_GLOBAL_STEUERNUMMER_NICHT_NUMERISCH = 610001036
case ERIC_GLOBAL_LANDESNUMMER_UNBEKANNT = 610001037
case ERIC_GLOBAL_BUFANR_UNBEKANNT = 610001038
case ERIC_GLOBAL_LANDESNUMMER_BUFANR = 610001039
case ERIC_GLOBAL_PUFFER_ZUGRIFFSKONFLIKT = 610001040
case ERIC_GLOBAL_PUFFER_UEBERLAUF = 610001041
case ERIC_GLOBAL_DATENARTVERSION_UNBEKANNT = 610001042
case ERIC_GLOBAL_DATENARTVERSION_XML_INKONSISTENT = 610001044
case ERIC_GLOBAL_COMMONDATA_NICHT_VERFUEGBAR = 610001045
case ERIC_GLOBAL_LOG_EXCEPTION = 610001046
case ERIC_GLOBAL_TRANSPORTSCHLUESSEL_NICHT_ERLAUBT = 610001047
case ERIC_GLOBAL_OEFFENTLICHER_SCHLUESSEL_UNGUELTIG = 610001048
case ERIC_GLOBAL_TRANSPORTSCHLUESSEL_TYP_FALSCH = 610001049
case ERIC_GLOBAL_PUFFER_UNGLEICHER_INSTANZ = 610001050
case ERIC_GLOBAL_VORSATZ_UNGUELTIG = 610001051
case ERIC_GLOBAL_DATEIZUGRIFF_VERWEIGERT = 610001053
case ERIC_GLOBAL_UNGUELTIGE_INSTANZ = 610001080
case ERIC_GLOBAL_NICHT_INITIALISIERT = 610001081
case ERIC_GLOBAL_MEHRFACHE_INITIALISIERUNG = 610001082
case ERIC_GLOBAL_FEHLER_INITIALISIERUNG = 610001083
case ERIC_GLOBAL_UNKNOWN_PARAMETER_ERROR = 610001102
case ERIC_GLOBAL_CHECK_CORRUPTED_NDS = 610001108
case ERIC_GLOBAL_VERSCHLUESSELUNGS_PARAMETER_NICHT_ANGEGEBEN = 610001206
case ERIC_GLOBAL_SEND_FLAG_MEHR_ALS_EINES = 610001209
case ERIC_GLOBAL_UNGUELTIGE_FLAG_KOMBINATION = 610001218
case ERIC_GLOBAL_ERSTE_SEITE_DRUCK_NICHT_UNTERSTUETZT = 610001220
case ERIC_GLOBAL_UNGUELTIGER_PARAMETER = 610001222
case ERIC_GLOBAL_DRUCK_FUER_VERFAHREN_NICHT_ERLAUBT = 610001224
case ERIC_GLOBAL_VERSAND_ART_NICHT_UNTERSTUETZT = 610001225
case ERIC_GLOBAL_UNGUELTIGE_PARAMETER_VERSION = 610001226
case ERIC_GLOBAL_TRANSFERHANDLE = 610001227
case ERIC_GLOBAL_PLUGININITIALISIERUNG = 610001228
case ERIC_GLOBAL_INKOMPATIBLE_VERSIONEN = 610001229
case ERIC_GLOBAL_VERSCHLUESSELUNGSVERFAHREN_NICHT_UNTERSTUETZT = 610001230
case ERIC_GLOBAL_MEHRFACHAUFRUFE_NICHT_UNTERSTUETZT = 610001231
case ERIC_GLOBAL_UTI_COUNTRY_NOT_SUPPORTED = 610001404
case ERIC_GLOBAL_IBAN_FORMALER_FEHLER = 610001501
case ERIC_GLOBAL_IBAN_LAENDERCODE_FEHLER = 610001502
case ERIC_GLOBAL_IBAN_LANDESFORMAT_FEHLER = 610001503
case ERIC_GLOBAL_IBAN_PRUEFZIFFER_FEHLER = 610001504
case ERIC_GLOBAL_BIC_FORMALER_FEHLER = 610001510
case ERIC_GLOBAL_BIC_LAENDERCODE_FEHLER = 610001511
case ERIC_GLOBAL_ZULASSUNGSNUMMER_ZU_LANG = 610001519
case ERIC_GLOBAL_IDNUMMER_UNGUELTIG = 610001525
case ERIC_GLOBAL_NULL_PARAMETER = 610001526
case ERIC_GLOBAL_EWAZ_UNGUELTIG = 610001527
case ERIC_GLOBAL_EWAZ_LANDESKUERZEL_UNBEKANNT = 610001528
case ERIC_GLOBAL_UPDATE_NECESSARY = 610001851
case ERIC_GLOBAL_EINSTELLUNG_NAME_UNGUELTIG = 610001860
case ERIC_GLOBAL_EINSTELLUNG_WERT_UNGUELTIG = 610001861
case ERIC_GLOBAL_ERR_DEKODIEREN = 610001862
case ERIC_GLOBAL_FUNKTION_NICHT_UNTERSTUETZT = 610001863
case ERIC_GLOBAL_NUTZDATENTICKETS_NICHT_EINDEUTIG = 610001865
case ERIC_GLOBAL_NUTZDATENHEADERVERSIONEN_UNEINHEITLICH = 610001866
case ERIC_GLOBAL_BUNDESLAENDER_UNEINHEITLICH = 610001867
case ERIC_GLOBAL_ZEITRAEUME_UNEINHEITLICH = 610001868
case ERIC_GLOBAL_NUTZDATENHEADER_EMPFAENGER_NICHT_KORREKT = 610001869
case ERIC_TRANSFER_COM_ERROR = 610101200
case ERIC_TRANSFER_VORGANG_NICHT_UNTERSTUETZT = 610101201
case ERIC_TRANSFER_ERR_XML_THEADER = 610101210
case ERIC_TRANSFER_ERR_PARAM = 610101251
case ERIC_TRANSFER_ERR_DATENTEILENDNOTFOUND = 610101253
case ERIC_TRANSFER_ERR_BEGINDATENLIEFERANT = 610101255
case ERIC_TRANSFER_ERR_ENDDATENLIEFERANT = 610101256
case ERIC_TRANSFER_ERR_BEGINTRANSPORTSCHLUESSEL = 610101257
case ERIC_TRANSFER_ERR_ENDTRANSPORTSCHLUESSEL = 610101258
case ERIC_TRANSFER_ERR_BEGINDATENGROESSE = 610101259
case ERIC_TRANSFER_ERR_ENDDATENGROESSE = 610101260
case ERIC_TRANSFER_ERR_SEND = 610101271
case ERIC_TRANSFER_ERR_NOTENCRYPTED = 610101274
case ERIC_TRANSFER_ERR_PROXYCONNECT = 610101276
case ERIC_TRANSFER_ERR_CONNECTSERVER = 610101278
case ERIC_TRANSFER_ERR_NORESPONSE = 610101279
case ERIC_TRANSFER_ERR_PROXYAUTH = 610101280
case ERIC_TRANSFER_ERR_SEND_INIT = 610101282
case ERIC_TRANSFER_ERR_TIMEOUT = 610101283
case ERIC_TRANSFER_ERR_PROXYPORT_INVALID = 610101284
case ERIC_TRANSFER_ERR_OTHER = 610101291
case ERIC_TRANSFER_ERR_XML_NHEADER = 610101292
case ERIC_TRANSFER_ERR_XML_ENCODING = 610101293
case ERIC_TRANSFER_ERR_ENDSIGUSER = 610101294
case ERIC_TRANSFER_ERR_XMLTAG_NICHT_GEFUNDEN = 610101295
case ERIC_TRANSFER_ERR_DATENTEILFEHLER = 610101297
case ERIC_TRANSFER_EID_ZERTIFIKATFEHLER = 610101500
case ERIC_TRANSFER_EID_KEINKONTO = 610101510
case ERIC_TRANSFER_EID_IDNRNICHTEINDEUTIG = 610101511
case ERIC_TRANSFER_EID_SERVERFEHLER = 610101512
case ERIC_TRANSFER_EID_KEINCLIENT = 610101520
case ERIC_TRANSFER_EID_CLIENTFEHLER = 610101521
case ERIC_TRANSFER_EID_FEHLENDEFELDER = 610101522
case ERIC_TRANSFER_EID_IDENTIFIKATIONABGEBROCHEN = 610101523
case ERIC_TRANSFER_EID_NPABLOCKIERT = 610101524
case ERIC_CRYPT_ERROR_CREATE_KEY = 610201016
case ERIC_CRYPT_E_INVALID_HANDLE = 610201101
case ERIC_CRYPT_E_MAX_SESSION = 610201102
case ERIC_CRYPT_E_BUSY = 610201103
case ERIC_CRYPT_E_OUT_OF_MEM = 610201104
case ERIC_CRYPT_E_PSE_PATH = 610201105
case ERIC_CRYPT_E_PIN_WRONG = 610201106
case ERIC_CRYPT_E_PIN_LOCKED = 610201107
case ERIC_CRYPT_E_P7_READ = 610201108
case ERIC_CRYPT_E_P7_DECODE = 610201109
case ERIC_CRYPT_E_P7_RECIPIENT = 610201110
case ERIC_CRYPT_E_P12_READ = 610201111
case ERIC_CRYPT_E_P12_DECODE = 610201112
case ERIC_CRYPT_E_P12_SIG_KEY = 610201113
case ERIC_CRYPT_E_P12_ENC_KEY = 610201114
case ERIC_CRYPT_E_P11_SIG_KEY = 610201115
case ERIC_CRYPT_E_P11_ENC_KEY = 610201116
case ERIC_CRYPT_E_XML_PARSE = 610201117
case ERIC_CRYPT_E_XML_SIG_ADD = 610201118
case ERIC_CRYPT_E_XML_SIG_TAG = 610201119
case ERIC_CRYPT_E_XML_SIG_SIGN = 610201120
case ERIC_CRYPT_E_ENCODE_UNKNOWN = 610201121
case ERIC_CRYPT_E_ENCODE_ERROR = 610201122
case ERIC_CRYPT_E_XML_INIT = 610201123
case ERIC_CRYPT_E_ENCRYPT = 610201124
case ERIC_CRYPT_E_DECRYPT = 610201125
case ERIC_CRYPT_E_P11_SLOT_EMPTY = 610201126
case ERIC_CRYPT_E_NO_SIG_ENC_KEY = 610201127
case ERIC_CRYPT_E_LOAD_DLL = 610201128
case ERIC_CRYPT_E_NO_SERVICE = 610201129
case ERIC_CRYPT_E_ESICL_EXCEPTION = 610201130
case ERIC_CRYPT_E_TOKEN_TYPE_MISMATCH = 610201144
case ERIC_CRYPT_E_P12_CREATE = 610201146
case ERIC_CRYPT_E_VERIFY_CERT_CHAIN = 610201147
case ERIC_CRYPT_E_P11_ENGINE_LOADED = 610201148
case ERIC_CRYPT_E_USER_CANCEL = 610201149
case ERIC_CRYPT_ZERTIFIKAT = 610201200
case ERIC_CRYPT_SIGNATUR = 610201201
case ERIC_CRYPT_NICHT_UNTERSTUETZTES_PSE_FORMAT = 610201203
case ERIC_CRYPT_PIN_BENOETIGT = 610201205
case ERIC_CRYPT_PIN_STAERKE_NICHT_AUSREICHEND = 610201206
case ERIC_CRYPT_E_INTERN = 610201208
case ERIC_CRYPT_ZERTIFIKATSPFAD_KEIN_VERZEICHNIS = 610201209
case ERIC_CRYPT_ZERTIFIKATSDATEI_EXISTIERT_BEREITS = 610201210
case ERIC_CRYPT_PIN_ENTHAELT_UNGUELTIGE_ZEICHEN = 610201211
case ERIC_CRYPT_E_INVALID_PARAM_ABC = 610201212
case ERIC_CRYPT_CORRUPTED = 610201213
case ERIC_CRYPT_EIDKARTE_NICHT_UNTERSTUETZT = 610201214
case ERIC_CRYPT_E_SC_SLOT_EMPTY = 610201215
case ERIC_CRYPT_E_SC_NO_APPLET = 610201216
case ERIC_CRYPT_E_SC_SESSION = 610201217
case ERIC_CRYPT_E_P11_NO_SIG_CERT = 610201218
case ERIC_CRYPT_E_P11_INIT_FAILED = 610201219
case ERIC_CRYPT_E_P11_NO_ENC_CERT = 610201220
case ERIC_CRYPT_E_P12_NO_SIG_CERT = 610201221
case ERIC_CRYPT_E_P12_NO_ENC_CERT = 610201222
case ERIC_CRYPT_E_SC_ENC_KEY = 610201223
case ERIC_CRYPT_E_SC_NO_SIG_CERT = 610201224
case ERIC_CRYPT_E_SC_NO_ENC_CERT = 610201225
case ERIC_CRYPT_E_SC_INIT_FAILED = 610201226
case ERIC_CRYPT_E_SC_SIG_KEY = 610201227
case ERIC_IO_FEHLER = 610301001
case ERIC_IO_DATEI_INKORREKT = 610301005
case ERIC_IO_PARSE_FEHLER = 610301006
case ERIC_IO_NDS_GENERIERUNG_FEHLGESCHLAGEN = 610301007
case ERIC_IO_MASTERDATENSERVICE_NICHT_VERFUEGBAR = 610301010
case ERIC_IO_STEUERZEICHEN_IM_NDS = 610301014
case ERIC_IO_VERSIONSINFORMATIONEN_NICHT_GEFUNDEN = 610301031
case ERIC_IO_FALSCHES_VERFAHREN = 610301104
case ERIC_IO_READER_MEHRFACHE_STEUERFAELLE = 610301105
case ERIC_IO_READER_UNERWARTETE_ELEMENTE = 610301106
case ERIC_IO_READER_FORMALE_FEHLER = 610301107
case ERIC_IO_READER_FALSCHES_ENCODING = 610301108
case ERIC_IO_READER_MEHRFACHE_NUTZDATEN_ELEMENTE = 610301109
case ERIC_IO_READER_MEHRFACHE_NUTZDATENBLOCK_ELEMENTE = 610301110
case ERIC_IO_UNBEKANNTE_DATENART = 610301111
case ERIC_IO_READER_UNTERSACHBEREICH_UNGUELTIG = 610301114
case ERIC_IO_READER_ZU_VIELE_NUTZDATENBLOCK_ELEMENTE = 610301115
case ERIC_IO_READER_STEUERZEICHEN_IM_TRANSFERHEADER = 610301150
case ERIC_IO_READER_STEUERZEICHEN_IM_NUTZDATENHEADER = 610301151
case ERIC_IO_READER_STEUERZEICHEN_IN_DEN_NUTZDATEN = 610301152
case ERIC_IO_READER_ZU_VIELE_ANHAENGE = 610301190
case ERIC_IO_READER_ANHANG_ZU_GROSS = 610301191
case ERIC_IO_READER_ANHAENGE_ZU_GROSS = 610301192
case ERIC_IO_READER_SCHEMA_VALIDIERUNGSFEHLER = 610301200
case ERIC_IO_READER_UNBEKANNTE_XML_ENTITY = 610301201
case ERIC_IO_DATENTEILNOTFOUND = 610301252
case ERIC_IO_DATENTEILENDNOTFOUND = 610301253
case ERIC_IO_UEBERGABEPARAMETER_FEHLERHAFT = 610301300
case ERIC_IO_UNGUELTIGE_UTF8_SEQUENZ = 610301400
case ERIC_IO_UNGUELTIGE_ZEICHEN_IN_PARAMETER = 610301401
case ERIC_PRINT_INTERNER_FEHLER = 610501001
case ERIC_PRINT_DRUCKVORLAGE_NICHT_GEFUNDEN = 610501002
case ERIC_PRINT_UNGUELTIGER_DATEI_PFAD = 610501004
case ERIC_PRINT_INITIALISIERUNG_FEHLERHAFT = 610501007
case ERIC_PRINT_AUSGABEZIEL_UNBEKANNT = 610501008
case ERIC_PRINT_ABBRUCH_DRUCKVORBEREITUNG = 610501009
case ERIC_PRINT_ABBRUCH_GENERIERUNG = 610501010
case ERIC_PRINT_STEUERFALL_NICHT_UNTERSTUETZT = 610501011
case ERIC_PRINT_FUSSTEXT_ZU_LANG = 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.")
public class EricBearbeiteVorgang : Codable
{
/**
* Information from the successful processing a tax declaration.
*/
// @ApiMember(Description="Information from the successful processing a tax declaration.")
public var erfolg:Erfolg
/**
* 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 var transfers:Transfers
/**
* 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 var fehlerRegelpruefungen:[FehlerRegelpruefung] = []
/**
* Hints that result the processing of a tax declaration.
*/
// @ApiMember(Description="Hints that result the processing of a tax declaration.")
public var hinweise:[Hinweis] = []
required public init(){}
}
/**
* Represents information returned from a successful tax declaration process.
*/
// @Api(Description="Represents information returned from a successful tax declaration process.")
public class Erfolg : Codable
{
/**
* The generated tele-number for the successful tax declaration process.
*/
// @ApiMember(Description="The generated tele-number for the successful tax declaration process.")
public var telenummer:[String] = []
/**
* The classification key for the successful tax declaration process.
*/
// @ApiMember(Description="The classification key for the successful tax declaration process.")
public var ordnungsbegriffe:[String] = []
required public init(){}
}
/**
* 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 class Transfers : Codable
{
/**
* 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 var transferList:[Transfer] = []
required public init(){}
}
/**
* Represents information on the delivery.
*/
// @Api(Description="Represents information on the delivery.")
public class Transfer : Codable
{
/**
* The ticket of the transfer.
*/
// @ApiMember(Description="The ticket of the transfer.")
public var transferTicket:String
required public init(){}
}
/**
* Represents information on an ERiC reference.
*/
// @Api(Description="Represents information on an ERiC reference.")
public class FehlerRegelpruefung : Codable
{
/**
* The user data ticket of the reference.
*/
// @ApiMember(Description="The user data ticket of the reference.")
public var nutzdatenticket:String
/**
* The field identifier of the reference.
*/
// @ApiMember(Description="The field identifier of the reference.")
public var feldidentifikator:String
/**
* The multi-line index of the reference.
*/
// @ApiMember(Description="The multi-line index of the reference.")
public var mehrfachzeilenindex:String
/**
* The delivery number form of the reference.
*/
// @ApiMember(Description="The delivery number form of the reference.")
public var lfdNrVordruck:String
/**
* 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 var vordruckZeilennummer:String
/**
* 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 var semantischeIndexes:[SemantischerIndex] = []
/**
* The sub-subject-area of the reference.
*/
// @ApiMember(Description="The sub-subject-area of the reference.")
public var untersachbereich:String
/**
* The private identification number of the reference.
*/
// @ApiMember(Description="The private identification number of the reference.")
public var privateKennnummer:String
/**
* The name of the rule that applies to the reference.
*/
// @ApiMember(Description="The name of the rule that applies to the reference.")
public var regelName:String
/**
* The technical error identifier of the reference.
*/
// @ApiMember(Description="The technical error identifier of the reference.")
public var fachlicheFehlerId:String
/**
* The textual details of the reference.
*/
// @ApiMember(Description="The textual details of the reference.")
public var text:String
required public init(){}
}
/**
* 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 class SemantischerIndex : Codable
{
/**
* The name of the index field.
*/
// @ApiMember(Description="The name of the index field.")
public var name:String
/**
* The value of the index field.
*/
// @ApiMember(Description="The value of the index field.")
public var value:String
required public init(){}
}
public class Hinweis : Codable
{
/**
* The user data ticket of the reference.
*/
// @ApiMember(Description="The user data ticket of the reference.")
public var nutzdatenticket:String
/**
* The field identifier of the reference.
*/
// @ApiMember(Description="The field identifier of the reference.")
public var feldidentifikator:String
/**
* The multi-line index of the reference.
*/
// @ApiMember(Description="The multi-line index of the reference.")
public var mehrfachzeilenindex:String
/**
* The delivery number form of the reference.
*/
// @ApiMember(Description="The delivery number form of the reference.")
public var lfdNrVordruck:String
/**
* 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 var vordruckZeilennummer:String
/**
* 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 var semantischeIndexes:[SemantischerIndex] = []
/**
* The sub-subject-area of the reference.
*/
// @ApiMember(Description="The sub-subject-area of the reference.")
public var untersachbereich:String
/**
* The private identification number of the reference.
*/
// @ApiMember(Description="The private identification number of the reference.")
public var privateKennnummer:String
/**
* The name of the rule that applies to the reference.
*/
// @ApiMember(Description="The name of the rule that applies to the reference.")
public var regelName:String
/**
* The technical note identifier of the reference.
*/
// @ApiMember(Description="The technical note identifier of the reference.")
public var fachlicheHinweisId:String
/**
* The textual details of the reference.
*/
// @ApiMember(Description="The textual details of the reference.")
public var text:String
required public init(){}
}
/**
* Represents an ELSTER document.
*/
// @Api(Description="Represents an ELSTER document.")
public class Elster : Codable
{
/**
* The transfer header part of the ELSTER document.
*/
// @ApiMember(Description="The transfer header part of the ELSTER document.", IsRequired=true)
public var transferHeader:TransferHeader
/**
* The data (facts) part of the ELSTER document.
*/
// @ApiMember(Description="The data (facts) part of the ELSTER document.")
public var datenTeil:DatenTeil
required public init(){}
}
/**
* Represents the transfer header part of an ELSTER document.
*/
// @Api(Description="Represents the transfer header part of an ELSTER document.")
public class TransferHeader : Codable
{
/**
* The version of the transfer header.
*/
// @ApiMember(Description="The version of the transfer header.", IsRequired=true)
public var version:String
/**
* The tax operation used in the ELSTER process.
*/
// @ApiMember(Description="The tax operation used in the ELSTER process.", IsRequired=true)
public var verfahren:Verfahren
/**
* The tax data type of the ELSTER process.
*/
// @ApiMember(Description="The tax data type of the ELSTER process.", IsRequired=true)
public var datenArt:Datenart
/**
* The authentification procedure of the ELSTER process.
*/
// @ApiMember(Description="The authentification procedure of the ELSTER process.", IsRequired=true)
public var vorgang:Vorgang
/**
* The ticket identifier after a successful ELSTER process.
*/
// @ApiMember(Description="The ticket identifier after a successful ELSTER process.")
public var transferTicket:String
/**
* 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 var testmerker:Testmerker?
/**
* 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 var sigUser:SigUser
/**
* The receiving ELSTER server.
*/
// @ApiMember(Description="The receiving ELSTER server.")
public var empfaenger:Empfaenger
/**
* 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 var herstellerID:String
/**
* The details of the provider that submits tax data.
*/
// @ApiMember(Description="The details of the provider that submits tax data.", IsRequired=true)
public var datenLieferant:String
/**
* The date of receipt of the tax data.
*/
// @ApiMember(Description="The date of receipt of the tax data.")
public var eingangsDatum:Date?
/**
* The encryption data required for authenticated transmission of tax data.
*/
// @ApiMember(Description="The encryption data required for authenticated transmission of tax data.")
public var datei:Datei
/**
* 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 var rc:RC
/**
* The details of the software that submits the tax data.
*/
// @ApiMember(Description="The details of the software that submits the tax data.")
public var versionClient:String
/**
* Data extensions to the transfer header.
*/
// @ApiMember(Description="Data extensions to the transfer header.")
public var zusatz:Zusatz
required public init(){}
}
/**
* Auflistung der gültigen Verfahren
*/
public enum Verfahren : String, Codable
{
case ElsterAnmeldung
case ElsterBereitstellung
case ElsterBilanz
case ElsterBRM
case ElsterBRMOrg
case ElsterDatenabholung
case ElsterErklaerung
case ElsterExtern
case ElsterFSE
case ElsterKapESt
case ElsterKMV
case ElsterKontoabfrage
case ElsterLavendel
case ElsterLohn
case ElsterLohn2
case ElsterNachricht
case ElsterSignatur
case ElsterVollmachtDB
}
/**
* Hauptinformation ob die Daten authentifiziert wurden (send-Auth) oder nicht (send-NoSig)
*/
public enum Vorgang : String, Codable
{
case Send_Auth
case Send_Auth_Part
case Send_NoSig
case Send_NoSig_Part
}
/**
* 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 enum Testmerker : Int, Codable
{
case TM010000001 = 10000001
case TM080000001 = 80000001
case TM160000001 = 160000001
case TM160000002 = 160000002
case TM220000000 = 220000000
case TM220002000 = 220002000
case TM230000001 = 230000001
case TM240000000 = 240000000
case TM370000001 = 370000001
case TM520000000 = 520000000
case TM700000001 = 700000001
case 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.")
public class SigUser : Codable
{
//inhalt:Object ignored. Type could not be extended in Swift
required public init(){}
}
/**
* Represents a receiver of tax data.
*/
// @Api(Description="Represents a receiver of tax data.")
public class Empfaenger : Codable
{
/**
* The identifier of the receiver.
*/
// @ApiMember(Description="The identifier of the receiver.")
public var id:String
/**
* The destination of the receiver.
*/
// @ApiMember(Description="The destination of the receiver.")
public var ziel:Bundesland?
required public init(){}
}
/**
* Einheitliche Abkürzungen fuer die Bundesländer bzw. alternative Empfänger
*/
public enum Bundesland : String, Codable
{
case BW
case BY
case BE
case BB
case HB
case HH
case HE
case MV
case NI
case NW
case RP
case SL
case SN
case ST
case SH
case TH
case EC
case BF
case CS
case CD
case CM
case CN
case DS
case OP
case TK
case ZF
}
/**
* Represents information on the encryption of tax data.
*/
// @Api(Description="Represents information on the encryption of tax data.")
public class Datei : Codable
{
/**
* The type of data encryption used.
*/
// @ApiMember(Description="The type of data encryption used.")
public var verschluesselung:Verschluesselungsart
/**
* The type of data compression used.
*/
// @ApiMember(Description="The type of data compression used.")
public var kompression:Kompression
/**
* The transport key used in the encryption.
*/
// @ApiMember(Description="The transport key used in the encryption.")
public var transportSchluessel:String
/**
* [Documentation unavailable]
*/
// @ApiMember(Description="[Documentation unavailable]")
public var erstellung:Erstellung
required public init(){}
}
/**
* 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 enum Verschluesselungsart : String, Codable
{
case PKCS_7v1_5
case PKCS_7v1_5enveloped
case NO_BASE64
case CMSEncryptedData
case CMSEnvelopedData
case EnvelopedData__RSA_OAEP__AES_128__GZip__B64
}
/**
* Mit welcher Kompression wurden die Inhalte von den Elementen DatenLieferant und ggf. SigUser im TransferHeader und dem Element DatenTeil komprimiert.
*/
public enum Kompression : String, Codable
{
case GZIP
case NO_BASE64
}
/**
* [Documentation unavailable]
*/
// @Api(Description="[Documentation unavailable]")
public class Erstellung : Codable
{
/**
* [Documentation unavailable]
*/
// @ApiMember(Description="[Documentation unavailable]")
public var eric:EricTyp
required public init(){}
}
/**
* [Documentation unavailable]
*/
// @Api(Description="[Documentation unavailable]")
public class EricTyp : Codable
{
//inhalt:Object ignored. Type could not be extended in Swift
required public init(){}
}
/**
* Represents an ERiC return code.
*/
// @Api(Description="Represents an ERiC return code.")
public class RC : Codable
{
/**
* The return value of the return code.
*/
// @ApiMember(Description="The return value of the return code.")
public var rueckgabe:Rueckgabe
/**
* The internal value of the return code.
*/
// @ApiMember(Description="The internal value of the return code.")
public var stack:Stack
required public init(){}
}
/**
* Represents an external error stack.
*/
// @Api(Description="Represents an external error stack.")
public class Rueckgabe : Codable
{
/**
* 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 var code:String
/**
* The external error message.
*/
// @ApiMember(Description="The external error message.")
public var text:String
required public init(){}
}
/**
* Represents an internal error stack.
*/
// @Api(Description="Represents an internal error stack.")
public class Stack : Codable
{
/**
* 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 var code:String
/**
* The external error message.
*/
// @ApiMember(Description="The external error message.")
public var text:String
required public init(){}
}
/**
* Represents an ERiC extension.
*/
// @Api(Description="Represents an ERiC extension.")
public class Zusatz : Codable
{
/**
* 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 var infos:[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).")
public var elsterInfos:[String] = []
required public init(){}
}
/**
* Represents the data part of an ELSTER document.
*/
// @Api(Description="Represents the data part of an ELSTER document.")
public class DatenTeil : Codable
{
/**
* The blocks of tax data of the ELSTER document.
*/
// @ApiMember(Description="The blocks of tax data of the ELSTER document.", IsRequired=true)
public var nutzdatenbloecke:[Nutzdatenblock] = []
required public init(){}
}
/**
* Represents a block of tax data.
*/
// @Api(Description="Represents a block of tax data.")
public class Nutzdatenblock : Codable
{
/**
* The header part of the block.
*/
// @ApiMember(Description="The header part of the block.", IsRequired=true)
public var nutzdatenHeader:NutzdatenHeader
/**
* The data part of the block.
*/
// @ApiMember(Description="The data part of the block.", IsRequired=true)
public var nutzdaten:Nutzdaten
required public init(){}
}
/**
* Represents the header of a tax data.
*/
// @Api(Description="Represents the header of a tax data.")
public class NutzdatenHeader : Codable
{
/**
* The version of the header.
*/
// @ApiMember(Description="The version of the header.", IsRequired=true)
public var version:String
/**
* The ticket identifier of the header.
*/
// @ApiMember(Description="The ticket identifier of the header.", IsRequired=true)
public var nutzdatenTicket:String
/**
* The receiver of the header.
*/
// @ApiMember(Description="The receiver of the header.", IsRequired=true)
public var empfaenger:NDHEmpfaenger
/**
* 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 var hersteller:Hersteller
/**
* 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 var datenLieferant:String
/**
* The return code of the header.
*/
// @ApiMember(Description="The return code of the header.")
public var rc:RC
/**
* The data extensions of the header.
*/
// @ApiMember(Description="The data extensions of the header.")
public var zusatz:Zusatz
required public init(){}
}
/**
* Represents a receiver of tax data.
*/
// @Api(Description="Represents a receiver of tax data.")
public class NDHEmpfaenger : Codable
{
/**
* The identifier of the receiver.
*/
// @ApiMember(Description="The identifier of the receiver.")
public var id:EmpfaengerID
/**
* The value of the receiver.
*/
// @ApiMember(Description="The value of the receiver.")
public var value:String
required public init(){}
}
/**
* Represents a receriver ID
*/
public enum EmpfaengerID : String, Codable
{
case L
case F
}
/**
* Represents a manufacturer/vendor of tax software.
*/
// @Api(Description="Represents a manufacturer/vendor of tax software.")
public class Hersteller : Codable
{
/**
* 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 var produktName:String
/**
* 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 var produktVersion:String
required public init(){}
}
/**
* Represents an encapsulation of tax data content.
*/
// @Api(Description="Represents an encapsulation of tax data content.")
public class Nutzdaten : Codable
{
//inhalt:Object ignored. Type could not be extended in Swift
required public init(){}
}
/**
* 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 class Abholung17 : Abholung
{
/**
* The tax type (e.g. ESB) of the data record.
*/
// @ApiMember(Description="The tax type (e.g. ESB) of the data record.")
public var steuerart:Steuerart?
/**
* The meta information of the identifier.
*/
// @ApiMember(Description="The meta information of the identifier.")
public var metaInformationen:MetaInformationen17
/**
* 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 var bereitstellungsticket:String
/**
* The attachments of the data records.
*/
// @ApiMember(Description="The attachments of the data records.")
public var anhaenge:Anhaenge17
/**
* The identifier of the data record.
*/
// @ApiMember(Description="The identifier of the data record.")
public var id:String
/**
* 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 var idnr:String
/**
* 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 var veranlagungsjahr:Int?
/**
* The transmission path used.
*/
// @ApiMember(Description="The transmission path used.")
public var uebertragungsweg:Uebertragungsweg?
/**
* 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 var encoding:String
/**
* The client number; only applicable to the tax type 'ElsterDIVADaten'.
*/
// @ApiMember(Description="The client number; only applicable to the tax type 'ElsterDIVADaten'.")
public var mandantennummer:String
/**
* The tax number; only applicable to the tax type 'ElsterDIVADaten'.
*/
// @ApiMember(Description="The tax number; only applicable to the tax type 'ElsterDIVADaten'.")
public var steuernummer:String
/**
* The asessment date; only applicable to the tax type 'ElsterDIVADaten'.
*/
// @ApiMember(Description="The asessment date; only applicable to the tax type 'ElsterDIVADaten'.")
public var bescheiddatum:Date?
/**
* 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 var datenpaket:Datenpaket
/**
* 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 var download:Download
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case steuerart
case metaInformationen
case bereitstellungsticket
case anhaenge
case id
case idnr
case veranlagungsjahr
case uebertragungsweg
case encoding
case mandantennummer
case steuernummer
case bescheiddatum
case datenpaket
case download
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
steuerart = try container.decodeIfPresent(Steuerart.self, forKey: .steuerart)
metaInformationen = try container.decodeIfPresent(MetaInformationen17.self, forKey: .metaInformationen)
bereitstellungsticket = try container.decodeIfPresent(String.self, forKey: .bereitstellungsticket)
anhaenge = try container.decodeIfPresent(Anhaenge17.self, forKey: .anhaenge)
id = try container.decodeIfPresent(String.self, forKey: .id)
idnr = try container.decodeIfPresent(String.self, forKey: .idnr)
veranlagungsjahr = try container.decodeIfPresent(Int.self, forKey: .veranlagungsjahr)
uebertragungsweg = try container.decodeIfPresent(Uebertragungsweg.self, forKey: .uebertragungsweg)
encoding = try container.decodeIfPresent(String.self, forKey: .encoding)
mandantennummer = try container.decodeIfPresent(String.self, forKey: .mandantennummer)
steuernummer = try container.decodeIfPresent(String.self, forKey: .steuernummer)
bescheiddatum = try container.decodeIfPresent(Date.self, forKey: .bescheiddatum)
datenpaket = try container.decodeIfPresent(Datenpaket.self, forKey: .datenpaket)
download = try container.decodeIfPresent(Download.self, forKey: .download)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if steuerart != nil { try container.encode(steuerart, forKey: .steuerart) }
if metaInformationen != nil { try container.encode(metaInformationen, forKey: .metaInformationen) }
if bereitstellungsticket != nil { try container.encode(bereitstellungsticket, forKey: .bereitstellungsticket) }
if anhaenge != nil { try container.encode(anhaenge, forKey: .anhaenge) }
if id != nil { try container.encode(id, forKey: .id) }
if idnr != nil { try container.encode(idnr, forKey: .idnr) }
if veranlagungsjahr != nil { try container.encode(veranlagungsjahr, forKey: .veranlagungsjahr) }
if uebertragungsweg != nil { try container.encode(uebertragungsweg, forKey: .uebertragungsweg) }
if encoding != nil { try container.encode(encoding, forKey: .encoding) }
if mandantennummer != nil { try container.encode(mandantennummer, forKey: .mandantennummer) }
if steuernummer != nil { try container.encode(steuernummer, forKey: .steuernummer) }
if bescheiddatum != nil { try container.encode(bescheiddatum, forKey: .bescheiddatum) }
if datenpaket != nil { try container.encode(datenpaket, forKey: .datenpaket) }
if download != nil { try container.encode(download, forKey: .download) }
}
}
/**
* 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 class Abholung : Codable
{
/**
* The identifier of the data record.
*/
// @ApiMember(Description="The identifier of the data record.")
public var id:String
/**
* 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 var idnr:String
/**
* 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 var veranlagungsjahr:Int?
/**
* The transmission path used.
*/
// @ApiMember(Description="The transmission path used.")
public var uebertragungsweg:Uebertragungsweg?
/**
* 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 var encoding:String
/**
* The client number; only applicable to the tax type 'ElsterDIVADaten'.
*/
// @ApiMember(Description="The client number; only applicable to the tax type 'ElsterDIVADaten'.")
public var mandantennummer:String
/**
* The tax number; only applicable to the tax type 'ElsterDIVADaten'.
*/
// @ApiMember(Description="The tax number; only applicable to the tax type 'ElsterDIVADaten'.")
public var steuernummer:String
/**
* The asessment date; only applicable to the tax type 'ElsterDIVADaten'.
*/
// @ApiMember(Description="The asessment date; only applicable to the tax type 'ElsterDIVADaten'.")
public var bescheiddatum:Date?
/**
* 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 var datenpaket:Datenpaket
/**
* 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 var download:Download
required public init(){}
}
/**
* Represents the transmission path.
*/
public enum Uebertragungsweg : String, Codable
{
case direkt
case link
case sammellink
}
/**
* The data packet from the retrieval operation.
*/
// @Api(Description="The data packet from the retrieval operation.")
public class Datenpaket : Codable
{
/**
* Encoded (compressed and encrypted) requested data record
*/
// @ApiMember(Description="Encoded (compressed and encrypted) requested data record")
public var value:String
required public init(){}
}
/**
* 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 class Download : Codable
{
/**
* The link to the data on the web server.
*/
// @ApiMember(Description="The link to the data on the web server.")
public var url:String
/**
* The user name for the web server.
*/
// @ApiMember(Description="The user name for the web server.")
public var benutzer:String
/**
* Password for the web server.
*/
// @ApiMember(Description="Password for the web server.")
public var passwort:String
required public init(){}
}
/**
* Represents the various tax types for the retrieval of data.
*/
public enum Steuerart : String, Codable
{
case ESB
case GSB
case USB
case EPBescheid
case EPMitteilung
case Gewerbesteuerbescheid
case Gewerbesteuermitteilung
case GEWMB
case DIVAAnzeigeEinerLotterie
case DIVABescheid
case DivaBescheidESt
case DIVABuchmachersteuer
case DIVALotteriesteuerEinmal
case DIVALotteriesteuerMehr
case DIVASportwettensteuer
case DIVATotalisator
case OZGBescheid
case VerbindlicheAuskunft
case VerbindlicheZusage
case DivaSonstigerVA
case DivaBescheidErbSt
case DivaBescheidFEIN
case DivaBescheidGewSt
case DivaBescheidKSt
case DivaBescheidUSt
case DivaBescheidSchenkSt
case DIVATroncabgabe
case DIVAVirtuelleAutomatenStB
case DIVAOnlinePokerStB
case LStHVVMRM
case EinlagenrueckgewaehrVA
case FTTMeldungVA
case StatusInvStGVA
case UStVEUVA
case VERSVA
case AltZertVA
case KapEStEntlastungVA
case PostUDLVA
case StAb50aVA
case StAbEntlastungVA
case KassenangelegenheitenVA
case KStOptVA
case SteueroasenabwehrVA
case KDBVollmachtRM
case STBKE
case VDBKDBRueckmeldungLief
case AnhangRueckmeldung
case DivaEinwilligungRM
case GlueckspielF
case OZGMitteilung
case VerbindlicheAuskunftInfoF
case ELOProtokoll
}
/**
* Represents meta information.
*/
// @Api(Description="Represents meta information.")
public class MetaInformationen17 : Codable
{
/**
* List of metadata.
*/
// @ApiMember(Description="List of metadata.")
public var meta:[Meta17] = []
/**
* List of meta infomation maps.
*/
// @ApiMember(Description="List of meta infomation maps.")
public var metaInfoMaps:MetaInfoMaps17
required public init(){}
}
/**
* Represents the metadata of a data record.
*/
// @Api(Description="Represents the metadata of a data record.")
public class Meta17 : Codable
{
/**
* The type of metadata, e.g. datei [file]
*/
// @ApiMember(Description="The type of metadata, e.g. datei [file]")
public var name:String
/**
* The encoding of the metadata (text or base64)
*/
// @ApiMember(Description="The encoding of the metadata (text or base64)")
public var coding:Coding?
/**
* The content of the metadata
*/
// @ApiMember(Description="The content of the metadata")
public var value:String
required public init(){}
}
/**
* Specifies the encoding of the metadata.
*/
public enum Coding : String, Codable
{
case text
case base64
}
/**
* Represents a list of meta information maps.
*/
public class MetaInfoMaps17 : Codable
{
required public init(){}
}
/**
* Represents a list of attachments.
*/
public class Anhaenge17 : Codable
{
required public init(){}
}
Swift 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"}}}