Tax Filing Service
| POST | /BatchValidiereSendeUndDruckeAsync |
|---|
<?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 tax data and print its transfer protocol. */
// @Api(Description="A base service to validate tax data and print its transfer protocol.")
class BatchValidiereSendeUndDruckeBase extends BatchBearbeiteVorgangBase implements IDruckRequest, 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 Name prefix of the generated transfer protocol file. */
// @ApiMember(Description="Name prefix of the generated transfer protocol file.")
/** @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 details of the provider that submits tax data. */
// @ApiMember(Description="The details of the provider that submits tax data.")
/** @var string|null */
public ?string $datenLieferant=null,
/** @description Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers. */
// @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.")
/** @var bool|null */
public ?bool $stagingEnabled=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['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->duplexDruck)) $o['duplexDruck'] = $this->duplexDruck;
if (isset($this->protocolPrefix)) $o['protocolPrefix'] = $this->protocolPrefix;
if (isset($this->fussText)) $o['fussText'] = $this->fussText;
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 tax data and print its transfer protocol. */
// @Api(Description="An asynchronous service to validate tax data and print its transfer protocol.")
class BatchValidiereSendeUndDruckeAsync extends BatchValidiereSendeUndDruckeBase implements JsonSerializable
{
/**
* @param array<TaxData>|null $data
* @param bool|null $duplexDruck
* @param string|null $protocolPrefix
* @param string|null $fussText
* @param string|null $datenLieferant
* @param bool|null $stagingEnabled
* @param array<TaxData>|null $data
*/
public function __construct(
?array $data=null,
?bool $duplexDruck=null,
?string $protocolPrefix=null,
?string $fussText=null,
?string $datenLieferant=null,
?bool $stagingEnabled=null,
?array $data=null
) {
parent::__construct($data,$duplexDruck,$protocolPrefix,$fussText,$datenLieferant,$stagingEnabled,$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['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->duplexDruck)) $o['duplexDruck'] = $this->duplexDruck;
if (isset($this->protocolPrefix)) $o['protocolPrefix'] = $this->protocolPrefix;
if (isset($this->fussText)) $o['fussText'] = $this->fussText;
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 BatchValidiereSendeUndDruckeAsync DTOs
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 /BatchValidiereSendeUndDruckeAsync HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
duplexDruck: False,
protocolPrefix: String,
fussText: String,
datenLieferant: String,
stagingEnabled: False,
data:
[
{
id: String,
content: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
rueckgabe:
{
erfolg:
{
telenummer:
[
String
],
ordnungsbegriffe:
[
String
]
},
transfers:
{
transferList:
[
{
transferTicket: String
}
]
},
fehlerRegelpruefungen:
[
{
nutzdatenticket: String,
feldidentifikator: String,
mehrfachzeilenindex: String,
lfdNrVordruck: String,
vordruckZeilennummer: String,
semantischeIndexes:
[
{
name: String,
value: String
}
],
untersachbereich: String,
privateKennnummer: String,
regelName: String,
fachlicheFehlerId: String,
text: String
}
],
hinweise:
[
{
nutzdatenticket: String,
feldidentifikator: String,
mehrfachzeilenindex: String,
lfdNrVordruck: String,
vordruckZeilennummer: String,
semantischeIndexes:
[
{
name: String,
value: String
}
],
untersachbereich: String,
privateKennnummer: String,
regelName: String,
fachlicheHinweisId: String,
text: String
}
]
},
serverantwort:
{
transferHeader:
{
version: String,
verfahren: ElsterAnmeldung,
datenArt: 34a,
vorgang: send-Auth,
transferTicket: String,
testmerker: 0,
sigUser:
{
inhalt: {}
},
empfaenger:
{
id: String,
ziel: BW
},
herstellerID: String,
datenLieferant: String,
eingangsDatum: 0001-01-01,
datei:
{
verschluesselung: PKCS#7v1.5,
kompression: GZIP,
transportSchluessel: String,
erstellung:
{
eric:
{
inhalt: {}
}
}
},
rc:
{
rueckgabe:
{
code: String,
text: String
},
stack:
{
code: String,
text: String
}
},
versionClient: String,
zusatz:
{
infos:
[
String
],
elsterInfos:
[
String
]
}
},
datenTeil:
{
nutzdatenbloecke:
[
{
nutzdatenHeader:
{
version: String,
nutzdatenTicket: String,
empfaenger:
{
id: L,
value: String
},
hersteller:
{
produktName: String,
produktVersion: String
},
datenLieferant: String,
rc:
{
rueckgabe:
{
code: String,
text: String
},
stack:
{
code: String,
text: String
}
},
zusatz:
{
infos:
[
String
],
elsterInfos:
[
String
]
}
},
nutzdaten:
{
inhalt: {}
}
}
]
}
},
transferProtocols:
[
{
metadata:
{
name: String,
fullName: String,
lastAccessTime: 0001-01-01,
lastAccessTimeUtc: 0001-01-01,
lastWriteTime: 0001-01-01,
lastWriteTimeUtc: 0001-01-01,
length: 0,
userId: 0,
groupId: 0,
othersCanRead: False,
groupCanExecute: False,
groupCanWrite: False,
groupCanRead: False,
ownerCanExecute: False,
ownerCanWrite: False,
ownerCanRead: False,
othersCanExecute: False,
othersCanWrite: False,
extensions:
{
String: String
}
},
name: String,
content: AA==
}
],
statusCode: ERIC_OK,
statusText: String,
id: String,
index: 0,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}
]