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
"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 BatchBearbeiteVorgangBase {
    /** @param {{data?:TaxData[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {TaxData[]}
     * @description The batch of tax data to process. */
    data;
}
export class FileBase {
    /** @param {{content?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The raw data content of the file. */
    content;
}
export class PortalCertificate extends FileBase {
    /** @param {{id?:string,index?:number,pin?:string,description?:string,tags?:string[],name?:string,content?:string,content?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description The unique identifier of the certificate. */
    id;
    /**
     * @type {number}
     * @description The position of the certificate element in an indexed collection of certificates. */
    index;
    /**
     * @type {?string}
     * @description The password to protect the certificate from unauthorized access. */
    pin;
    /**
     * @type {?string}
     * @description The description of the certificate. */
    description;
    /**
     * @type {string[]}
     * @description Tags that can be used to label or identify the certificate. */
    tags;
    /**
     * @type {?string}
     * @description Gets or sets the file name of the certificate. */
    name;
    /**
     * @type {string}
     * @description The raw data content of the file. */
    content;
}
export class BatchValidiereAuthentifiziereSendeUndDruckeBase extends BatchBearbeiteVorgangBase {
    /** @param {{duplexDruck?:boolean,protocolPrefix?:string,fussText?:string,zertifikat?:PortalCertificate,abrufCode?:string,datenLieferant?:string,data?:TaxData[],data?:TaxData[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?boolean}
     * @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. */
    duplexDruck;
    /**
     * @type {?string}
     * @description Base name of the generated PDF file. Each tax data file name shall be appended to this base name. */
    protocolPrefix;
    /**
     * @type {?string}
     * @description Footer text to be used on the printout (optional). */
    fussText;
    /**
     * @type {?PortalCertificate}
     * @description The authentification certificate. */
    zertifikat;
    /**
     * @type {?string}
     * @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'. */
    abrufCode;
    /**
     * @type {?string}
     * @description The details of the provider that submits tax data. */
    datenLieferant;
    /**
     * @type {TaxData[]}
     * @description The batch of tax data to process. */
    data;
}
export class BatchValidiereAuthentifiziereSendeUndDruckeAsync extends BatchValidiereAuthentifiziereSendeUndDruckeBase {
    /** @param {{duplexDruck?:boolean,protocolPrefix?:string,fussText?:string,zertifikat?:PortalCertificate,abrufCode?:string,datenLieferant?:string,data?:TaxData[],duplexDruck?:boolean,protocolPrefix?:string,fussText?:string,zertifikat?:PortalCertificate,abrufCode?:string,datenLieferant?:string,data?:TaxData[],data?:TaxData[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?boolean}
     * @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. */
    duplexDruck;
    /**
     * @type {?string}
     * @description Base name of the generated PDF file. Each tax data file name shall be appended to this base name. */
    protocolPrefix;
    /**
     * @type {?string}
     * @description Footer text to be used on the printout (optional). */
    fussText;
    /**
     * @type {?PortalCertificate}
     * @description The authentification certificate. */
    zertifikat;
    /**
     * @type {?string}
     * @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'. */
    abrufCode;
    /**
     * @type {?string}
     * @description The details of the provider that submits tax data. */
    datenLieferant;
    /**
     * @type {TaxData[]}
     * @description The batch of tax data to process. */
    data;
}

JavaScript BatchValidiereAuthentifiziereSendeUndDruckeAsync DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"}}}]