Tax Filing Service
| POST | /BatchValidiereUndSendeAsync | An asynchronous service to validate and send 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 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 A base service to validate and send batch of tax data. */
// @Api(Description="A base service to validate and send batch of tax data.")
class BatchValidiereUndSendeBase extends BatchBearbeiteVorgangBase implements ISendeRequest, IDruckRequest, JsonSerializable
{
/**
* @param array<TaxData>|null $data
*/
public function __construct(
?array $data=null,
/** @description Name prefix of the generated transfer protocol file. */
// @ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")
/** @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).", Name="FussText")
/** @var string|null */
public ?string $fussText=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.", Name="DuplexDruck")
/** @var bool|null */
public ?bool $duplexDruck=null,
/** @description The details of the provider that submits batch of tax data. */
// @ApiMember(Description="The details of the provider that submits batch of tax data.", Name="DatenLieferant")
/** @var string|null */
public ?string $datenLieferant=null,
/** @description Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers. */
// @ApiMember(Description="Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
/** @var bool|null */
public ?bool $stagingEnabled=null
) {
parent::__construct($data);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['protocolPrefix'])) $this->protocolPrefix = $o['protocolPrefix'];
if (isset($o['fussText'])) $this->fussText = $o['fussText'];
if (isset($o['duplexDruck'])) $this->duplexDruck = $o['duplexDruck'];
if (isset($o['datenLieferant'])) $this->datenLieferant = $o['datenLieferant'];
if (isset($o['stagingEnabled'])) $this->stagingEnabled = $o['stagingEnabled'];
if (isset($o['data'])) $this->data = JsonConverters::fromArray('TaxData', $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->protocolPrefix)) $o['protocolPrefix'] = $this->protocolPrefix;
if (isset($this->fussText)) $o['fussText'] = $this->fussText;
if (isset($this->duplexDruck)) $o['duplexDruck'] = $this->duplexDruck;
if (isset($this->datenLieferant)) $o['datenLieferant'] = $this->datenLieferant;
if (isset($this->stagingEnabled)) $o['stagingEnabled'] = $this->stagingEnabled;
if (isset($this->data)) $o['data'] = JsonConverters::toArray('TaxData', $this->data);
return empty($o) ? new class(){} : $o;
}
}
/** @description An asynchronous service to validate and send batch of tax data. */
// @Api(Description="An asynchronous service to validate and send batch of tax data.")
class BatchValidiereUndSendeAsync extends BatchValidiereUndSendeBase implements JsonSerializable
{
/**
* @param array<TaxData>|null $data
* @param string|null $protocolPrefix
* @param string|null $fussText
* @param bool|null $duplexDruck
* @param string|null $datenLieferant
* @param bool|null $stagingEnabled
* @param array<TaxData>|null $data
*/
public function __construct(
?array $data=null,
?string $protocolPrefix=null,
?string $fussText=null,
?bool $duplexDruck=null,
?string $datenLieferant=null,
?bool $stagingEnabled=null,
?array $data=null
) {
parent::__construct($data,$protocolPrefix,$fussText,$duplexDruck,$datenLieferant,$stagingEnabled,$data);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['protocolPrefix'])) $this->protocolPrefix = $o['protocolPrefix'];
if (isset($o['fussText'])) $this->fussText = $o['fussText'];
if (isset($o['duplexDruck'])) $this->duplexDruck = $o['duplexDruck'];
if (isset($o['datenLieferant'])) $this->datenLieferant = $o['datenLieferant'];
if (isset($o['stagingEnabled'])) $this->stagingEnabled = $o['stagingEnabled'];
if (isset($o['data'])) $this->data = JsonConverters::fromArray('TaxData', $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->protocolPrefix)) $o['protocolPrefix'] = $this->protocolPrefix;
if (isset($this->fussText)) $o['fussText'] = $this->fussText;
if (isset($this->duplexDruck)) $o['duplexDruck'] = $this->duplexDruck;
if (isset($this->datenLieferant)) $o['datenLieferant'] = $this->datenLieferant;
if (isset($this->stagingEnabled)) $o['stagingEnabled'] = $this->stagingEnabled;
if (isset($this->data)) $o['data'] = JsonConverters::toArray('TaxData', $this->data);
return empty($o) ? new class(){} : $o;
}
}
PHP BatchValidiereUndSendeAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /BatchValidiereUndSendeAsync HTTP/1.1
Host: taxfiling.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchValidiereUndSendeAsync 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>
<DatenLieferant>String</DatenLieferant>
<DuplexDruck>false</DuplexDruck>
<FussText>String</FussText>
<ProtocolPrefix>String</ProtocolPrefix>
<StagingEnabled>false</StagingEnabled>
</BatchValidiereUndSendeAsync>
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>