Tax Filing Service

<back to all web services

BatchValidiereAuthentifiziereSendeUndDrucke

SyncBearbeiteVorgangValidiereAuthentifiziereSendeDruckeBatch

A synchronous 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/BatchValidiereAuthentifiziereSendeUndDrucke
<?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 process a batch of tax data. */
// @Api(Description="A base service to process a batch of tax data.")
class BatchBearbeiteVorgangBase implements IPost, JsonSerializable
{
    public function __construct(
        /** @description The batch of tax data to process. */
        // @ApiMember(Description="The batch of tax data to process.", 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 Represents a base class for a file with raw data. */
// @Api(Description="Represents a base class for a file with raw data.")
class FileBase implements JsonSerializable
{
    public function __construct(
        /** @description The raw data content of the file. */
        // @ApiMember(Description="The raw data content of the file.", Name="Content")
        /** @var ByteArray|null */
        public ?ByteArray $content=null
    ) {
    }

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

/** @description 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, JsonSerializable
{
    /**
     * @param ByteArray|null $content
     */
    public function __construct(
        ?ByteArray $content=null,
        /** @description The unique identifier of the certificate. */
        // @ApiMember(Description="The unique identifier of the certificate.")
        /** @var string */
        public string $id='',

        /** @description 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.")
        /** @var int */
        public int $index=0,

        /** @description The password to protect the certificate from unauthorized access. */
        // @StringLength(255)
        // @ApiMember(Description="The password to protect the certificate from unauthorized access.")
        /** @var string|null */
        public ?string $pin=null,

        /** @description The description of the certificate. */
        // @StringLength(2147483647)
        // @ApiMember(Description="The description of the certificate.")
        /** @var string|null */
        public ?string $description=null,

        /** @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.")
        /** @var array<string>|null */
        public ?array $tags=null,

        /** @description Gets or sets the file name of the certificate. */
        // @ApiMember(Description="Gets or sets the file name of the certificate.")
        /** @var string|null */
        public ?string $name=null
    ) {
        parent::__construct($content);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['index'])) $this->index = $o['index'];
        if (isset($o['pin'])) $this->pin = $o['pin'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['tags'])) $this->tags = JsonConverters::fromArray('string', $o['tags']);
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['content'])) $this->content = JsonConverters::from('ByteArray', $o['content']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->index)) $o['index'] = $this->index;
        if (isset($this->pin)) $o['pin'] = $this->pin;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->tags)) $o['tags'] = JsonConverters::toArray('string', $this->tags);
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->content)) $o['content'] = JsonConverters::to('ByteArray', $this->content);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description A base service to validate, authenticate, send and print a batch of tax data. */
// @Api(Description="A base service to validate, authenticate, send and print a batch of tax data.")
class BatchValidiereAuthentifiziereSendeUndDruckeBase extends BatchBearbeiteVorgangBase implements IDruckRequest, IVeschlueselungsRequest, ISendeRequest, JsonSerializable
{
    /**
     * @param array<TaxData>|null $data
     */
    public function __construct(
        ?array $data=null,
        /** @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. */
        // @ApiMember(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.")
        /** @var bool|null */
        public ?bool $duplexDruck=null,

        /** @description Base name of the generated PDF file. Each tax data file name shall be appended to this base name. */
        // @ApiMember(Description="Base name of the generated PDF file. Each tax data file name shall be appended to this base name.")
        /** @var string|null */
        public ?string $protocolPrefix=null,

        /** @description Footer text to be used on the printout (optional). */
        // @ApiMember(Description="Footer text to be used on the printout (optional).")
        /** @var string|null */
        public ?string $fussText=null,

        /** @description The authentification certificate. */
        // @ApiMember(Description="The authentification certificate.")
        /** @var PortalCertificate|null */
        public ?PortalCertificate $zertifikat=null,

        /** @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'. */
        // @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")
        /** @var string|null */
        public ?string $abrufCode=null,

        /** @description The details of the provider that submits tax data. */
        // @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
        /** @var string|null */
        public ?string $datenLieferant=null
    ) {
        parent::__construct($data);
    }

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

/** @description A synchronous service to validate, authenticate, send a batch of tax data and print their transfer protocols. */
// @Api(Description="A synchronous service to validate, authenticate, send a batch of tax data and print their transfer protocols.")
class BatchValidiereAuthentifiziereSendeUndDrucke extends BatchValidiereAuthentifiziereSendeUndDruckeBase implements JsonSerializable
{
    /**
     * @param array<TaxData>|null $data
     * @param bool|null $duplexDruck
     * @param string|null $protocolPrefix
     * @param string|null $fussText
     * @param PortalCertificate|null $zertifikat
     * @param string|null $abrufCode
     * @param string|null $datenLieferant
     * @param array<TaxData>|null $data
     */
    public function __construct(
        ?array $data=null,
        ?bool $duplexDruck=null,
        ?string $protocolPrefix=null,
        ?string $fussText=null,
        ?PortalCertificate $zertifikat=null,
        ?string $abrufCode=null,
        ?string $datenLieferant=null,
        ?array $data=null
    ) {
        parent::__construct($data,$duplexDruck,$protocolPrefix,$fussText,$zertifikat,$abrufCode,$datenLieferant,$data);
    }

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

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

<BatchValidiereAuthentifiziereSendeUndDrucke 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>
  <AbrufCode>String</AbrufCode>
  <DatenLieferant>String</DatenLieferant>
  <DuplexDruck>false</DuplexDruck>
  <FussText>String</FussText>
  <ProtocolPrefix>String</ProtocolPrefix>
  <Zertifikat xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Models">
    <Content xmlns="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Contracts.Models">AA==</Content>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:Index>0</d2p1:Index>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Pin>String</d2p1:Pin>
    <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Tags>
  </Zertifikat>
</BatchValidiereAuthentifiziereSendeUndDrucke>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfBearbeiteVorgangResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <BearbeiteVorgangResponse>
    <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>
    <StatusCode>ERIC_OK</StatusCode>
    <StatusText>String</StatusText>
    <Rueckgabe>
      <Erfolg>
        <Telenummer>String</Telenummer>
        <Ordnungsbegriff>String</Ordnungsbegriff>
      </Erfolg>
      <Transfers>
        <Transfer>
          <TransferTicket>String</TransferTicket>
        </Transfer>
      </Transfers>
      <FehlerRegelpruefung>
        <Nutzdatenticket>String</Nutzdatenticket>
        <Feldidentifikator>String</Feldidentifikator>
        <Mehrfachzeilenindex>String</Mehrfachzeilenindex>
        <LfdNrVordruck>String</LfdNrVordruck>
        <VordruckZeilennummer>String</VordruckZeilennummer>
        <SemantischerIndex Name="String">String</SemantischerIndex>
        <Untersachbereich>String</Untersachbereich>
        <PrivateKennnummer>String</PrivateKennnummer>
        <RegelName>String</RegelName>
        <FachlicheFehlerId>String</FachlicheFehlerId>
        <Text>String</Text>
      </FehlerRegelpruefung>
      <Hinweis>
        <Nutzdatenticket>String</Nutzdatenticket>
        <Feldidentifikator>String</Feldidentifikator>
        <Mehrfachzeilenindex>String</Mehrfachzeilenindex>
        <LfdNrVordruck>String</LfdNrVordruck>
        <VordruckZeilennummer>String</VordruckZeilennummer>
        <SemantischerIndex Name="String">String</SemantischerIndex>
        <Untersachbereich>String</Untersachbereich>
        <PrivateKennnummer>String</PrivateKennnummer>
        <RegelName>String</RegelName>
        <FachlicheHinweisId>String</FachlicheHinweisId>
        <Text>String</Text>
      </Hinweis>
    </Rueckgabe>
    <Serverantwort>
      <TransferHeader version="String">
        <Verfahren>ElsterAnmeldung</Verfahren>
        <DatenArt>34a</DatenArt>
        <Vorgang>send-Auth</Vorgang>
        <TransferTicket>String</TransferTicket>
        <Testmerker>0</Testmerker>
        <SigUser />
        <Empfaenger id="String">
          <Ziel>BW</Ziel>
        </Empfaenger>
        <HerstellerID>String</HerstellerID>
        <DatenLieferant>String</DatenLieferant>
        <EingangsDatum>00010101000000</EingangsDatum>
        <Datei>
          <Verschluesselung>PKCS#7v1.5</Verschluesselung>
          <Kompression>GZIP</Kompression>
          <TransportSchluessel>String</TransportSchluessel>
          <Erstellung>
            <Eric />
          </Erstellung>
        </Datei>
        <RC>
          <Rueckgabe>
            <Code>String</Code>
            <Text>String</Text>
          </Rueckgabe>
          <Stack>
            <Code>String</Code>
            <Text>String</Text>
          </Stack>
        </RC>
        <VersionClient>String</VersionClient>
        <Zusatz>
          <Info>String</Info>
          <ElsterInfo>String</ElsterInfo>
        </Zusatz>
      </TransferHeader>
      <DatenTeil>
        <Nutzdatenblock>
          <NutzdatenHeader version="String">
            <NutzdatenTicket>String</NutzdatenTicket>
            <Empfaenger id="L">String</Empfaenger>
            <Hersteller>
              <ProduktName>String</ProduktName>
              <ProduktVersion>String</ProduktVersion>
            </Hersteller>
            <DatenLieferant>String</DatenLieferant>
            <RC>
              <Rueckgabe>
                <Code>String</Code>
                <Text>String</Text>
              </Rueckgabe>
              <Stack>
                <Code>String</Code>
                <Text>String</Text>
              </Stack>
            </RC>
            <Zusatz>
              <Info>String</Info>
              <ElsterInfo>String</ElsterInfo>
            </Zusatz>
          </NutzdatenHeader>
          <Nutzdaten />
        </Nutzdatenblock>
      </DatenTeil>
    </Serverantwort>
    <TransferProtocols xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Concretes.Models">
      <d3p1:BinaryFile>
        <Content xmlns="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Contracts.Models">AA==</Content>
        <d3p1:Metadata xmlns:d5p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Concretes.Models">
          <d5p1:Extensions xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d5p1:Extensions>
          <d5p1:FullName>String</d5p1:FullName>
          <d5p1:GroupCanExecute>false</d5p1:GroupCanExecute>
          <d5p1:GroupCanRead>false</d5p1:GroupCanRead>
          <d5p1:GroupCanWrite>false</d5p1:GroupCanWrite>
          <d5p1:GroupId>0</d5p1:GroupId>
          <d5p1:LastAccessTime>0001-01-01T00:00:00</d5p1:LastAccessTime>
          <d5p1:LastAccessTimeUtc>0001-01-01T00:00:00</d5p1:LastAccessTimeUtc>
          <d5p1:LastWriteTime>0001-01-01T00:00:00</d5p1:LastWriteTime>
          <d5p1:LastWriteTimeUtc>0001-01-01T00:00:00</d5p1:LastWriteTimeUtc>
          <d5p1:Length>0</d5p1:Length>
          <d5p1:Name>String</d5p1:Name>
          <d5p1:OthersCanExecute>false</d5p1:OthersCanExecute>
          <d5p1:OthersCanRead>false</d5p1:OthersCanRead>
          <d5p1:OthersCanWrite>false</d5p1:OthersCanWrite>
          <d5p1:OwnerCanExecute>false</d5p1:OwnerCanExecute>
          <d5p1:OwnerCanRead>false</d5p1:OwnerCanRead>
          <d5p1:OwnerCanWrite>false</d5p1:OwnerCanWrite>
          <d5p1:UserId>0</d5p1:UserId>
        </d3p1:Metadata>
        <d3p1:Name>String</d3p1:Name>
      </d3p1:BinaryFile>
    </TransferProtocols>
  </BearbeiteVorgangResponse>
</ArrayOfBearbeiteVorgangResponse>
© 2021 - 2024 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Any use of third party IP such as ELSTER is governed by the respective third party terms.