Tax Filing Service

<back to all web services

BatchValidiereAuthentifiziereUndSende

SyncBearbeiteVorgangValidiereAuthentifiziereSendeBatch

A synchronous service to validate, authenticate and send tax data to the fiscal authorities.

Requires Authentication
The following routes are available for this service:
POST/BatchValidiereAuthentifiziereUndSende
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

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

    /**
    * The XML-based tax declaration.
    */
    // @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
    String? content;

    TaxData({this.id,this.content});
    TaxData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        content = json['content'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'content': content
    };

    getTypeName() => "TaxData";
    TypeContext? context = _ctx;
}

/**
* A base service to process a batch of tax data.
*/
// @Api(Description="A base service to process a batch of tax data.")
abstract class BatchBearbeiteVorgangBase implements IPost
{
    /**
    * The batch of tax data to process.
    */
    // @ApiMember(Description="The batch of tax data to process.", Name="Data")
    List<TaxData>? data;

    BatchBearbeiteVorgangBase({this.data});
    BatchBearbeiteVorgangBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        data = JsonConverters.fromJson(json['data'],'List<TaxData>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'data': JsonConverters.toJson(data,'List<TaxData>',context!)
    };

    getTypeName() => "BatchBearbeiteVorgangBase";
    TypeContext? context = _ctx;
}

/**
* Represents a base class for a file with raw data.
*/
// @Api(Description="Represents a base class for a file with raw data.")
abstract class FileBase
{
    /**
    * The raw data content of the file.
    */
    // @ApiMember(Description="The raw data content of the file.", Name="Content")
    Uint8List? content;

    FileBase({this.content});
    FileBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        content = JsonConverters.fromJson(json['content'],'Uint8List',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'content': JsonConverters.toJson(content,'Uint8List',context!)
    };

    getTypeName() => "FileBase";
    TypeContext? context = _ctx;
}

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

    /**
    * 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.")
    int? index;

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

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

    /**
    * Tags that can be used to label or identify the certificate.
    */
    // @ApiMember(Description="Tags that can be used to label or identify the certificate.")
    List<String>? tags;

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

    /**
    * The raw data content of the file.
    */
    // @ApiMember(Description="The raw data content of the file.", Name="Content")
    Uint8List? content;

    PortalCertificate({this.id,this.index,this.pin,this.description,this.tags,this.name,this.content});
    PortalCertificate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        index = json['index'];
        pin = json['pin'];
        description = json['description'];
        tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
        name = json['name'];
        content = JsonConverters.fromJson(json['content'],'Uint8List',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'index': index,
        'pin': pin,
        'description': description,
        'tags': JsonConverters.toJson(tags,'List<String>',context!),
        'name': name,
        'content': JsonConverters.toJson(content,'Uint8List',context!)
    });

    getTypeName() => "PortalCertificate";
    TypeContext? context = _ctx;
}

/**
* 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.")
abstract class BatchValidiereAuthentifiziereUndSendeBase extends BatchBearbeiteVorgangBase implements IVeschlueselungsRequest, ISendeRequest
{
    /**
    * The authentification certificate.
    */
    // @ApiMember(Description="The authentification certificate.", Name="Zertifikat")
    PortalCertificate? zertifikat;

    /**
    * 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")
    String? abrufCode;

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

    /**
    * 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")
    bool? stagingEnabled;

    /**
    * The batch of tax data to process.
    */
    // @ApiMember(Description="The batch of tax data to process.", Name="Data")
    List<TaxData>? data;

    BatchValidiereAuthentifiziereUndSendeBase({this.zertifikat,this.abrufCode,this.datenLieferant,this.stagingEnabled,this.data});
    BatchValidiereAuthentifiziereUndSendeBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        zertifikat = JsonConverters.fromJson(json['zertifikat'],'PortalCertificate',context!);
        abrufCode = json['abrufCode'];
        datenLieferant = json['datenLieferant'];
        stagingEnabled = json['stagingEnabled'];
        data = JsonConverters.fromJson(json['data'],'List<TaxData>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'zertifikat': JsonConverters.toJson(zertifikat,'PortalCertificate',context!),
        'abrufCode': abrufCode,
        'datenLieferant': datenLieferant,
        'stagingEnabled': stagingEnabled,
        'data': JsonConverters.toJson(data,'List<TaxData>',context!)
    });

    getTypeName() => "BatchValidiereAuthentifiziereUndSendeBase";
    TypeContext? context = _ctx;
}

/**
* 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.")
class BatchValidiereAuthentifiziereUndSende extends BatchValidiereAuthentifiziereUndSendeBase implements IConvertible
{
    /**
    * The authentification certificate.
    */
    // @ApiMember(Description="The authentification certificate.", Name="Zertifikat")
    PortalCertificate? zertifikat;

    /**
    * 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")
    String? abrufCode;

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

    /**
    * 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")
    bool? stagingEnabled;

    /**
    * The batch of tax data to process.
    */
    // @ApiMember(Description="The batch of tax data to process.", Name="Data")
    List<TaxData>? data;

    BatchValidiereAuthentifiziereUndSende({this.zertifikat,this.abrufCode,this.datenLieferant,this.stagingEnabled,this.data});
    BatchValidiereAuthentifiziereUndSende.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        zertifikat = JsonConverters.fromJson(json['zertifikat'],'PortalCertificate',context!);
        abrufCode = json['abrufCode'];
        datenLieferant = json['datenLieferant'];
        stagingEnabled = json['stagingEnabled'];
        data = JsonConverters.fromJson(json['data'],'List<TaxData>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'zertifikat': JsonConverters.toJson(zertifikat,'PortalCertificate',context!),
        'abrufCode': abrufCode,
        'datenLieferant': datenLieferant,
        'stagingEnabled': stagingEnabled,
        'data': JsonConverters.toJson(data,'List<TaxData>',context!)
    });

    getTypeName() => "BatchValidiereAuthentifiziereUndSende";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
    'TaxData': TypeInfo(TypeOf.Class, create:() => TaxData()),
    'BatchBearbeiteVorgangBase': TypeInfo(TypeOf.AbstractClass),
    'List<TaxData>': TypeInfo(TypeOf.Class, create:() => <TaxData>[]),
    'FileBase': TypeInfo(TypeOf.AbstractClass),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
    'PortalCertificate': TypeInfo(TypeOf.Class, create:() => PortalCertificate()),
    'BatchValidiereAuthentifiziereUndSendeBase': TypeInfo(TypeOf.AbstractClass),
    'BatchValidiereAuthentifiziereUndSende': TypeInfo(TypeOf.Class, create:() => BatchValidiereAuthentifiziereUndSende()),
});

Dart BatchValidiereAuthentifiziereUndSende 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 /BatchValidiereAuthentifiziereUndSende HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
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: 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
			}
		}
	}
]