Tax Filing Service

<back to all web services

BatchValidiereAuthentifiziereSendeUndDruckeAsync

AsyncBearbeiteVorgangValidiereAuthentifiziereSendeDruckeBatch

An asynchronous service to validate, authenticate, send a batch of tax data and print their transfer protocols.

Requires Authentication
The following routes are available for this service:
POST/BatchValidiereAuthentifiziereSendeUndDruckeAsync
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * An asynchronous service to validate, authenticate, send a batch of tax data and print their transfer protocols.
    */
    @Api(Description="An asynchronous service to validate, authenticate, send a batch of tax data and print their transfer protocols.")
    public static class BatchValidiereAuthentifiziereSendeUndDruckeAsync extends BatchValidiereAuthentifiziereSendeUndDruckeBase
    {
        /**
        * 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.")
        public Boolean duplexDruck = null;

        /**
        * Base name of the generated PDF file. Each tax data file name shall be appended to this base name.
        */
        @ApiMember(Description="Base name of the generated PDF file. Each tax data file name shall be appended to this base name.")
        public String protocolPrefix = null;

        /**
        * Footer text to be used on the printout (optional).
        */
        @ApiMember(Description="Footer text to be used on the printout (optional).")
        public String fussText = null;

        /**
        * The authentification certificate.
        */
        @ApiMember(Description="The authentification certificate.")
        public PortalCertificate zertifikat = null;

        /**
        * 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 String abrufCode = null;

        /**
        * The details of the provider that submits tax data.
        */
        @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
        public String datenLieferant = null;

        /**
        * The batch of tax data to process.
        */
        @ApiMember(Description="The batch of tax data to process.", Name="Data")
        public ArrayList<TaxData> data = null;
        
        public Boolean isDuplexDruck() { return duplexDruck; }
        public BatchValidiereAuthentifiziereSendeUndDruckeAsync setDuplexDruck(Boolean value) { this.duplexDruck = value; return this; }
        public String getProtocolPrefix() { return protocolPrefix; }
        public BatchValidiereAuthentifiziereSendeUndDruckeAsync setProtocolPrefix(String value) { this.protocolPrefix = value; return this; }
        public String getFussText() { return fussText; }
        public BatchValidiereAuthentifiziereSendeUndDruckeAsync setFussText(String value) { this.fussText = value; return this; }
        public PortalCertificate getZertifikat() { return zertifikat; }
        public BatchValidiereAuthentifiziereSendeUndDruckeAsync setZertifikat(PortalCertificate value) { this.zertifikat = value; return this; }
        public String getAbrufCode() { return abrufCode; }
        public BatchValidiereAuthentifiziereSendeUndDruckeAsync setAbrufCode(String value) { this.abrufCode = value; return this; }
        public String getDatenLieferant() { return datenLieferant; }
        public BatchValidiereAuthentifiziereSendeUndDruckeAsync setDatenLieferant(String value) { this.datenLieferant = value; return this; }
        public ArrayList<TaxData> getData() { return data; }
        public BatchValidiereAuthentifiziereSendeUndDruckeAsync setData(ArrayList<TaxData> value) { this.data = value; return this; }
    }

    /**
    * A base service to validate, authenticate, send and print a batch of tax data.
    */
    @Api(Description="A base service to validate, authenticate, send and print a batch of tax data.")
    public static class BatchValidiereAuthentifiziereSendeUndDruckeBase extends BatchBearbeiteVorgangBase implements IDruckRequest, IVeschlueselungsRequest, ISendeRequest
    {
        /**
        * 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.")
        public Boolean duplexDruck = null;

        /**
        * Base name of the generated PDF file. Each tax data file name shall be appended to this base name.
        */
        @ApiMember(Description="Base name of the generated PDF file. Each tax data file name shall be appended to this base name.")
        public String protocolPrefix = null;

        /**
        * Footer text to be used on the printout (optional).
        */
        @ApiMember(Description="Footer text to be used on the printout (optional).")
        public String fussText = null;

        /**
        * The authentification certificate.
        */
        @ApiMember(Description="The authentification certificate.")
        public PortalCertificate zertifikat = null;

        /**
        * 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 String abrufCode = null;

        /**
        * The details of the provider that submits tax data.
        */
        @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
        public String datenLieferant = null;

        /**
        * The batch of tax data to process.
        */
        @ApiMember(Description="The batch of tax data to process.", Name="Data")
        public ArrayList<TaxData> data = null;
        
        public Boolean isDuplexDruck() { return duplexDruck; }
        public BatchValidiereAuthentifiziereSendeUndDruckeBase setDuplexDruck(Boolean value) { this.duplexDruck = value; return this; }
        public String getProtocolPrefix() { return protocolPrefix; }
        public BatchValidiereAuthentifiziereSendeUndDruckeBase setProtocolPrefix(String value) { this.protocolPrefix = value; return this; }
        public String getFussText() { return fussText; }
        public BatchValidiereAuthentifiziereSendeUndDruckeBase setFussText(String value) { this.fussText = value; return this; }
        public PortalCertificate getZertifikat() { return zertifikat; }
        public BatchValidiereAuthentifiziereSendeUndDruckeBase setZertifikat(PortalCertificate value) { this.zertifikat = value; return this; }
        public String getAbrufCode() { return abrufCode; }
        public BatchValidiereAuthentifiziereSendeUndDruckeBase setAbrufCode(String value) { this.abrufCode = value; return this; }
        public String getDatenLieferant() { return datenLieferant; }
        public BatchValidiereAuthentifiziereSendeUndDruckeBase setDatenLieferant(String value) { this.datenLieferant = value; return this; }
        public ArrayList<TaxData> getData() { return data; }
        public BatchValidiereAuthentifiziereSendeUndDruckeBase setData(ArrayList<TaxData> value) { this.data = value; return this; }
    }

    /**
    * A base service to process a batch of tax data.
    */
    @Api(Description="A base service to process a batch of tax data.")
    public static class BatchBearbeiteVorgangBase implements IPost
    {
        /**
        * The batch of tax data to process.
        */
        @ApiMember(Description="The batch of tax data to process.", Name="Data")
        public ArrayList<TaxData> data = null;
        
        public ArrayList<TaxData> getData() { return data; }
        public BatchBearbeiteVorgangBase setData(ArrayList<TaxData> value) { this.data = value; return this; }
    }

    /**
    * Represents a structure that encapsulates a tax declaration.
    */
    @Api(Description="Represents a structure that encapsulates a tax declaration.")
    public static class TaxData
    {
        /**
        * The unique identifier of the tax data.
        */
        @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
        public String id = null;

        /**
        * The XML-based tax declaration.
        */
        @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
        public String content = null;
        
        public String getId() { return id; }
        public TaxData setId(String value) { this.id = value; return this; }
        public String getContent() { return content; }
        public TaxData setContent(String value) { this.content = value; return this; }
    }

    /**
    * Represents a portal certificate that is protected by a password.
    */
    @Api(Description="Represents a portal certificate that is protected by a password.")
    public static class PortalCertificate extends FileBase implements ISecuredCertificate, IHasIndex
    {
        /**
        * The unique identifier of the certificate.
        */
        @ApiMember(Description="The unique identifier of the certificate.")
        public UUID id = null;

        /**
        * 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 Integer index = null;

        /**
        * The password to protect the certificate from unauthorized access.
        */
        @StringLength(255)
        @ApiMember(Description="The password to protect the certificate from unauthorized access.")
        public String pin = null;

        /**
        * The description of the certificate.
        */
        @StringLength(2147483647)
        @ApiMember(Description="The description of the certificate.")
        public String description = null;

        /**
        * 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 ArrayList<String> tags = null;

        /**
        * Gets or sets the file name of the certificate.
        */
        @ApiMember(Description="Gets or sets the file name of the certificate.")
        public String name = null;

        /**
        * The raw data content of the file.
        */
        @ApiMember(Description="The raw data content of the file.", Name="Content")
        public byte[] content = null;
        
        public UUID getId() { return id; }
        public PortalCertificate setId(UUID value) { this.id = value; return this; }
        public Integer getIndex() { return index; }
        public PortalCertificate setIndex(Integer value) { this.index = value; return this; }
        public String getPin() { return pin; }
        public PortalCertificate setPin(String value) { this.pin = value; return this; }
        public String getDescription() { return description; }
        public PortalCertificate setDescription(String value) { this.description = value; return this; }
        public ArrayList<String> getTags() { return tags; }
        public PortalCertificate setTags(ArrayList<String> value) { this.tags = value; return this; }
        public String getName() { return name; }
        public PortalCertificate setName(String value) { this.name = value; return this; }
        public byte[] getContent() { return content; }
        public PortalCertificate setContent(byte[] value) { this.content = value; return this; }
    }

    /**
    * Represents a base class for a file with raw data.
    */
    @Api(Description="Represents a base class for a file with raw data.")
    public static class FileBase
    {
        /**
        * The raw data content of the file.
        */
        @ApiMember(Description="The raw data content of the file.", Name="Content")
        public byte[] content = null;
        
        public byte[] getContent() { return content; }
        public FileBase setContent(byte[] value) { this.content = value; return this; }
    }

}

Java BatchValidiereAuthentifiziereSendeUndDruckeAsync 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 /BatchValidiereAuthentifiziereSendeUndDruckeAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	duplexDruck: False,
	protocolPrefix: String,
	fussText: String,
	zertifikat: 
	{
		id: 00000000000000000000000000000000,
		index: 0,
		pin: String,
		description: String,
		tags: 
		[
			String
		],
		name: String,
		content: AA==
	},
	abrufCode: String,
	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: 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
			}
		}
	}
]