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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CheckElsterAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Requests">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Models">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:Id>String</d2p1:Id>
  </Data>
</CheckElsterAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ElsterCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <Id>String</Id>
  <Index>0</Index>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <HatDatenlieferant>false</HatDatenlieferant>
  <HatHerstellerId>false</HatHerstellerId>
  <TransferProtokollDruckbar>false</TransferProtokollDruckbar>
  <ZertifikatErforderlich>false</ZertifikatErforderlich>
</ElsterCheckResponse>