Tax Filing Service
| POST | /CheckElster | A synchronous 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 CheckElsterBase implements IPost, JsonSerializable
{
public function __construct(
/** @description The ELSTER tax data to check. */
// @ApiMember(Description="The ELSTER tax data to check.", Name="Data")
/** @var TaxData|null */
public ?TaxData $data=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['data'])) $this->data = JsonConverters::from('TaxData', $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->data)) $o['data'] = JsonConverters::to('TaxData', $this->data);
return empty($o) ? new class(){} : $o;
}
}
/** @description Specifies a service response from an ERiC service operation. */
// @Api(Description="Specifies a service response from an ERiC service operation.")
class ServiceReponseBase implements IHasIndex, JsonSerializable
{
public function __construct(
/** @description The unique identifier of the response. */
// @ApiMember(Description="The unique identifier of the response.")
/** @var string */
public string $id='',
/** @description The position of the response element in an indexed collection. */
// @ApiMember(Description="The position of the response element in an indexed collection.")
/** @var int */
public int $index=0,
/** @description Metadata that contains structured error information on the service response. */
// @ApiMember(Description="Metadata that contains structured error information on the service response.")
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['index'])) $this->index = $o['index'];
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->index)) $o['index'] = $this->index;
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a type that encapulates the state of a provided ELSTER tax data. */
// @Api(Description="Represents a type that encapulates the state of a provided ELSTER tax data.")
class ElsterCheckResponse extends ServiceReponseBase implements JsonSerializable
{
/**
* @param string $id
* @param int $index
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
string $id='',
int $index=0,
?ResponseStatus $responseStatus=null,
/** @description Checks whether a portal certificate is required to sign the tax data. */
// @ApiMember(Description="Checks whether a portal certificate is required to sign the tax data.")
/** @var bool|null */
public ?bool $zertifikatErforderlich=null,
/** @description Checks whether a Manufacturer ID has been provided for the tax data. */
// @ApiMember(Description="Checks whether a Manufacturer ID has been provided for the tax data.")
/** @var bool|null */
public ?bool $hatHerstellerId=null,
/** @description Checks whether a data provider has been provided for the tax data. */
// @ApiMember(Description="Checks whether a data provider has been provided for the tax data.")
/** @var bool|null */
public ?bool $hatDatenlieferant=null,
/** @description Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data. */
// @ApiMember(Description="Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.")
/** @var bool|null */
public ?bool $transferProtokollDruckbar=null
) {
parent::__construct($id,$index,$responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['zertifikatErforderlich'])) $this->zertifikatErforderlich = $o['zertifikatErforderlich'];
if (isset($o['hatHerstellerId'])) $this->hatHerstellerId = $o['hatHerstellerId'];
if (isset($o['hatDatenlieferant'])) $this->hatDatenlieferant = $o['hatDatenlieferant'];
if (isset($o['transferProtokollDruckbar'])) $this->transferProtokollDruckbar = $o['transferProtokollDruckbar'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->zertifikatErforderlich)) $o['zertifikatErforderlich'] = $this->zertifikatErforderlich;
if (isset($this->hatHerstellerId)) $o['hatHerstellerId'] = $this->hatHerstellerId;
if (isset($this->hatDatenlieferant)) $o['hatDatenlieferant'] = $this->hatDatenlieferant;
if (isset($this->transferProtokollDruckbar)) $o['transferProtokollDruckbar'] = $this->transferProtokollDruckbar;
return empty($o) ? new class(){} : $o;
}
}
/** @description A synchronous service to perform basic checks on a batch of tax data. */
// @Api(Description="A synchronous service to perform basic checks on a batch of tax data.")
class CheckElster extends CheckElsterBase implements JsonSerializable
{
/**
* @param TaxData|null $data
*/
public function __construct(
?TaxData $data=null
) {
parent::__construct($data);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /CheckElster HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
data:
{
id: String,
content: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
zertifikatErforderlich: False,
hatHerstellerId: False,
hatDatenlieferant: False,
transferProtokollDruckbar: False,
id: String,
index: 0,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}