Tax Filing Service

<back to all web services

CheckElsterAsync

AsyncBearbeiteVorgangÜberprüfung

An asynchronous service to perform basic checks on a batch of tax data.

Requires Authentication
The following routes are available for this service:
POST/CheckElsterAsyncAn asynchronous service to perform basic checks on a batch of tax data.
"use strict";
export class TaxData {
    /** @param {{id?:string,content?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The unique identifier of the tax data. */
    id;
    /**
     * @type {string}
     * @description The XML-based tax declaration. */
    content;
}
export class CheckElsterBase {
    /** @param {{data?:TaxData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {TaxData}
     * @description The ELSTER tax data to check. */
    data;
}
export class ServiceReponseBase {
    /** @param {{id?:string,index?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The unique identifier of the response. */
    id;
    /**
     * @type {number}
     * @description The position of the response element in an indexed collection. */
    index;
    /**
     * @type {?ResponseStatus}
     * @description Metadata that contains structured error information on the service response. */
    responseStatus;
}
export class ElsterCheckResponse extends ServiceReponseBase {
    /** @param {{zertifikatErforderlich?:boolean,hatHerstellerId?:boolean,hatDatenlieferant?:boolean,transferProtokollDruckbar?:boolean,id?:string,index?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {boolean}
     * @description Checks whether a portal certificate is required to sign the tax data. */
    zertifikatErforderlich;
    /**
     * @type {boolean}
     * @description Checks whether a Manufacturer ID has been provided for the tax data. */
    hatHerstellerId;
    /**
     * @type {boolean}
     * @description Checks whether a data provider has been provided for the tax data. */
    hatDatenlieferant;
    /**
     * @type {boolean}
     * @description Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data. */
    transferProtokollDruckbar;
}
export class CheckElsterAsync extends CheckElsterBase {
    /** @param {{data?:TaxData}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

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

{
	data: 
	{
		id: String,
		content: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	zertifikatErforderlich: False,
	hatHerstellerId: False,
	hatDatenlieferant: False,
	transferProtokollDruckbar: False,
	id: String,
	index: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}