Tax Filing Service
| POST | /BatchValidiereAuthentifiziereUndSende |
|---|
import Foundation
import ServiceStack
/**
* A synchronous service to validate, authenticate and send tax data to the fiscal authorities.
*/
// @Api(Description="A synchronous service to validate, authenticate and send tax data to the fiscal authorities.")
public class BatchValidiereAuthentifiziereUndSende : BatchValidiereAuthentifiziereUndSendeBase
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
/**
* 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.")
public var zertifikat:PortalCertificate
/**
* The details of the provider that submits tax data.
*/
// @ApiMember(Description="The details of the provider that submits tax data.")
public var datenLieferant:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case zertifikat
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)
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 datenLieferant != nil { try container.encode(datenLieferant, forKey: .datenLieferant) }
}
}
/**
* 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.")
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
{
/**
* The file name of the certificate.
*/
// @ApiMember(Description="The file name of the certificate.")
// @StringLength(128)
public var name:String
/**
* 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] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case name
case pin
case Description
case tags
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
name = try container.decodeIfPresent(String.self, forKey: .name)
pin = try container.decodeIfPresent(String.self, forKey: .pin)
Description = try container.decodeIfPresent(String.self, forKey: .Description)
tags = try container.decodeIfPresent([String].self, forKey: .tags) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if name != nil { try container.encode(name, forKey: .name) }
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) }
}
}
/**
* 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 in bytes.
*/
// @ApiMember(Description="The raw data content of the file in bytes.", Name="Content")
public var content:[UInt8]
required public init(){}
}
Swift BatchValidiereAuthentifiziereUndSende DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /BatchValidiereAuthentifiziereUndSende HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
zertifikat:
{
name: String,
pin: String,
description: String,
tags:
[
String
],
content: AA==
},
datenLieferant: String,
data:
[
{
id: String,
content: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: String
},
herstellerID: String,
datenLieferant: String,
eingangsDatum: 0001-01-01,
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: 0001-01-01,
lastAccessTimeUtc: 0001-01-01,
lastWriteTime: 0001-01-01,
lastWriteTimeUtc: 0001-01-01,
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
}
}
}
]