Tax Filing Service
| POST | /BatchValidiereUndSende | A synchronous service to validate and send batch of tax data. |
|---|
import Foundation
import ServiceStack
/**
* A synchronous service to validate and send batch of tax data.
*/
// @Api(Description="A synchronous service to validate and send batch of tax data.")
public class BatchValidiereUndSende : BatchValidiereUndSendeBase
{
/**
* Name prefix of the generated transfer protocol file.
*/
// @ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")
public var protocolPrefix:String
/**
* Footer text to be used on the printout (optional).
*/
// @ApiMember(Description="Footer text to be used on the printout (optional).", Name="FussText")
public var fussText:String
/**
* Should the PDF file be prepared for a double-sided printout with a margin for punching?. True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.
*/
// @ApiMember(Description="Should the PDF file be prepared for a double-sided printout with a margin for punching?. True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.", Name="DuplexDruck")
public var duplexDruck:Bool?
/**
* The details of the provider that submits batch of tax data.
*/
// @ApiMember(Description="The details of the provider that submits batch of tax data.", Name="DatenLieferant")
public var datenLieferant:String
/**
* Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.
*/
// @ApiMember(Description="Should the processing of the batch of tax data be staged? If true, batch of 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 protocolPrefix
case fussText
case duplexDruck
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)
protocolPrefix = try container.decodeIfPresent(String.self, forKey: .protocolPrefix)
fussText = try container.decodeIfPresent(String.self, forKey: .fussText)
duplexDruck = try container.decodeIfPresent(Bool.self, forKey: .duplexDruck)
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 protocolPrefix != nil { try container.encode(protocolPrefix, forKey: .protocolPrefix) }
if fussText != nil { try container.encode(fussText, forKey: .fussText) }
if duplexDruck != nil { try container.encode(duplexDruck, forKey: .duplexDruck) }
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 and send batch of tax data.
*/
// @Api(Description="A base service to validate and send batch of tax data.")
public class BatchValidiereUndSendeBase : BatchBearbeiteVorgangBase, ISendeRequest, IDruckRequest
{
/**
* Name prefix of the generated transfer protocol file.
*/
// @ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")
public var protocolPrefix:String
/**
* Footer text to be used on the printout (optional).
*/
// @ApiMember(Description="Footer text to be used on the printout (optional).", Name="FussText")
public var fussText:String
/**
* Should the PDF file be prepared for a double-sided printout with a margin for punching?. True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.
*/
// @ApiMember(Description="Should the PDF file be prepared for a double-sided printout with a margin for punching?. True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.", Name="DuplexDruck")
public var duplexDruck:Bool?
/**
* The details of the provider that submits batch of tax data.
*/
// @ApiMember(Description="The details of the provider that submits batch of tax data.", Name="DatenLieferant")
public var datenLieferant:String
/**
* Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.
*/
// @ApiMember(Description="Should the processing of the batch of tax data be staged? If true, batch of 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 protocolPrefix
case fussText
case duplexDruck
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)
protocolPrefix = try container.decodeIfPresent(String.self, forKey: .protocolPrefix)
fussText = try container.decodeIfPresent(String.self, forKey: .fussText)
duplexDruck = try container.decodeIfPresent(Bool.self, forKey: .duplexDruck)
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 protocolPrefix != nil { try container.encode(protocolPrefix, forKey: .protocolPrefix) }
if fussText != nil { try container.encode(fussText, forKey: .fussText) }
if duplexDruck != nil { try container.encode(duplexDruck, forKey: .duplexDruck) }
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(){}
}
Swift BatchValidiereUndSende 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 /BatchValidiereUndSende HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: application/json
Content-Type: application/json
Content-Length: length
{"protocolPrefix":"String","fussText":"String","duplexDruck":false,"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"}}}]