Tax Filing Service

<back to all web services

BatchValidiereUndDruckeErsteSeiteAsync

AsyncBearbeiteVorgangValidiereDrucke

An asynchronous service to validate a batch of tax data and print the first page of their protocol printouts.

Requires Authentication
The following routes are available for this service:
POST/BatchValidiereUndDruckeErsteSeiteAsyncAn asynchronous service to validate a batch of tax data and print the first page of their protocol printouts.
import Foundation
import ServiceStack

/**
* An asynchronous service to validate a batch of tax data and print the first page of their protocol printouts.
*/
// @Api(Description="An asynchronous service to validate a batch of tax data and print the first page of their protocol printouts.")
public class BatchValidiereUndDruckeErsteSeiteAsync : BatchValidiereUndDruckeErsteSeiteBase
{
    /**
    * 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?

    /**
    * 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

    /**
    * 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 duplexDruck
        case protocolPrefix
        case fussText
        case data
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        duplexDruck = try container.decodeIfPresent(Bool.self, forKey: .duplexDruck)
        protocolPrefix = try container.decodeIfPresent(String.self, forKey: .protocolPrefix)
        fussText = try container.decodeIfPresent(String.self, forKey: .fussText)
        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 duplexDruck != nil { try container.encode(duplexDruck, forKey: .duplexDruck) }
        if protocolPrefix != nil { try container.encode(protocolPrefix, forKey: .protocolPrefix) }
        if fussText != nil { try container.encode(fussText, forKey: .fussText) }
        if data.count > 0 { try container.encode(data, forKey: .data) }
    }
}

/**
* A base service to validate a batch of tax data and print the first page of their protocol printouts.
*/
// @Api(Description="A base service to validate a batch of tax data and print the first page of their protocol printouts.")
public class BatchValidiereUndDruckeErsteSeiteBase : BatchBearbeiteVorgangBase, IDruckRequest
{
    /**
    * 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?

    /**
    * 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

    /**
    * 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 duplexDruck
        case protocolPrefix
        case fussText
        case data
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        duplexDruck = try container.decodeIfPresent(Bool.self, forKey: .duplexDruck)
        protocolPrefix = try container.decodeIfPresent(String.self, forKey: .protocolPrefix)
        fussText = try container.decodeIfPresent(String.self, forKey: .fussText)
        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 duplexDruck != nil { try container.encode(duplexDruck, forKey: .duplexDruck) }
        if protocolPrefix != nil { try container.encode(protocolPrefix, forKey: .protocolPrefix) }
        if fussText != nil { try container.encode(fussText, forKey: .fussText) }
        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 BatchValidiereUndDruckeErsteSeiteAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /BatchValidiereUndDruckeErsteSeiteAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	duplexDruck: False,
	protocolPrefix: String,
	fussText: 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: BW
				},
				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
			}
		}
	}
]