Tax Filing Service

<back to all web services

BatchCheckElsterAsync

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/BatchCheckElsterAsyncAn asynchronous service to perform basic checks on a batch of tax data.
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Represents a structure that encapsulates a tax declaration. */
// @Api(Description="Represents a structure that encapsulates a tax declaration.")
class TaxData implements JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of the tax data. */
        // @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
        /** @var string */
        public string $id='',

        /** @description The XML-based tax declaration. */
        // @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
        /** @var string */
        public string $content=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['content'])) $this->content = $o['content'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->content)) $o['content'] = $this->content;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description A base service to perform basic checks on a batch of tax data. */
// @Api(Description="A base service to perform basic checks on a batch of tax data.")
class BatchCheckElsterBase implements IPost, JsonSerializable
{
    public function __construct(
        /** @description The batch of ELSTER tax data to check. */
        // @ApiMember(Description="The batch of ELSTER tax data to check.", Name="Data")
        /** @var array<TaxData>|null */
        public ?array $data=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['data'])) $this->data = JsonConverters::fromArray('TaxData', $o['data']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->data)) $o['data'] = JsonConverters::toArray('TaxData', $this->data);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description An asynchronous service to perform basic checks on a batch of tax data. */
// @Api(Description="An asynchronous service to perform basic checks on a batch of tax data.")
class BatchCheckElsterAsync extends BatchCheckElsterBase implements JsonSerializable
{
    /**
     * @param array<TaxData>|null $data
     */
    public function __construct(
        ?array $data=null
    ) {
        parent::__construct($data);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['data'])) $this->data = JsonConverters::fromArray('TaxData', $o['data']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->data)) $o['data'] = JsonConverters::toArray('TaxData', $this->data);
        return empty($o) ? new class(){} : $o;
    }
}

PHP BatchCheckElsterAsync 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 /BatchCheckElsterAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchCheckElsterAsync 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:TaxData>
      <d2p1:Content>String</d2p1:Content>
      <d2p1:Id>String</d2p1:Id>
    </d2p1:TaxData>
  </Data>
</BatchCheckElsterAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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