Tax Filing Service
| POST | /BatchValidiereAuthentifiziereUndSendeAsync |
|---|
import Foundation
import ServiceStack
/**
* An asynchronous service to validate, authenticate and send tax data to the fiscal authorities.
*/
// @Api(Description="An asynchronous service to validate, authenticate and send tax data to the fiscal authorities.")
public class BatchValidiereAuthentifiziereUndSendeAsync : BatchValidiereAuthentifiziereUndSendeBase
{
/**
* The authentification certificate.
*/
// @ApiMember(Description="The authentification certificate.", Name="Zertifikat")
public var zertifikat:PortalCertificate
/**
* Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data 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="Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data 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 tax data.
*/
// @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
public var datenLieferant:String
/**
* Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
*/
// @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
public var stagingEnabled:Bool?
/**
* The batch of tax data to process.
*/
// @ApiMember(Description="The batch of tax data to process.", Name="Data")
public var data:[TaxData] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case zertifikat
case abrufCode
case datenLieferant
case stagingEnabled
case data
}
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)
stagingEnabled = try container.decodeIfPresent(Bool.self, forKey: .stagingEnabled)
data = try container.decodeIfPresent([TaxData].self, forKey: .data) ?? []
}
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) }
if stagingEnabled != nil { try container.encode(stagingEnabled, forKey: .stagingEnabled) }
if data.count > 0 { try container.encode(data, forKey: .data) }
}
}
/**
* A base service to validate, authenticate and send tax data to the fiscal authorities.
*/
// @Api(Description="A base service to validate, authenticate and send tax data to the fiscal authorities.")
public class BatchValidiereAuthentifiziereUndSendeBase : BatchBearbeiteVorgangBase, IVeschlueselungsRequest, ISendeRequest
{
/**
* The authentification certificate.
*/
// @ApiMember(Description="The authentification certificate.", Name="Zertifikat")
public var zertifikat:PortalCertificate
/**
* Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data 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="Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data 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 tax data.
*/
// @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
public var datenLieferant:String
/**
* Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
*/
// @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
public var stagingEnabled:Bool?
/**
* The batch of tax data to process.
*/
// @ApiMember(Description="The batch of tax data to process.", Name="Data")
public var data:[TaxData] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case zertifikat
case abrufCode
case datenLieferant
case stagingEnabled
case data
}
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)
stagingEnabled = try container.decodeIfPresent(Bool.self, forKey: .stagingEnabled)
data = try container.decodeIfPresent([TaxData].self, forKey: .data) ?? []
}
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) }
if stagingEnabled != nil { try container.encode(stagingEnabled, forKey: .stagingEnabled) }
if data.count > 0 { try container.encode(data, forKey: .data) }
}
}
/**
* A base service to process a batch of tax data.
*/
// @Api(Description="A base service to process a batch of tax data.")
public class BatchBearbeiteVorgangBase : IPost, Codable
{
/**
* The batch of tax data to process.
*/
// @ApiMember(Description="The batch of tax data to process.", Name="Data")
public var data:[TaxData] = []
required public init(){}
}
/**
* Represents a structure that encapsulates a tax declaration.
*/
// @Api(Description="Represents a structure that encapsulates a tax declaration.")
public class TaxData : Codable
{
/**
* The unique identifier of the tax data.
*/
// @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
public var id:String
/**
* The XML-based tax declaration.
*/
// @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
public var content: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(){}
}
Swift BatchValidiereAuthentifiziereUndSendeAsync 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 /BatchValidiereAuthentifiziereUndSendeAsync HTTP/1.1
Host: taxfiling.pwc.de
Accept: application/json
Content-Type: application/json
Content-Length: length
{"zertifikat":{"id":"00000000000000000000000000000000","index":0,"pin":"String","description":"String","tags":["String"],"name":"String","content":"AA=="},"abrufCode":"String","datenLieferant":"String","stagingEnabled":false,"data":[{"id":"String","content":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
[{"rueckgabe":{"erfolg":{"telenummer":["String"],"ordnungsbegriffe":["String"]},"transfers":{"transferList":[{"transferTicket":"String"}]},"fehlerRegelpruefungen":[{"nutzdatenticket":"String","feldidentifikator":"String","mehrfachzeilenindex":"String","lfdNrVordruck":"String","vordruckZeilennummer":"String","semantischeIndexes":[{"name":"String","value":"String"}],"untersachbereich":"String","privateKennnummer":"String","regelName":"String","fachlicheFehlerId":"String","text":"String"}],"hinweise":[{"nutzdatenticket":"String","feldidentifikator":"String","mehrfachzeilenindex":"String","lfdNrVordruck":"String","vordruckZeilennummer":"String","semantischeIndexes":[{"name":"String","value":"String"}],"untersachbereich":"String","privateKennnummer":"String","regelName":"String","fachlicheHinweisId":"String","text":"String"}]},"serverantwort":{"transferHeader":{"version":"String","verfahren":"ElsterAnmeldung","datenArt":"34a","vorgang":"send-Auth","transferTicket":"String","testmerker":"0","sigUser":{"inhalt":{}},"empfaenger":{"id":"String","ziel":"BW"},"herstellerID":"String","datenLieferant":"String","eingangsDatum":"\/Date(-62135596800000-0000)\/","datei":{"verschluesselung":"PKCS#7v1.5","kompression":"GZIP","transportSchluessel":"String","erstellung":{"eric":{"inhalt":{}}}},"rc":{"rueckgabe":{"code":"String","text":"String"},"stack":{"code":"String","text":"String"}},"versionClient":"String","zusatz":{"infos":["String"],"elsterInfos":["String"]}},"datenTeil":{"nutzdatenbloecke":[{"nutzdatenHeader":{"version":"String","nutzdatenTicket":"String","empfaenger":{"id":"L","value":"String"},"hersteller":{"produktName":"String","produktVersion":"String"},"datenLieferant":"String","rc":{"rueckgabe":{"code":"String","text":"String"},"stack":{"code":"String","text":"String"}},"zusatz":{"infos":["String"],"elsterInfos":["String"]}},"nutzdaten":{"inhalt":{}}}]}},"transferProtocols":[{"metadata":{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","length":0,"userId":0,"groupId":0,"othersCanRead":false,"groupCanExecute":false,"groupCanWrite":false,"groupCanRead":false,"ownerCanExecute":false,"ownerCanWrite":false,"ownerCanRead":false,"othersCanExecute":false,"othersCanWrite":false,"extensions":{"String":"String"}},"name":"String","content":"AA=="}],"statusCode":"ERIC_OK","statusText":"String","id":"String","index":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]