Tax Filing Service
| POST | /datenabholungen/bestaetigungen/17/ElsterLohnDaten |
|---|
<?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 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 Specifies the base service request to submit data a retrieval request. */
// @Api(Description="Specifies the base service request to submit data a retrieval request.")
class PhaseRequestBase implements ISendeRequest, IVeschlueselungsRequest, JsonSerializable
{
public function __construct(
/** @description The authentification certificate. */
// @ApiMember(Description="The authentification certificate.", IsRequired=true, Name="Zertifikat")
/** @var PortalCertificate|null */
public ?PortalCertificate $zertifikat=null,
/** @description The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax 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="The retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax tax 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 the tax data. */
// @ApiMember(Description="The details of the provider that submits the tax data.", IsRequired=true, Name="DatenLieferant")
/** @var string */
public string $datenLieferant=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
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'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
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;
return empty($o) ? new class(){} : $o;
}
}
/** @description Specifies the request to confirm the receipt of retrieved tax statements. */
// @Api(Description="Specifies the request to confirm the receipt of retrieved tax statements.")
class EmpfangsBestaetigungRequestBase extends PhaseRequestBase implements IPost, JsonSerializable
{
/**
* @param PortalCertificate|null $zertifikat
* @param string|null $abrufCode
* @param string $datenLieferant
*/
public function __construct(
?PortalCertificate $zertifikat=null,
?string $abrufCode=null,
string $datenLieferant=''
) {
parent::__construct($zertifikat,$abrufCode,$datenLieferant);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
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'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
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;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents the base request criteria to search for data record IDs that require receipt confirmation. */
// @Api(Description="Represents the base request criteria to search for data record IDs that require receipt confirmation.")
class EmpfangsBestaetigungSuchkriterien implements JsonSerializable
{
public function __construct(
/** @description The ID that represents a data record. */
// @ApiMember(Description="The ID that represents a data record.", Name="Id")
/** @var string|null */
public ?string $id=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
return empty($o) ? new class(){} : $o;
}
}
/** @description Specifies the request to acknowledge the receipt of tax statements for payroll tax statements. */
// @Api(Description="Specifies the request to acknowledge the receipt of tax statements for payroll tax statements.")
class ElsterLohnDatenEmpfangsBestaetigungRequestBase extends EmpfangsBestaetigungRequestBase implements JsonSerializable
{
/**
* @param PortalCertificate|null $zertifikat
* @param string|null $abrufCode
* @param string $datenLieferant
* @param PortalCertificate|null $zertifikat
* @param string|null $abrufCode
* @param string $datenLieferant
*/
public function __construct(
?PortalCertificate $zertifikat=null,
?string $abrufCode=null,
string $datenLieferant='',
?PortalCertificate $zertifikat=null,
?string $abrufCode=null,
string $datenLieferant='',
/** @description The search criteria of the service request. */
// @ApiMember(Description="The search criteria of the service request.", Name="Suchkriterien")
/** @var array<EmpfangsBestaetigungSuchkriterien>|null */
public ?array $suchkriterien=null
) {
parent::__construct($zertifikat,$abrufCode,$datenLieferant,$zertifikat,$abrufCode,$datenLieferant);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['suchkriterien'])) $this->suchkriterien = JsonConverters::fromArray('EmpfangsBestaetigungSuchkriterien', $o['suchkriterien']);
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'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->suchkriterien)) $o['suchkriterien'] = JsonConverters::toArray('EmpfangsBestaetigungSuchkriterien', $this->suchkriterien);
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;
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.", Name="Id")
/** @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.", Name="Index")
/** @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.", Name="ResponseStatus")
/** @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 Enumeration of ERiC API error codes. */
enum EricFehlerCode : int
{
case ERIC_OK = 0;
case ERIC_GLOBAL_UNKNOWN = 610001001;
case ERIC_GLOBAL_PRUEF_FEHLER = 610001002;
case ERIC_GLOBAL_HINWEISE = 610001003;
case ERIC_GLOBAL_FEHLERMELDUNG_NICHT_VORHANDEN = 610001007;
case ERIC_GLOBAL_KEINE_DATEN_VORHANDEN = 610001008;
case ERIC_GLOBAL_NICHT_GENUEGEND_ARBEITSSPEICHER = 610001013;
case ERIC_GLOBAL_DATEI_NICHT_GEFUNDEN = 610001014;
case ERIC_GLOBAL_HERSTELLER_ID_NICHT_ERLAUBT = 610001016;
case ERIC_GLOBAL_ILLEGAL_STATE = 610001017;
case ERIC_GLOBAL_FUNKTION_NICHT_ERLAUBT = 610001018;
case ERIC_GLOBAL_ECHTFALL_NICHT_ERLAUBT = 610001019;
case ERIC_GLOBAL_NO_VERSAND_IN_BETA_VERSION = 610001020;
case ERIC_GLOBAL_TESTMERKER_UNGUELTIG = 610001025;
case ERIC_GLOBAL_DATENSATZ_ZU_GROSS = 610001026;
case ERIC_GLOBAL_VERSCHLUESSELUNGS_PARAMETER_NICHT_ERLAUBT = 610001027;
case ERIC_GLOBAL_NUR_PORTALZERTIFIKAT_ERLAUBT = 610001028;
case ERIC_GLOBAL_ABRUFCODE_NICHT_ERLAUBT = 610001029;
case ERIC_GLOBAL_ERROR_XML_CREATE = 610001030;
case ERIC_GLOBAL_TEXTPUFFERGROESSE_FIX = 610001031;
case ERIC_GLOBAL_INTERNER_FEHLER = 610001032;
case ERIC_GLOBAL_ARITHMETIKFEHLER = 610001033;
case ERIC_GLOBAL_STEUERNUMMER_UNGUELTIG = 610001034;
case ERIC_GLOBAL_STEUERNUMMER_FALSCHE_LAENGE = 610001035;
case ERIC_GLOBAL_STEUERNUMMER_NICHT_NUMERISCH = 610001036;
case ERIC_GLOBAL_LANDESNUMMER_UNBEKANNT = 610001037;
case ERIC_GLOBAL_BUFANR_UNBEKANNT = 610001038;
case ERIC_GLOBAL_LANDESNUMMER_BUFANR = 610001039;
case ERIC_GLOBAL_PUFFER_ZUGRIFFSKONFLIKT = 610001040;
case ERIC_GLOBAL_PUFFER_UEBERLAUF = 610001041;
case ERIC_GLOBAL_DATENARTVERSION_UNBEKANNT = 610001042;
case ERIC_GLOBAL_DATENARTVERSION_XML_INKONSISTENT = 610001044;
case ERIC_GLOBAL_COMMONDATA_NICHT_VERFUEGBAR = 610001045;
case ERIC_GLOBAL_LOG_EXCEPTION = 610001046;
case ERIC_GLOBAL_TRANSPORTSCHLUESSEL_NICHT_ERLAUBT = 610001047;
case ERIC_GLOBAL_OEFFENTLICHER_SCHLUESSEL_UNGUELTIG = 610001048;
case ERIC_GLOBAL_TRANSPORTSCHLUESSEL_TYP_FALSCH = 610001049;
case ERIC_GLOBAL_PUFFER_UNGLEICHER_INSTANZ = 610001050;
case ERIC_GLOBAL_VORSATZ_UNGUELTIG = 610001051;
case ERIC_GLOBAL_DATEIZUGRIFF_VERWEIGERT = 610001053;
case ERIC_GLOBAL_UNGUELTIGE_INSTANZ = 610001080;
case ERIC_GLOBAL_NICHT_INITIALISIERT = 610001081;
case ERIC_GLOBAL_MEHRFACHE_INITIALISIERUNG = 610001082;
case ERIC_GLOBAL_FEHLER_INITIALISIERUNG = 610001083;
case ERIC_GLOBAL_UNKNOWN_PARAMETER_ERROR = 610001102;
case ERIC_GLOBAL_CHECK_CORRUPTED_NDS = 610001108;
case ERIC_GLOBAL_VERSCHLUESSELUNGS_PARAMETER_NICHT_ANGEGEBEN = 610001206;
case ERIC_GLOBAL_SEND_FLAG_MEHR_ALS_EINES = 610001209;
case ERIC_GLOBAL_UNGUELTIGE_FLAG_KOMBINATION = 610001218;
case ERIC_GLOBAL_ERSTE_SEITE_DRUCK_NICHT_UNTERSTUETZT = 610001220;
case ERIC_GLOBAL_UNGUELTIGER_PARAMETER = 610001222;
case ERIC_GLOBAL_DRUCK_FUER_VERFAHREN_NICHT_ERLAUBT = 610001224;
case ERIC_GLOBAL_VERSAND_ART_NICHT_UNTERSTUETZT = 610001225;
case ERIC_GLOBAL_UNGUELTIGE_PARAMETER_VERSION = 610001226;
case ERIC_GLOBAL_TRANSFERHANDLE = 610001227;
case ERIC_GLOBAL_PLUGININITIALISIERUNG = 610001228;
case ERIC_GLOBAL_INKOMPATIBLE_VERSIONEN = 610001229;
case ERIC_GLOBAL_VERSCHLUESSELUNGSVERFAHREN_NICHT_UNTERSTUETZT = 610001230;
case ERIC_GLOBAL_MEHRFACHAUFRUFE_NICHT_UNTERSTUETZT = 610001231;
case ERIC_GLOBAL_UTI_COUNTRY_NOT_SUPPORTED = 610001404;
case ERIC_GLOBAL_IBAN_FORMALER_FEHLER = 610001501;
case ERIC_GLOBAL_IBAN_LAENDERCODE_FEHLER = 610001502;
case ERIC_GLOBAL_IBAN_LANDESFORMAT_FEHLER = 610001503;
case ERIC_GLOBAL_IBAN_PRUEFZIFFER_FEHLER = 610001504;
case ERIC_GLOBAL_BIC_FORMALER_FEHLER = 610001510;
case ERIC_GLOBAL_BIC_LAENDERCODE_FEHLER = 610001511;
case ERIC_GLOBAL_ZULASSUNGSNUMMER_ZU_LANG = 610001519;
case ERIC_GLOBAL_IDNUMMER_UNGUELTIG = 610001525;
case ERIC_GLOBAL_NULL_PARAMETER = 610001526;
case ERIC_GLOBAL_EWAZ_UNGUELTIG = 610001527;
case ERIC_GLOBAL_EWAZ_LANDESKUERZEL_UNBEKANNT = 610001528;
case ERIC_GLOBAL_UPDATE_NECESSARY = 610001851;
case ERIC_GLOBAL_EINSTELLUNG_NAME_UNGUELTIG = 610001860;
case ERIC_GLOBAL_EINSTELLUNG_WERT_UNGUELTIG = 610001861;
case ERIC_GLOBAL_ERR_DEKODIEREN = 610001862;
case ERIC_GLOBAL_FUNKTION_NICHT_UNTERSTUETZT = 610001863;
case ERIC_GLOBAL_NUTZDATENTICKETS_NICHT_EINDEUTIG = 610001865;
case ERIC_GLOBAL_NUTZDATENHEADERVERSIONEN_UNEINHEITLICH = 610001866;
case ERIC_GLOBAL_BUNDESLAENDER_UNEINHEITLICH = 610001867;
case ERIC_GLOBAL_ZEITRAEUME_UNEINHEITLICH = 610001868;
case ERIC_GLOBAL_NUTZDATENHEADER_EMPFAENGER_NICHT_KORREKT = 610001869;
case ERIC_TRANSFER_COM_ERROR = 610101200;
case ERIC_TRANSFER_VORGANG_NICHT_UNTERSTUETZT = 610101201;
case ERIC_TRANSFER_ERR_XML_THEADER = 610101210;
case ERIC_TRANSFER_ERR_PARAM = 610101251;
case ERIC_TRANSFER_ERR_DATENTEILENDNOTFOUND = 610101253;
case ERIC_TRANSFER_ERR_BEGINDATENLIEFERANT = 610101255;
case ERIC_TRANSFER_ERR_ENDDATENLIEFERANT = 610101256;
case ERIC_TRANSFER_ERR_BEGINTRANSPORTSCHLUESSEL = 610101257;
case ERIC_TRANSFER_ERR_ENDTRANSPORTSCHLUESSEL = 610101258;
case ERIC_TRANSFER_ERR_BEGINDATENGROESSE = 610101259;
case ERIC_TRANSFER_ERR_ENDDATENGROESSE = 610101260;
case ERIC_TRANSFER_ERR_SEND = 610101271;
case ERIC_TRANSFER_ERR_NOTENCRYPTED = 610101274;
case ERIC_TRANSFER_ERR_PROXYCONNECT = 610101276;
case ERIC_TRANSFER_ERR_CONNECTSERVER = 610101278;
case ERIC_TRANSFER_ERR_NORESPONSE = 610101279;
case ERIC_TRANSFER_ERR_PROXYAUTH = 610101280;
case ERIC_TRANSFER_ERR_SEND_INIT = 610101282;
case ERIC_TRANSFER_ERR_TIMEOUT = 610101283;
case ERIC_TRANSFER_ERR_PROXYPORT_INVALID = 610101284;
case ERIC_TRANSFER_ERR_OTHER = 610101291;
case ERIC_TRANSFER_ERR_XML_NHEADER = 610101292;
case ERIC_TRANSFER_ERR_XML_ENCODING = 610101293;
case ERIC_TRANSFER_ERR_ENDSIGUSER = 610101294;
case ERIC_TRANSFER_ERR_XMLTAG_NICHT_GEFUNDEN = 610101295;
case ERIC_TRANSFER_ERR_DATENTEILFEHLER = 610101297;
case ERIC_TRANSFER_EID_ZERTIFIKATFEHLER = 610101500;
case ERIC_TRANSFER_EID_KEINKONTO = 610101510;
case ERIC_TRANSFER_EID_IDNRNICHTEINDEUTIG = 610101511;
case ERIC_TRANSFER_EID_SERVERFEHLER = 610101512;
case ERIC_TRANSFER_EID_KEINCLIENT = 610101520;
case ERIC_TRANSFER_EID_CLIENTFEHLER = 610101521;
case ERIC_TRANSFER_EID_FEHLENDEFELDER = 610101522;
case ERIC_TRANSFER_EID_IDENTIFIKATIONABGEBROCHEN = 610101523;
case ERIC_TRANSFER_EID_NPABLOCKIERT = 610101524;
case ERIC_CRYPT_ERROR_CREATE_KEY = 610201016;
case ERIC_CRYPT_E_INVALID_HANDLE = 610201101;
case ERIC_CRYPT_E_MAX_SESSION = 610201102;
case ERIC_CRYPT_E_BUSY = 610201103;
case ERIC_CRYPT_E_OUT_OF_MEM = 610201104;
case ERIC_CRYPT_E_PSE_PATH = 610201105;
case ERIC_CRYPT_E_PIN_WRONG = 610201106;
case ERIC_CRYPT_E_PIN_LOCKED = 610201107;
case ERIC_CRYPT_E_P7_READ = 610201108;
case ERIC_CRYPT_E_P7_DECODE = 610201109;
case ERIC_CRYPT_E_P7_RECIPIENT = 610201110;
case ERIC_CRYPT_E_P12_READ = 610201111;
case ERIC_CRYPT_E_P12_DECODE = 610201112;
case ERIC_CRYPT_E_P12_SIG_KEY = 610201113;
case ERIC_CRYPT_E_P12_ENC_KEY = 610201114;
case ERIC_CRYPT_E_P11_SIG_KEY = 610201115;
case ERIC_CRYPT_E_P11_ENC_KEY = 610201116;
case ERIC_CRYPT_E_XML_PARSE = 610201117;
case ERIC_CRYPT_E_XML_SIG_ADD = 610201118;
case ERIC_CRYPT_E_XML_SIG_TAG = 610201119;
case ERIC_CRYPT_E_XML_SIG_SIGN = 610201120;
case ERIC_CRYPT_E_ENCODE_UNKNOWN = 610201121;
case ERIC_CRYPT_E_ENCODE_ERROR = 610201122;
case ERIC_CRYPT_E_XML_INIT = 610201123;
case ERIC_CRYPT_E_ENCRYPT = 610201124;
case ERIC_CRYPT_E_DECRYPT = 610201125;
case ERIC_CRYPT_E_P11_SLOT_EMPTY = 610201126;
case ERIC_CRYPT_E_NO_SIG_ENC_KEY = 610201127;
case ERIC_CRYPT_E_LOAD_DLL = 610201128;
case ERIC_CRYPT_E_NO_SERVICE = 610201129;
case ERIC_CRYPT_E_ESICL_EXCEPTION = 610201130;
case ERIC_CRYPT_E_TOKEN_TYPE_MISMATCH = 610201144;
case ERIC_CRYPT_E_P12_CREATE = 610201146;
case ERIC_CRYPT_E_VERIFY_CERT_CHAIN = 610201147;
case ERIC_CRYPT_E_P11_ENGINE_LOADED = 610201148;
case ERIC_CRYPT_E_USER_CANCEL = 610201149;
case ERIC_CRYPT_ZERTIFIKAT = 610201200;
case ERIC_CRYPT_SIGNATUR = 610201201;
case ERIC_CRYPT_NICHT_UNTERSTUETZTES_PSE_FORMAT = 610201203;
case ERIC_CRYPT_PIN_BENOETIGT = 610201205;
case ERIC_CRYPT_PIN_STAERKE_NICHT_AUSREICHEND = 610201206;
case ERIC_CRYPT_E_INTERN = 610201208;
case ERIC_CRYPT_ZERTIFIKATSPFAD_KEIN_VERZEICHNIS = 610201209;
case ERIC_CRYPT_ZERTIFIKATSDATEI_EXISTIERT_BEREITS = 610201210;
case ERIC_CRYPT_PIN_ENTHAELT_UNGUELTIGE_ZEICHEN = 610201211;
case ERIC_CRYPT_E_INVALID_PARAM_ABC = 610201212;
case ERIC_CRYPT_CORRUPTED = 610201213;
case ERIC_CRYPT_EIDKARTE_NICHT_UNTERSTUETZT = 610201214;
case ERIC_CRYPT_E_SC_SLOT_EMPTY = 610201215;
case ERIC_CRYPT_E_SC_NO_APPLET = 610201216;
case ERIC_CRYPT_E_SC_SESSION = 610201217;
case ERIC_CRYPT_E_P11_NO_SIG_CERT = 610201218;
case ERIC_CRYPT_E_P11_INIT_FAILED = 610201219;
case ERIC_CRYPT_E_P11_NO_ENC_CERT = 610201220;
case ERIC_CRYPT_E_P12_NO_SIG_CERT = 610201221;
case ERIC_CRYPT_E_P12_NO_ENC_CERT = 610201222;
case ERIC_CRYPT_E_SC_ENC_KEY = 610201223;
case ERIC_CRYPT_E_SC_NO_SIG_CERT = 610201224;
case ERIC_CRYPT_E_SC_NO_ENC_CERT = 610201225;
case ERIC_CRYPT_E_SC_INIT_FAILED = 610201226;
case ERIC_CRYPT_E_SC_SIG_KEY = 610201227;
case ERIC_IO_FEHLER = 610301001;
case ERIC_IO_DATEI_INKORREKT = 610301005;
case ERIC_IO_PARSE_FEHLER = 610301006;
case ERIC_IO_NDS_GENERIERUNG_FEHLGESCHLAGEN = 610301007;
case ERIC_IO_MASTERDATENSERVICE_NICHT_VERFUEGBAR = 610301010;
case ERIC_IO_STEUERZEICHEN_IM_NDS = 610301014;
case ERIC_IO_VERSIONSINFORMATIONEN_NICHT_GEFUNDEN = 610301031;
case ERIC_IO_FALSCHES_VERFAHREN = 610301104;
case ERIC_IO_READER_MEHRFACHE_STEUERFAELLE = 610301105;
case ERIC_IO_READER_UNERWARTETE_ELEMENTE = 610301106;
case ERIC_IO_READER_FORMALE_FEHLER = 610301107;
case ERIC_IO_READER_FALSCHES_ENCODING = 610301108;
case ERIC_IO_READER_MEHRFACHE_NUTZDATEN_ELEMENTE = 610301109;
case ERIC_IO_READER_MEHRFACHE_NUTZDATENBLOCK_ELEMENTE = 610301110;
case ERIC_IO_UNBEKANNTE_DATENART = 610301111;
case ERIC_IO_READER_UNTERSACHBEREICH_UNGUELTIG = 610301114;
case ERIC_IO_READER_ZU_VIELE_NUTZDATENBLOCK_ELEMENTE = 610301115;
case ERIC_IO_READER_STEUERZEICHEN_IM_TRANSFERHEADER = 610301150;
case ERIC_IO_READER_STEUERZEICHEN_IM_NUTZDATENHEADER = 610301151;
case ERIC_IO_READER_STEUERZEICHEN_IN_DEN_NUTZDATEN = 610301152;
case ERIC_IO_READER_ZU_VIELE_ANHAENGE = 610301190;
case ERIC_IO_READER_ANHANG_ZU_GROSS = 610301191;
case ERIC_IO_READER_ANHAENGE_ZU_GROSS = 610301192;
case ERIC_IO_READER_SCHEMA_VALIDIERUNGSFEHLER = 610301200;
case ERIC_IO_READER_UNBEKANNTE_XML_ENTITY = 610301201;
case ERIC_IO_DATENTEILNOTFOUND = 610301252;
case ERIC_IO_DATENTEILENDNOTFOUND = 610301253;
case ERIC_IO_UEBERGABEPARAMETER_FEHLERHAFT = 610301300;
case ERIC_IO_UNGUELTIGE_UTF8_SEQUENZ = 610301400;
case ERIC_IO_UNGUELTIGE_ZEICHEN_IN_PARAMETER = 610301401;
case ERIC_PRINT_INTERNER_FEHLER = 610501001;
case ERIC_PRINT_DRUCKVORLAGE_NICHT_GEFUNDEN = 610501002;
case ERIC_PRINT_UNGUELTIGER_DATEI_PFAD = 610501004;
case ERIC_PRINT_INITIALISIERUNG_FEHLERHAFT = 610501007;
case ERIC_PRINT_AUSGABEZIEL_UNBEKANNT = 610501008;
case ERIC_PRINT_ABBRUCH_DRUCKVORBEREITUNG = 610501009;
case ERIC_PRINT_ABBRUCH_GENERIERUNG = 610501010;
case ERIC_PRINT_STEUERFALL_NICHT_UNTERSTUETZT = 610501011;
case ERIC_PRINT_FUSSTEXT_ZU_LANG = 610501012;
}
/** @description Represent a base response that encapsulate any ERiC API function return value. */
// @Api(Description="Represent a base response that encapsulate any ERiC API function return value.")
class EricFehlerCodeResponse 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 The status code that the ERiC API function returns. */
// @ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
/** @var EricFehlerCode|null */
public ?EricFehlerCode $statusCode=null,
/** @description The status message that the ERiC API function returns. */
// @ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
/** @var string|null */
public ?string $statusText=null
) {
parent::__construct($id,$index,$responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['statusCode'])) $this->statusCode = JsonConverters::from('EricFehlerCode', $o['statusCode']);
if (isset($o['statusText'])) $this->statusText = $o['statusText'];
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 = parent::jsonSerialize();
if (isset($this->statusCode)) $o['statusCode'] = JsonConverters::to('EricFehlerCode', $this->statusCode);
if (isset($this->statusText)) $o['statusText'] = $this->statusText;
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 the acknowledgement of receipt of requested tax assessment. */
// @Api(Description="Represents the acknowledgement of receipt of requested tax assessment.")
class Empfangsbestaetigung implements JsonSerializable
{
public function __construct(
/** @description Metadata (e.g. description data). */
// @ApiMember(Description="Metadata (e.g. description data).")
/** @var string|null */
public ?string $id=null,
/** @description The ID number of the owner of the receipt data. This attribute is only required for the tax type 'ElsterVaStDaten'. */
// @ApiMember(Description="The ID number of the owner of the receipt data. This attribute is only required for the tax type 'ElsterVaStDaten'.")
/** @var string|null */
public ?string $idnr=null,
/** @description The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'. */
// @ApiMember(Description="The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.")
/** @var int|null */
public ?int $veranlagungsjahr=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['idnr'])) $this->idnr = $o['idnr'];
if (isset($o['veranlagungsjahr'])) $this->veranlagungsjahr = $o['veranlagungsjahr'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->idnr)) $o['idnr'] = $this->idnr;
if (isset($this->veranlagungsjahr)) $o['veranlagungsjahr'] = $this->veranlagungsjahr;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents information returned from a successful tax declaration process. */
// @Api(Description="Represents information returned from a successful tax declaration process.")
class Erfolg implements JsonSerializable
{
public function __construct(
/** @description The generated tele-number for the successful tax declaration process. */
// @ApiMember(Description="The generated tele-number for the successful tax declaration process.")
/** @var array<string>|null */
public ?array $telenummer=null,
/** @description The classification key for the successful tax declaration process. */
// @ApiMember(Description="The classification key for the successful tax declaration process.")
/** @var array<string>|null */
public ?array $ordnungsbegriffe=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['telenummer'])) $this->telenummer = JsonConverters::fromArray('string', $o['telenummer']);
if (isset($o['ordnungsbegriffe'])) $this->ordnungsbegriffe = JsonConverters::fromArray('string', $o['ordnungsbegriffe']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->telenummer)) $o['telenummer'] = JsonConverters::toArray('string', $this->telenummer);
if (isset($this->ordnungsbegriffe)) $o['ordnungsbegriffe'] = JsonConverters::toArray('string', $this->ordnungsbegriffe);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents information on the delivery. */
// @Api(Description="Represents information on the delivery.")
class Transfer implements JsonSerializable
{
public function __construct(
/** @description The ticket of the transfer. */
// @ApiMember(Description="The ticket of the transfer.")
/** @var string|null */
public ?string $transferTicket=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['transferTicket'])) $this->transferTicket = $o['transferTicket'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->transferTicket)) $o['transferTicket'] = $this->transferTicket;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents information on all data deliveries, including deliveries that have not been confirmed by the server. For more information, see the ERiC developer manual in the 'TransferTicket' section. */
// @Api(Description="Represents information on all data deliveries, including deliveries that have not been confirmed by the server. For more information, see the ERiC developer manual in the 'TransferTicket' section.")
class Transfers implements JsonSerializable
{
public function __construct(
/** @description Contains information on all data deliveries, including deliveries that have not been confirmed by the server. */
// @ApiMember(Description="Contains information on all data deliveries, including deliveries that have not been confirmed by the server.")
/** @var array<Transfer>|null */
public ?array $transferList=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['transferList'])) $this->transferList = JsonConverters::fromArray('Transfer', $o['transferList']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->transferList)) $o['transferList'] = JsonConverters::toArray('Transfer', $this->transferList);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents value of an index field, which identfies the context about an error message. */
// @Api(Description="Represents value of an index field, which identfies the context about an error message.")
class SemantischerIndex implements JsonSerializable
{
public function __construct(
/** @description The name of the index field. */
// @ApiMember(Description="The name of the index field.")
/** @var string|null */
public ?string $name=null,
/** @description The value of the index field. */
// @ApiMember(Description="The value of the index field.")
/** @var string|null */
public ?string $value=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['value'])) $this->value = $o['value'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->value)) $o['value'] = $this->value;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents information on an ERiC reference. */
// @Api(Description="Represents information on an ERiC reference.")
class FehlerRegelpruefung implements JsonSerializable
{
public function __construct(
/** @description The user data ticket of the reference. */
// @ApiMember(Description="The user data ticket of the reference.")
/** @var string|null */
public ?string $nutzdatenticket=null,
/** @description The field identifier of the reference. */
// @ApiMember(Description="The field identifier of the reference.")
/** @var string|null */
public ?string $feldidentifikator=null,
/** @description The multi-line index of the reference. */
// @ApiMember(Description="The multi-line index of the reference.")
/** @var string|null */
public ?string $mehrfachzeilenindex=null,
/** @description The delivery number form of the reference. */
// @ApiMember(Description="The delivery number form of the reference.")
/** @var string|null */
public ?string $lfdNrVordruck=null,
/** @description Indicates the line number of the error field mentioned in the form. */
// @ApiMember(Description="Indicates the line number of the error field mentioned in the form.")
/** @var string|null */
public ?string $vordruckZeilennummer=null,
/** @description Specifies the value of one or more index fields that identify the context of error messages. */
// @ApiMember(Description="Specifies the value of one or more index fields that identify the context of error messages.")
/** @var array<SemantischerIndex>|null */
public ?array $semantischeIndexes=null,
/** @description The sub-subject-area of the reference. */
// @ApiMember(Description="The sub-subject-area of the reference.")
/** @var string|null */
public ?string $untersachbereich=null,
/** @description The private identification number of the reference. */
// @ApiMember(Description="The private identification number of the reference.")
/** @var string|null */
public ?string $privateKennnummer=null,
/** @description The name of the rule that applies to the reference. */
// @ApiMember(Description="The name of the rule that applies to the reference.")
/** @var string|null */
public ?string $regelName=null,
/** @description The technical error identifier of the reference. */
// @ApiMember(Description="The technical error identifier of the reference.")
/** @var string|null */
public ?string $fachlicheFehlerId=null,
/** @description The textual details of the reference. */
// @ApiMember(Description="The textual details of the reference.")
/** @var string|null */
public ?string $text=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['nutzdatenticket'])) $this->nutzdatenticket = $o['nutzdatenticket'];
if (isset($o['feldidentifikator'])) $this->feldidentifikator = $o['feldidentifikator'];
if (isset($o['mehrfachzeilenindex'])) $this->mehrfachzeilenindex = $o['mehrfachzeilenindex'];
if (isset($o['lfdNrVordruck'])) $this->lfdNrVordruck = $o['lfdNrVordruck'];
if (isset($o['vordruckZeilennummer'])) $this->vordruckZeilennummer = $o['vordruckZeilennummer'];
if (isset($o['semantischeIndexes'])) $this->semantischeIndexes = JsonConverters::fromArray('SemantischerIndex', $o['semantischeIndexes']);
if (isset($o['untersachbereich'])) $this->untersachbereich = $o['untersachbereich'];
if (isset($o['privateKennnummer'])) $this->privateKennnummer = $o['privateKennnummer'];
if (isset($o['regelName'])) $this->regelName = $o['regelName'];
if (isset($o['fachlicheFehlerId'])) $this->fachlicheFehlerId = $o['fachlicheFehlerId'];
if (isset($o['text'])) $this->text = $o['text'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->nutzdatenticket)) $o['nutzdatenticket'] = $this->nutzdatenticket;
if (isset($this->feldidentifikator)) $o['feldidentifikator'] = $this->feldidentifikator;
if (isset($this->mehrfachzeilenindex)) $o['mehrfachzeilenindex'] = $this->mehrfachzeilenindex;
if (isset($this->lfdNrVordruck)) $o['lfdNrVordruck'] = $this->lfdNrVordruck;
if (isset($this->vordruckZeilennummer)) $o['vordruckZeilennummer'] = $this->vordruckZeilennummer;
if (isset($this->semantischeIndexes)) $o['semantischeIndexes'] = JsonConverters::toArray('SemantischerIndex', $this->semantischeIndexes);
if (isset($this->untersachbereich)) $o['untersachbereich'] = $this->untersachbereich;
if (isset($this->privateKennnummer)) $o['privateKennnummer'] = $this->privateKennnummer;
if (isset($this->regelName)) $o['regelName'] = $this->regelName;
if (isset($this->fachlicheFehlerId)) $o['fachlicheFehlerId'] = $this->fachlicheFehlerId;
if (isset($this->text)) $o['text'] = $this->text;
return empty($o) ? new class(){} : $o;
}
}
class Hinweis implements JsonSerializable
{
public function __construct(
/** @description The user data ticket of the reference. */
// @ApiMember(Description="The user data ticket of the reference.")
/** @var string|null */
public ?string $nutzdatenticket=null,
/** @description The field identifier of the reference. */
// @ApiMember(Description="The field identifier of the reference.")
/** @var string|null */
public ?string $feldidentifikator=null,
/** @description The multi-line index of the reference. */
// @ApiMember(Description="The multi-line index of the reference.")
/** @var string|null */
public ?string $mehrfachzeilenindex=null,
/** @description The delivery number form of the reference. */
// @ApiMember(Description="The delivery number form of the reference.")
/** @var string|null */
public ?string $lfdNrVordruck=null,
/** @description Indicates the line number of the error field mentioned in the form. */
// @ApiMember(Description="Indicates the line number of the error field mentioned in the form.")
/** @var string|null */
public ?string $vordruckZeilennummer=null,
/** @description Specifies the value of one or more index fields that identify the context of error messages. */
// @ApiMember(Description="Specifies the value of one or more index fields that identify the context of error messages.")
/** @var array<SemantischerIndex>|null */
public ?array $semantischeIndexes=null,
/** @description The sub-subject-area of the reference. */
// @ApiMember(Description="The sub-subject-area of the reference.")
/** @var string|null */
public ?string $untersachbereich=null,
/** @description The private identification number of the reference. */
// @ApiMember(Description="The private identification number of the reference.")
/** @var string|null */
public ?string $privateKennnummer=null,
/** @description The name of the rule that applies to the reference. */
// @ApiMember(Description="The name of the rule that applies to the reference.")
/** @var string|null */
public ?string $regelName=null,
/** @description The technical note identifier of the reference. */
// @ApiMember(Description="The technical note identifier of the reference.")
/** @var string|null */
public ?string $fachlicheHinweisId=null,
/** @description The textual details of the reference. */
// @ApiMember(Description="The textual details of the reference.")
/** @var string|null */
public ?string $text=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['nutzdatenticket'])) $this->nutzdatenticket = $o['nutzdatenticket'];
if (isset($o['feldidentifikator'])) $this->feldidentifikator = $o['feldidentifikator'];
if (isset($o['mehrfachzeilenindex'])) $this->mehrfachzeilenindex = $o['mehrfachzeilenindex'];
if (isset($o['lfdNrVordruck'])) $this->lfdNrVordruck = $o['lfdNrVordruck'];
if (isset($o['vordruckZeilennummer'])) $this->vordruckZeilennummer = $o['vordruckZeilennummer'];
if (isset($o['semantischeIndexes'])) $this->semantischeIndexes = JsonConverters::fromArray('SemantischerIndex', $o['semantischeIndexes']);
if (isset($o['untersachbereich'])) $this->untersachbereich = $o['untersachbereich'];
if (isset($o['privateKennnummer'])) $this->privateKennnummer = $o['privateKennnummer'];
if (isset($o['regelName'])) $this->regelName = $o['regelName'];
if (isset($o['fachlicheHinweisId'])) $this->fachlicheHinweisId = $o['fachlicheHinweisId'];
if (isset($o['text'])) $this->text = $o['text'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->nutzdatenticket)) $o['nutzdatenticket'] = $this->nutzdatenticket;
if (isset($this->feldidentifikator)) $o['feldidentifikator'] = $this->feldidentifikator;
if (isset($this->mehrfachzeilenindex)) $o['mehrfachzeilenindex'] = $this->mehrfachzeilenindex;
if (isset($this->lfdNrVordruck)) $o['lfdNrVordruck'] = $this->lfdNrVordruck;
if (isset($this->vordruckZeilennummer)) $o['vordruckZeilennummer'] = $this->vordruckZeilennummer;
if (isset($this->semantischeIndexes)) $o['semantischeIndexes'] = JsonConverters::toArray('SemantischerIndex', $this->semantischeIndexes);
if (isset($this->untersachbereich)) $o['untersachbereich'] = $this->untersachbereich;
if (isset($this->privateKennnummer)) $o['privateKennnummer'] = $this->privateKennnummer;
if (isset($this->regelName)) $o['regelName'] = $this->regelName;
if (isset($this->fachlicheHinweisId)) $o['fachlicheHinweisId'] = $this->fachlicheHinweisId;
if (isset($this->text)) $o['text'] = $this->text;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a structure that contains the first output of the ERiC tax data submission process. */
// @Api(Description="Represents a structure that contains the first output of the ERiC tax data submission process.")
class EricBearbeiteVorgang implements JsonSerializable
{
public function __construct(
/** @description Information from the successful processing a tax declaration. */
// @ApiMember(Description="Information from the successful processing a tax declaration.")
/** @var Erfolg|null */
public ?Erfolg $erfolg=null,
/** @description Gets or sets information on all data deliveries, including deliveries that have not been confirmed by the server. */
// @ApiMember(Description="Gets or sets information on all data deliveries, including deliveries that have not been confirmed by the server.")
/** @var Transfers|null */
public ?Transfers $transfers=null,
/** @description Error rules that result from the processing of a tax declaration. */
// @ApiMember(Description="Error rules that result from the processing of a tax declaration.")
/** @var array<FehlerRegelpruefung>|null */
public ?array $fehlerRegelpruefungen=null,
/** @description Hints that result the processing of a tax declaration. */
// @ApiMember(Description="Hints that result the processing of a tax declaration.")
/** @var array<Hinweis>|null */
public ?array $hinweise=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['erfolg'])) $this->erfolg = JsonConverters::from('Erfolg', $o['erfolg']);
if (isset($o['transfers'])) $this->transfers = JsonConverters::from('Transfers', $o['transfers']);
if (isset($o['fehlerRegelpruefungen'])) $this->fehlerRegelpruefungen = JsonConverters::fromArray('FehlerRegelpruefung', $o['fehlerRegelpruefungen']);
if (isset($o['hinweise'])) $this->hinweise = JsonConverters::fromArray('Hinweis', $o['hinweise']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->erfolg)) $o['erfolg'] = JsonConverters::to('Erfolg', $this->erfolg);
if (isset($this->transfers)) $o['transfers'] = JsonConverters::to('Transfers', $this->transfers);
if (isset($this->fehlerRegelpruefungen)) $o['fehlerRegelpruefungen'] = JsonConverters::toArray('FehlerRegelpruefung', $this->fehlerRegelpruefungen);
if (isset($this->hinweise)) $o['hinweise'] = JsonConverters::toArray('Hinweis', $this->hinweise);
return empty($o) ? new class(){} : $o;
}
}
/** @description Auflistung der gültigen Verfahren */
enum Verfahren : string
{
case ElsterAnmeldung = 'ElsterAnmeldung';
case ElsterBereitstellung = 'ElsterBereitstellung';
case ElsterBilanz = 'ElsterBilanz';
case ElsterBRM = 'ElsterBRM';
case ElsterBRMOrg = 'ElsterBRMOrg';
case ElsterDatenabholung = 'ElsterDatenabholung';
case ElsterErklaerung = 'ElsterErklaerung';
case ElsterExtern = 'ElsterExtern';
case ElsterFSE = 'ElsterFSE';
case ElsterKapESt = 'ElsterKapESt';
case ElsterKMV = 'ElsterKMV';
case ElsterKontoabfrage = 'ElsterKontoabfrage';
case ElsterLavendel = 'ElsterLavendel';
case ElsterLohn = 'ElsterLohn';
case ElsterLohn2 = 'ElsterLohn2';
case ElsterNachricht = 'ElsterNachricht';
case ElsterSignatur = 'ElsterSignatur';
case ElsterVollmachtDB = 'ElsterVollmachtDB';
}
/** @description Auflistung aller gültigen Datenarten. */
enum Datenart : string
{
case Anlage34a = 'Anlage34a';
case AnpassungVorauszahlung = 'AnpassungVorauszahlung';
case AntragUStVerguetung4a = 'AntragUStVerguetung4a';
case AbrufcodeAntrag = 'AbrufcodeAntrag';
case AenderungAdresse = 'AenderungAdresse';
case AbrufcodeStorno = 'AbrufcodeStorno';
case AbrufvollmachtAnlage = 'AbrufvollmachtAnlage';
case AbrufvollmachtUpdate = 'AbrufvollmachtUpdate';
case AenderungBankverbindung = 'AenderungBankverbindung';
case AntraegeRechteLoeschen = 'AntraegeRechteLoeschen';
case AntraegeUndRechte = 'AntraegeUndRechte';
case Aufzeichnung146a = 'Aufzeichnung146a';
case BetPG = 'BetPG';
case Bilanz = 'Bilanz';
case Belegnachreichung = 'Belegnachreichung';
case BSBMitteilung = 'BSBMitteilung';
case BZSt2 = 'BZSt2';
case C19Mitteilung = 'C19Mitteilung';
case DUeAbmelden = 'DUeAbmelden';
case DUeAnmelden = 'DUeAnmelden';
case DUeUmmelden = 'DUeUmmelden';
case Einspruch = 'Einspruch';
case EinspruchNachtrag = 'EinspruchNachtrag';
case EinspruchRuecknahme = 'EinspruchRuecknahme';
case ELeVAntragELStAM = 'ELeVAntragELStAM';
case ELeVErmaessigung = 'ELeVErmaessigung';
case ELeVGetrenntlebend = 'ELeVGetrenntlebend';
case ELeVSteuerklassenwechsel = 'ELeVSteuerklassenwechsel';
case ELeVWiederaufnahmeEhe = 'ELeVWiederaufnahmeEhe';
case EPAntwort = 'EPAntwort';
case EPBescheid = 'EPBescheid';
case EPMitteilung = 'EPMitteilung';
case EPKurzmitteilung = 'EPKurzmitteilung';
case ElsterErklaerungDaten = 'ElsterErklaerungDaten';
case ElsterKMVDaten = 'ElsterKMVDaten';
case ElsterLohn2Daten = 'ElsterLohn2Daten';
case ElsterLohnDaten = 'ElsterLohnDaten';
case ElsterVaStDaten = 'ElsterVaStDaten';
case ElsterDIVADaten = 'ElsterDIVADaten';
case ElsterDIVDaten = 'ElsterDIVDaten';
case ElsterEPBescheidDaten = 'ElsterEPBescheidDaten';
case ElsterEPMitteilungDaten = 'ElsterEPMitteilungDaten';
case EPStBescheidAbholung = 'EPStBescheidAbholung';
case EPStMitteilungAbholung = 'EPStMitteilungAbholung';
case Erbschaftsteuer = 'Erbschaftsteuer';
case ESt = 'ESt';
case EStbeschraenkt = 'EStbeschraenkt';
case EUER = 'EUER';
case EUn = 'EUn';
case FEIN = 'FEIN';
case ForschungZulAntrag = 'ForschungZulAntrag';
case KStAntragOptionPersG = 'KStAntragOptionPersG';
case FLHMitteilung = 'FLHMitteilung';
case FreistellungKapitalertraegeBV = 'FreistellungKapitalertraegeBV';
case Fristverlaengerung = 'Fristverlaengerung';
case FsEVerein = 'FsEVerein';
case Gewerbemeldung = 'Gewerbemeldung';
case GDBMitteilung = 'GDBMitteilung';
case Gewinnermittlung13aEStG = 'Gewinnermittlung13aEStG';
case GewSt = 'GewSt';
case GewStZ = 'GewStZ';
case GrundsteuerBW = 'GrundsteuerBW';
case GrundsteuerBY = 'GrundsteuerBY';
case GrundsteuerHE = 'GrundsteuerHE';
case GrundsteuerHH = 'GrundsteuerHH';
case GrundsteuerNI = 'GrundsteuerNI';
case Grundsteuerwert = 'Grundsteuerwert';
case InvStG56Abs5 = 'InvStG56Abs5';
case InvStG51Feststellung = 'InvStG51Feststellung';
case KapEStA = 'KapEStA';
case KapEStInvStG = 'KapEStInvStG';
case KapG = 'KapG';
case KapGAus = 'KapGAus';
case KKVMitteilung = 'KKVMitteilung';
case Kontoabfrage = 'Kontoabfrage';
case Kontoinformation = 'Kontoinformation';
case KSt = 'KSt';
case KStZ = 'KStZ';
case KTTAnmeldungHH = 'KTTAnmeldungHH';
case KTTAnzeigeHH = 'KTTAnzeigeHH';
case Lohnersatzleistung = 'Lohnersatzleistung';
case LohnersatzMitteilung = 'LohnersatzMitteilung';
case LStA = 'LStA';
case LStB = 'LStB';
case LStHVVMAnlage = 'LStHVVMAnlage';
case LStHVVMUpdate = 'LStHVVMUpdate';
case OGHMitteilung = 'OGHMitteilung';
case VermoegenswirksameLeistung = 'VermoegenswirksameLeistung';
case VMWiderruf = 'VMWiderruf';
case VollmachtDetails = 'VollmachtDetails';
case VNoVMVRegistrierung = 'VNoVMVRegistrierung';
case VNoVMVUpdate = 'VNoVMVUpdate';
case VNoVMVLoeschung = 'VNoVMVLoeschung';
case VollfAAnlage = 'VollfAAnlage';
case VollfAUpdate = 'VollfAUpdate';
case VMoVMVStBAnlage = 'VMoVMVStBAnlage';
case VMoVMVStBUpdate = 'VMoVMVStBUpdate';
case VMoVMVFreischaltung = 'VMoVMVFreischaltung';
case VAGMitteilung = 'VAGMitteilung';
case DIVADatenBZSt = 'DIVADatenBZSt';
case DivaEinwilligungAnlageBRM = 'DivaEinwilligungAnlageBRM';
case DivaEinwilligungFreisch = 'DivaEinwilligungFreisch';
case DivaEinwilligungUpdateBRM = 'DivaEinwilligungUpdateBRM';
case DivaWiderrufBRM = 'DivaWiderrufBRM';
case DivaErgebnisliste = 'DivaErgebnisliste';
case LStHVDivaAdresseBRM = 'LStHVDivaAdresseBRM';
case VMErgebnisListeVNSicht = 'VMErgebnisListeVNSicht';
case PersG = 'PersG';
case PostfachAnfrage = 'PostfachAnfrage';
case PostfachStatus = 'PostfachStatus';
case ProtokollAnforderung = 'ProtokollAnforderung';
case Registrierung = 'Registrierung';
case Schenkungsteuer = 'Schenkungsteuer';
case SonstigeNachrichten = 'SonstigeNachrichten';
case SpezRechtAntrag = 'SpezRechtAntrag';
case SpezRechtFreischaltung = 'SpezRechtFreischaltung';
case SpezRechtListe = 'SpezRechtListe';
case SpezRechtStorno = 'SpezRechtStorno';
case SpezRechtTeilnahme = 'SpezRechtTeilnahme';
case StAb50a = 'StAb50a';
case Statusabfrage = 'Statusabfrage';
case UnentgeltlicheDepotuebertragung = 'UnentgeltlicheDepotuebertragung';
case UENSTAnmeldungBE = 'UENSTAnmeldungBE';
case UENSTAnzeigeBE = 'UENSTAnzeigeBE';
case USt = 'USt';
case UStVA = 'UStVA';
case UStDV = 'UStDV';
case UStSV = 'UStSV';
case VGNAnmeldungHB = 'VGNAnmeldungHB';
case VGNAnmeldungBE = 'VGNAnmeldungBE';
case VGNAnmeldungHH = 'VGNAnmeldungHH';
case VGNAnzeigeHH = 'VGNAnzeigeHH';
case WTBAnmeldungHB = 'WTBAnmeldungHB';
case ZMDO = 'ZMDO';
case ElsterVollmachtDaten = 'ElsterVollmachtDaten';
case MitteilungAbholung = 'MitteilungAbholung';
}
/** @description Hauptinformation ob die Daten authentifiziert wurden (send-Auth) oder nicht (send-NoSig) */
enum Vorgang : string
{
case Send_Auth = 'Send_Auth';
case Send_Auth_Part = 'Send_Auth_Part';
case Send_NoSig = 'Send_NoSig';
case Send_NoSig_Part = 'Send_NoSig_Part';
}
/** @description Kennzeichnung der Datenlieferung ob es sich um einen Testfall handelt, gilt fuer die gesamte Datenlieferung. Ein Echtfall enthält dieses Element nicht. Ein Testfall muss mit einem Testmerker versehen werden, damit er nicht wie ein Echtfall verarbeitet wird. Handelt es sich um Daten, die nur zum Testen des Frontends versendet wurden, müssen sie nicht mehr weiter verarbeitet werden. */
enum Testmerker : int
{
case TM010000001 = 10000001;
case TM080000001 = 80000001;
case TM160000001 = 160000001;
case TM160000002 = 160000002;
case TM220000000 = 220000000;
case TM220002000 = 220002000;
case TM230000001 = 230000001;
case TM240000000 = 240000000;
case TM370000001 = 370000001;
case TM520000000 = 520000000;
case TM700000001 = 700000001;
case TM700000004 = 700000004;
}
/** @description Represents the signature and associated information of the compressed, encrypted, base64-encoded content of the data part of the tax declaration/statement. */
// @Api(Description="Represents the signature and associated information of the compressed, encrypted, base64-encoded content of the data part of the tax declaration/statement.")
class SigUser implements JsonSerializable
{
public function __construct(
/** @description The content of the data. Currently supported: Raw XML (text), XElement or IXmlSerializable */
// @ApiMember(Description="The content of the data. Currently supported: Raw XML (text), XElement or IXmlSerializable")
/** @var Object|null */
public ?Object $inhalt=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['inhalt'])) $this->inhalt = JsonConverters::from('Object', $o['inhalt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->inhalt)) $o['inhalt'] = JsonConverters::to('Object', $this->inhalt);
return empty($o) ? new class(){} : $o;
}
}
/** @description Einheitliche Abkürzungen fuer die Bundesländer bzw. alternative Empfänger */
enum Bundesland : string
{
case BW = 'BW';
case BY = 'BY';
case BE = 'BE';
case BB = 'BB';
case HB = 'HB';
case HH = 'HH';
case HE = 'HE';
case MV = 'MV';
case NI = 'NI';
case NW = 'NW';
case RP = 'RP';
case SL = 'SL';
case SN = 'SN';
case ST = 'ST';
case SH = 'SH';
case TH = 'TH';
case EC = 'EC';
case BF = 'BF';
case CS = 'CS';
case CD = 'CD';
case CM = 'CM';
case CN = 'CN';
case DS = 'DS';
case OP = 'OP';
case TK = 'TK';
case ZF = 'ZF';
}
/** @description Represents a receiver of tax data. */
// @Api(Description="Represents a receiver of tax data.")
class Empfaenger implements JsonSerializable
{
public function __construct(
/** @description The identifier of the receiver. */
// @ApiMember(Description="The identifier of the receiver.")
/** @var string|null */
public ?string $id=null,
/** @description The destination of the receiver. */
// @ApiMember(Description="The destination of the receiver.")
/** @var Bundesland|null */
public ?Bundesland $ziel=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['ziel'])) $this->ziel = JsonConverters::from('Bundesland', $o['ziel']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->ziel)) $o['ziel'] = JsonConverters::to('Bundesland', $this->ziel);
return empty($o) ? new class(){} : $o;
}
}
/** @description Protokoll der Verschluesselung. Es kann vorkommen, dass verschieden Verschluesselungsarten eingesetzt werden, eine Unterscheidung ist hier nötig, um das richtige Entschluesselungstool anzusteuern. Mit welcher Verschluesselungsart wurden die Inhalte von den Elementen 'DatenLieferant' und ggf. 'SigUser' im TransferHeader und dem Element 'DatenTeil' verschluesselt */
enum Verschluesselungsart : string
{
case PKCS_7v1_5 = 'PKCS_7v1_5';
case PKCS_7v1_5enveloped = 'PKCS_7v1_5enveloped';
case NO_BASE64 = 'NO_BASE64';
case CMSEncryptedData = 'CMSEncryptedData';
case CMSEnvelopedData = 'CMSEnvelopedData';
case EnvelopedData__RSA_OAEP__AES_128__GZip__B64 = 'EnvelopedData__RSA_OAEP__AES_128__GZip__B64';
}
/** @description Mit welcher Kompression wurden die Inhalte von den Elementen DatenLieferant und ggf. SigUser im TransferHeader und dem Element DatenTeil komprimiert. */
enum Kompression : string
{
case GZIP = 'GZIP';
case NO_BASE64 = 'NO_BASE64';
}
/** @description [Documentation unavailable] */
// @Api(Description="[Documentation unavailable]")
class EricTyp implements JsonSerializable
{
public function __construct(
/** @description The content of the data. Currently supported: Raw XML (text), XmlElement, XElement or IXmlSerializable */
// @ApiMember(Description="The content of the data. Currently supported: Raw XML (text), XmlElement, XElement or IXmlSerializable")
/** @var Object|null */
public ?Object $inhalt=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['inhalt'])) $this->inhalt = JsonConverters::from('Object', $o['inhalt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->inhalt)) $o['inhalt'] = JsonConverters::to('Object', $this->inhalt);
return empty($o) ? new class(){} : $o;
}
}
/** @description [Documentation unavailable] */
// @Api(Description="[Documentation unavailable]")
class Erstellung implements JsonSerializable
{
public function __construct(
/** @description [Documentation unavailable] */
// @ApiMember(Description="[Documentation unavailable]")
/** @var EricTyp|null */
public ?EricTyp $eric=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['eric'])) $this->eric = JsonConverters::from('EricTyp', $o['eric']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->eric)) $o['eric'] = JsonConverters::to('EricTyp', $this->eric);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents information on the encryption of tax data. */
// @Api(Description="Represents information on the encryption of tax data.")
class Datei implements JsonSerializable
{
public function __construct(
/** @description The type of data encryption used. */
// @ApiMember(Description="The type of data encryption used.")
/** @var Verschluesselungsart|null */
public ?Verschluesselungsart $verschluesselung=null,
/** @description The type of data compression used. */
// @ApiMember(Description="The type of data compression used.")
/** @var Kompression|null */
public ?Kompression $kompression=null,
/** @description The transport key used in the encryption. */
// @ApiMember(Description="The transport key used in the encryption.")
/** @var string|null */
public ?string $transportSchluessel=null,
/** @description [Documentation unavailable] */
// @ApiMember(Description="[Documentation unavailable]")
/** @var Erstellung|null */
public ?Erstellung $erstellung=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['verschluesselung'])) $this->verschluesselung = JsonConverters::from('Verschluesselungsart', $o['verschluesselung']);
if (isset($o['kompression'])) $this->kompression = JsonConverters::from('Kompression', $o['kompression']);
if (isset($o['transportSchluessel'])) $this->transportSchluessel = $o['transportSchluessel'];
if (isset($o['erstellung'])) $this->erstellung = JsonConverters::from('Erstellung', $o['erstellung']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->verschluesselung)) $o['verschluesselung'] = JsonConverters::to('Verschluesselungsart', $this->verschluesselung);
if (isset($this->kompression)) $o['kompression'] = JsonConverters::to('Kompression', $this->kompression);
if (isset($this->transportSchluessel)) $o['transportSchluessel'] = $this->transportSchluessel;
if (isset($this->erstellung)) $o['erstellung'] = JsonConverters::to('Erstellung', $this->erstellung);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents an external error stack. */
// @Api(Description="Represents an external error stack.")
class Rueckgabe implements JsonSerializable
{
public function __construct(
/** @description The external error code. Either a zero (0) if no external errors occurred; otherwise an error number. */
// @ApiMember(Description="The external error code. Either a zero (0) if no external errors occurred; otherwise an error number.")
/** @var string|null */
public ?string $code=null,
/** @description The external error message. */
// @ApiMember(Description="The external error message.")
/** @var string|null */
public ?string $text=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['code'])) $this->code = $o['code'];
if (isset($o['text'])) $this->text = $o['text'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->code)) $o['code'] = $this->code;
if (isset($this->text)) $o['text'] = $this->text;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents an internal error stack. */
// @Api(Description="Represents an internal error stack.")
class Stack implements JsonSerializable
{
public function __construct(
/** @description The internal error code. Either a zero (0) if no internal errors occurred; otherwise an error number. */
// @ApiMember(Description="The internal error code. Either a zero (0) if no internal errors occurred; otherwise an error number.")
/** @var string|null */
public ?string $code=null,
/** @description The external error message. */
// @ApiMember(Description="The external error message.")
/** @var string|null */
public ?string $text=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['code'])) $this->code = $o['code'];
if (isset($o['text'])) $this->text = $o['text'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->code)) $o['code'] = $this->code;
if (isset($this->text)) $o['text'] = $this->text;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents an ERiC return code. */
// @Api(Description="Represents an ERiC return code.")
class RC implements JsonSerializable
{
public function __construct(
/** @description The return value of the return code. */
// @ApiMember(Description="The return value of the return code.")
/** @var Rueckgabe|null */
public ?Rueckgabe $rueckgabe=null,
/** @description The internal value of the return code. */
// @ApiMember(Description="The internal value of the return code.")
/** @var Stack|null */
public ?Stack $stack=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['rueckgabe'])) $this->rueckgabe = JsonConverters::from('Rueckgabe', $o['rueckgabe']);
if (isset($o['stack'])) $this->stack = JsonConverters::from('Stack', $o['stack']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->rueckgabe)) $o['rueckgabe'] = JsonConverters::to('Rueckgabe', $this->rueckgabe);
if (isset($this->stack)) $o['stack'] = JsonConverters::to('Stack', $this->stack);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents an ERiC extension. */
// @Api(Description="Represents an ERiC extension.")
class Zusatz implements JsonSerializable
{
public function __construct(
/** @description The user-customizable items for the extension. Data providers can use these items for their own extensions/information. */
// @ApiMember(Description="The user-customizable items for the extension. Data providers can use these items for their own extensions/information.")
/** @var array<string>|null */
public ?array $infos=null,
/** @description The ELSTER items for the extension. They can be included in the response XML from the ELSTER server, if special information must be returned to the user after data submission. For example, for authenticated submission, information about impending certificate expiration etc. It must not be supplied by the data provider (even when empty). */
// @ApiMember(Description="The ELSTER items for the extension. They can be included in the response XML from the ELSTER server, if special information must be returned to the user after data submission. For example, for authenticated submission, information about impending certificate expiration etc. It must not be supplied by the data provider (even when empty).")
/** @var array<string>|null */
public ?array $elsterInfos=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['infos'])) $this->infos = JsonConverters::fromArray('string', $o['infos']);
if (isset($o['elsterInfos'])) $this->elsterInfos = JsonConverters::fromArray('string', $o['elsterInfos']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->infos)) $o['infos'] = JsonConverters::toArray('string', $this->infos);
if (isset($this->elsterInfos)) $o['elsterInfos'] = JsonConverters::toArray('string', $this->elsterInfos);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents the transfer header part of an ELSTER document. */
// @Api(Description="Represents the transfer header part of an ELSTER document.")
class TransferHeader implements JsonSerializable
{
public function __construct(
/** @description The version of the transfer header. */
// @ApiMember(Description="The version of the transfer header.", IsRequired=true)
/** @var string */
public string $version='',
/** @description The tax operation used in the ELSTER process. */
// @ApiMember(Description="The tax operation used in the ELSTER process.", IsRequired=true)
/** @var Verfahren|null */
public ?Verfahren $verfahren=null,
/** @description The tax data type of the ELSTER process. */
// @ApiMember(Description="The tax data type of the ELSTER process.", IsRequired=true)
/** @var Datenart|null */
public ?Datenart $datenArt=null,
/** @description The authentification procedure of the ELSTER process. */
// @ApiMember(Description="The authentification procedure of the ELSTER process.", IsRequired=true)
/** @var Vorgang|null */
public ?Vorgang $vorgang=null,
/** @description The ticket identifier after a successful ELSTER process. */
// @ApiMember(Description="The ticket identifier after a successful ELSTER process.")
/** @var string|null */
public ?string $transferTicket=null,
/** @description The flag that indicates whether the tax declaration or filing is a test case. For production purposes, this value should not be set. */
// @ApiMember(Description="The flag that indicates whether the tax declaration or filing is a test case. For production purposes, this value should not be set.")
/** @var Testmerker|null */
public ?Testmerker $testmerker=null,
/** @description The signature and associated information on the compressed, encrypted, base64-encoded content of the the data part of a tax declaration / statement. */
// @ApiMember(Description="The signature and associated information on the compressed, encrypted, base64-encoded content of the the data part of a tax declaration / statement.")
/** @var SigUser|null */
public ?SigUser $sigUser=null,
/** @description The receiving ELSTER server. */
// @ApiMember(Description="The receiving ELSTER server.")
/** @var Empfaenger|null */
public ?Empfaenger $empfaenger=null,
/** @description The identifier of the software manufacturer, through whose software the tax declaration is filed. */
// @ApiMember(Description="The identifier of the software manufacturer, through whose software the tax declaration is filed.", IsRequired=true)
/** @var string */
public string $herstellerID='',
/** @description The details of the provider that submits tax data. */
// @ApiMember(Description="The details of the provider that submits tax data.", IsRequired=true)
/** @var string */
public string $datenLieferant='',
/** @description The date of receipt of the tax data. */
// @ApiMember(Description="The date of receipt of the tax data.")
/** @var DateTime|null */
public ?DateTime $eingangsDatum=null,
/** @description The encryption data required for authenticated transmission of tax data. */
// @ApiMember(Description="The encryption data required for authenticated transmission of tax data.")
/** @var Datei|null */
public ?Datei $datei=null,
/** @description The return code of the transfer header and is included in the response XML of the ELSTER server. The value should never be set by the data provider. */
// @ApiMember(Description="The return code of the transfer header and is included in the response XML of the ELSTER server. The value should never be set by the data provider.")
/** @var RC|null */
public ?RC $rc=null,
/** @description The details of the software that submits the tax data. */
// @ApiMember(Description="The details of the software that submits the tax data.")
/** @var string|null */
public ?string $versionClient=null,
/** @description Data extensions to the transfer header. */
// @ApiMember(Description="Data extensions to the transfer header.")
/** @var Zusatz|null */
public ?Zusatz $zusatz=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['version'])) $this->version = $o['version'];
if (isset($o['verfahren'])) $this->verfahren = JsonConverters::from('Verfahren', $o['verfahren']);
if (isset($o['datenArt'])) $this->datenArt = JsonConverters::from('Datenart', $o['datenArt']);
if (isset($o['vorgang'])) $this->vorgang = JsonConverters::from('Vorgang', $o['vorgang']);
if (isset($o['transferTicket'])) $this->transferTicket = $o['transferTicket'];
if (isset($o['testmerker'])) $this->testmerker = JsonConverters::from('Testmerker', $o['testmerker']);
if (isset($o['sigUser'])) $this->sigUser = JsonConverters::from('SigUser', $o['sigUser']);
if (isset($o['empfaenger'])) $this->empfaenger = JsonConverters::from('Empfaenger', $o['empfaenger']);
if (isset($o['herstellerID'])) $this->herstellerID = $o['herstellerID'];
if (isset($o['datenLieferant'])) $this->datenLieferant = $o['datenLieferant'];
if (isset($o['eingangsDatum'])) $this->eingangsDatum = JsonConverters::from('DateTime', $o['eingangsDatum']);
if (isset($o['datei'])) $this->datei = JsonConverters::from('Datei', $o['datei']);
if (isset($o['rc'])) $this->rc = JsonConverters::from('RC', $o['rc']);
if (isset($o['versionClient'])) $this->versionClient = $o['versionClient'];
if (isset($o['zusatz'])) $this->zusatz = JsonConverters::from('Zusatz', $o['zusatz']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->version)) $o['version'] = $this->version;
if (isset($this->verfahren)) $o['verfahren'] = JsonConverters::to('Verfahren', $this->verfahren);
if (isset($this->datenArt)) $o['datenArt'] = JsonConverters::to('Datenart', $this->datenArt);
if (isset($this->vorgang)) $o['vorgang'] = JsonConverters::to('Vorgang', $this->vorgang);
if (isset($this->transferTicket)) $o['transferTicket'] = $this->transferTicket;
if (isset($this->testmerker)) $o['testmerker'] = JsonConverters::to('Testmerker', $this->testmerker);
if (isset($this->sigUser)) $o['sigUser'] = JsonConverters::to('SigUser', $this->sigUser);
if (isset($this->empfaenger)) $o['empfaenger'] = JsonConverters::to('Empfaenger', $this->empfaenger);
if (isset($this->herstellerID)) $o['herstellerID'] = $this->herstellerID;
if (isset($this->datenLieferant)) $o['datenLieferant'] = $this->datenLieferant;
if (isset($this->eingangsDatum)) $o['eingangsDatum'] = JsonConverters::to('DateTime', $this->eingangsDatum);
if (isset($this->datei)) $o['datei'] = JsonConverters::to('Datei', $this->datei);
if (isset($this->rc)) $o['rc'] = JsonConverters::to('RC', $this->rc);
if (isset($this->versionClient)) $o['versionClient'] = $this->versionClient;
if (isset($this->zusatz)) $o['zusatz'] = JsonConverters::to('Zusatz', $this->zusatz);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a receriver ID */
enum EmpfaengerID : string
{
case L = 'L';
case F = 'F';
}
/** @description Represents a receiver of tax data. */
// @Api(Description="Represents a receiver of tax data.")
class NDHEmpfaenger implements JsonSerializable
{
public function __construct(
/** @description The identifier of the receiver. */
// @ApiMember(Description="The identifier of the receiver.")
/** @var EmpfaengerID|null */
public ?EmpfaengerID $id=null,
/** @description The value of the receiver. */
// @ApiMember(Description="The value of the receiver.")
/** @var string|null */
public ?string $value=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = JsonConverters::from('EmpfaengerID', $o['id']);
if (isset($o['value'])) $this->value = $o['value'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = JsonConverters::to('EmpfaengerID', $this->id);
if (isset($this->value)) $o['value'] = $this->value;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a manufacturer/vendor of tax software. */
// @Api(Description="Represents a manufacturer/vendor of tax software.")
class Hersteller implements JsonSerializable
{
public function __construct(
/** @description The product name of the tax software produced by the manufacturer. */
// @ApiMember(Description="The product name of the tax software produced by the manufacturer.")
/** @var string|null */
public ?string $produktName=null,
/** @description The product version of the tax software produced by the manufacturer. */
// @ApiMember(Description="The product version of the tax software produced by the manufacturer.")
/** @var string|null */
public ?string $produktVersion=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['produktName'])) $this->produktName = $o['produktName'];
if (isset($o['produktVersion'])) $this->produktVersion = $o['produktVersion'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->produktName)) $o['produktName'] = $this->produktName;
if (isset($this->produktVersion)) $o['produktVersion'] = $this->produktVersion;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents the header of a tax data. */
// @Api(Description="Represents the header of a tax data.")
class NutzdatenHeader implements JsonSerializable
{
public function __construct(
/** @description The version of the header. */
// @ApiMember(Description="The version of the header.", IsRequired=true)
/** @var string */
public string $version='',
/** @description The ticket identifier of the header. */
// @ApiMember(Description="The ticket identifier of the header.", IsRequired=true)
/** @var string */
public string $nutzdatenTicket='',
/** @description The receiver of the header. */
// @ApiMember(Description="The receiver of the header.", IsRequired=true)
/** @var NDHEmpfaenger|null */
public ?NDHEmpfaenger $empfaenger=null,
/** @description The software manufacturer, through whose software the tax declaration or filing is submitted. */
// @ApiMember(Description="The software manufacturer, through whose software the tax declaration or filing is submitted.", IsRequired=true)
/** @var Hersteller|null */
public ?Hersteller $hersteller=null,
/** @description The details of the data provider (e.g. taxpayer, tax consulant or firm), who produced the tax data and it must not necessarily be the same person declared in the TransferHeader section. */
// @ApiMember(Description="The details of the data provider (e.g. taxpayer, tax consulant or firm), who produced the tax data and it must not necessarily be the same person declared in the TransferHeader section.")
/** @var string|null */
public ?string $datenLieferant=null,
/** @description The return code of the header. */
// @ApiMember(Description="The return code of the header.")
/** @var RC|null */
public ?RC $rc=null,
/** @description The data extensions of the header. */
// @ApiMember(Description="The data extensions of the header.")
/** @var Zusatz|null */
public ?Zusatz $zusatz=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['version'])) $this->version = $o['version'];
if (isset($o['nutzdatenTicket'])) $this->nutzdatenTicket = $o['nutzdatenTicket'];
if (isset($o['empfaenger'])) $this->empfaenger = JsonConverters::from('NDHEmpfaenger', $o['empfaenger']);
if (isset($o['hersteller'])) $this->hersteller = JsonConverters::from('Hersteller', $o['hersteller']);
if (isset($o['datenLieferant'])) $this->datenLieferant = $o['datenLieferant'];
if (isset($o['rc'])) $this->rc = JsonConverters::from('RC', $o['rc']);
if (isset($o['zusatz'])) $this->zusatz = JsonConverters::from('Zusatz', $o['zusatz']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->version)) $o['version'] = $this->version;
if (isset($this->nutzdatenTicket)) $o['nutzdatenTicket'] = $this->nutzdatenTicket;
if (isset($this->empfaenger)) $o['empfaenger'] = JsonConverters::to('NDHEmpfaenger', $this->empfaenger);
if (isset($this->hersteller)) $o['hersteller'] = JsonConverters::to('Hersteller', $this->hersteller);
if (isset($this->datenLieferant)) $o['datenLieferant'] = $this->datenLieferant;
if (isset($this->rc)) $o['rc'] = JsonConverters::to('RC', $this->rc);
if (isset($this->zusatz)) $o['zusatz'] = JsonConverters::to('Zusatz', $this->zusatz);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents an encapsulation of tax data content. */
// @Api(Description="Represents an encapsulation of tax data content.")
class Nutzdaten implements JsonSerializable
{
public function __construct(
/** @description The content of the tax data. This varies by tax declaration. Currently supported formats: Raw XML (text), XElement, and IXmlSerializable */
// @ApiMember(Description="The content of the tax data. This varies by tax declaration. Currently supported formats: Raw XML (text), XElement, and IXmlSerializable", IsRequired=true)
/** @var Object|null */
public ?Object $inhalt=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['inhalt'])) $this->inhalt = JsonConverters::from('Object', $o['inhalt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->inhalt)) $o['inhalt'] = JsonConverters::to('Object', $this->inhalt);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a block of tax data. */
// @Api(Description="Represents a block of tax data.")
class Nutzdatenblock implements JsonSerializable
{
public function __construct(
/** @description The header part of the block. */
// @ApiMember(Description="The header part of the block.", IsRequired=true)
/** @var NutzdatenHeader|null */
public ?NutzdatenHeader $nutzdatenHeader=null,
/** @description The data part of the block. */
// @ApiMember(Description="The data part of the block.", IsRequired=true)
/** @var Nutzdaten|null */
public ?Nutzdaten $nutzdaten=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['nutzdatenHeader'])) $this->nutzdatenHeader = JsonConverters::from('NutzdatenHeader', $o['nutzdatenHeader']);
if (isset($o['nutzdaten'])) $this->nutzdaten = JsonConverters::from('Nutzdaten', $o['nutzdaten']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->nutzdatenHeader)) $o['nutzdatenHeader'] = JsonConverters::to('NutzdatenHeader', $this->nutzdatenHeader);
if (isset($this->nutzdaten)) $o['nutzdaten'] = JsonConverters::to('Nutzdaten', $this->nutzdaten);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents the data part of an ELSTER document. */
// @Api(Description="Represents the data part of an ELSTER document.")
class DatenTeil implements JsonSerializable
{
public function __construct(
/** @description The blocks of tax data of the ELSTER document. */
// @ApiMember(Description="The blocks of tax data of the ELSTER document.", IsRequired=true)
/** @var array<Nutzdatenblock>|null */
public ?array $nutzdatenbloecke=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['nutzdatenbloecke'])) $this->nutzdatenbloecke = JsonConverters::fromArray('Nutzdatenblock', $o['nutzdatenbloecke']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->nutzdatenbloecke)) $o['nutzdatenbloecke'] = JsonConverters::toArray('Nutzdatenblock', $this->nutzdatenbloecke);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents an ELSTER document. */
// @Api(Description="Represents an ELSTER document.")
class Elster implements JsonSerializable
{
public function __construct(
/** @description The transfer header part of the ELSTER document. */
// @ApiMember(Description="The transfer header part of the ELSTER document.", IsRequired=true)
/** @var TransferHeader|null */
public ?TransferHeader $transferHeader=null,
/** @description The data (facts) part of the ELSTER document. */
// @ApiMember(Description="The data (facts) part of the ELSTER document.")
/** @var DatenTeil|null */
public ?DatenTeil $datenTeil=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['transferHeader'])) $this->transferHeader = JsonConverters::from('TransferHeader', $o['transferHeader']);
if (isset($o['datenTeil'])) $this->datenTeil = JsonConverters::from('DatenTeil', $o['datenTeil']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->transferHeader)) $o['transferHeader'] = JsonConverters::to('TransferHeader', $this->transferHeader);
if (isset($this->datenTeil)) $o['datenTeil'] = JsonConverters::to('DatenTeil', $this->datenTeil);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a server response type that encapsulates acknowledgments of data receipt during the fifth phase of the data retrieval process. */
// @Api(Description="Represents a server response type that encapsulates acknowledgments of data receipt during the fifth phase of the data retrieval process.")
class EmpfangsBestaetigungResponse extends EricFehlerCodeResponse implements JsonSerializable
{
/**
* @param string $id
* @param int $index
* @param ResponseStatus|null $responseStatus
* @param EricFehlerCode|null $statusCode
* @param string|null $statusText
* @param string $id
* @param int $index
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
string $id='',
int $index=0,
?ResponseStatus $responseStatus=null,
?EricFehlerCode $statusCode=null,
?string $statusText=null,
string $id='',
int $index=0,
?ResponseStatus $responseStatus=null,
/** @description The list of receipt acknowledgements. */
// @ApiMember(Description="The list of receipt acknowledgements.", Name="Empfangsbestaetigungen")
/** @var array<Empfangsbestaetigung>|null */
public ?array $empfangsbestaetigungen=null,
/** @description The return value of the process. */
// @ApiMember(Description="The return value of the process.", Name="Rueckgabe")
/** @var EricBearbeiteVorgang|null */
public ?EricBearbeiteVorgang $rueckgabe=null,
/** @description The server response of the process. */
// @ApiMember(Description="The server response of the process.", Name="Serverantwort")
/** @var Elster|null */
public ?Elster $serverantwort=null
) {
parent::__construct($id,$index,$responseStatus,$statusCode,$statusText,$id,$index,$responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['empfangsbestaetigungen'])) $this->empfangsbestaetigungen = JsonConverters::fromArray('Empfangsbestaetigung', $o['empfangsbestaetigungen']);
if (isset($o['rueckgabe'])) $this->rueckgabe = JsonConverters::from('EricBearbeiteVorgang', $o['rueckgabe']);
if (isset($o['serverantwort'])) $this->serverantwort = JsonConverters::from('Elster', $o['serverantwort']);
if (isset($o['statusCode'])) $this->statusCode = JsonConverters::from('EricFehlerCode', $o['statusCode']);
if (isset($o['statusText'])) $this->statusText = $o['statusText'];
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 = parent::jsonSerialize();
if (isset($this->empfangsbestaetigungen)) $o['empfangsbestaetigungen'] = JsonConverters::toArray('Empfangsbestaetigung', $this->empfangsbestaetigungen);
if (isset($this->rueckgabe)) $o['rueckgabe'] = JsonConverters::to('EricBearbeiteVorgang', $this->rueckgabe);
if (isset($this->serverantwort)) $o['serverantwort'] = JsonConverters::to('Elster', $this->serverantwort);
if (isset($this->statusCode)) $o['statusCode'] = JsonConverters::to('EricFehlerCode', $this->statusCode);
if (isset($this->statusText)) $o['statusText'] = $this->statusText;
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 the service request to acknowledge the receipt of tax statements for payroll tax statements. */
// @Api(Description="Represents the service request to acknowledge the receipt of tax statements for payroll tax statements.")
class ElsterLohnDatenEmpfangsBestaetigungRequest extends ElsterLohnDatenEmpfangsBestaetigungRequestBase implements JsonSerializable
{
/**
* @param PortalCertificate|null $zertifikat
* @param string|null $abrufCode
* @param string $datenLieferant
* @param PortalCertificate|null $zertifikat
* @param string|null $abrufCode
* @param string $datenLieferant
* @param array<EmpfangsBestaetigungSuchkriterien>|null $suchkriterien
* @param PortalCertificate|null $zertifikat
* @param string|null $abrufCode
* @param string $datenLieferant
*/
public function __construct(
?PortalCertificate $zertifikat=null,
?string $abrufCode=null,
string $datenLieferant='',
?PortalCertificate $zertifikat=null,
?string $abrufCode=null,
string $datenLieferant='',
?array $suchkriterien=null,
?PortalCertificate $zertifikat=null,
?string $abrufCode=null,
string $datenLieferant=''
) {
parent::__construct($zertifikat,$abrufCode,$datenLieferant,$zertifikat,$abrufCode,$datenLieferant,$suchkriterien,$zertifikat,$abrufCode,$datenLieferant);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['suchkriterien'])) $this->suchkriterien = JsonConverters::fromArray('EmpfangsBestaetigungSuchkriterien', $o['suchkriterien']);
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'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->suchkriterien)) $o['suchkriterien'] = JsonConverters::toArray('EmpfangsBestaetigungSuchkriterien', $this->suchkriterien);
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;
return empty($o) ? new class(){} : $o;
}
}
PHP ElsterLohnDatenEmpfangsBestaetigungRequest 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 /datenabholungen/bestaetigungen/17/ElsterLohnDaten HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
suchkriterien:
[
{
id: String
}
],
zertifikat:
{
id: 00000000000000000000000000000000,
index: 0,
pin: String,
description: String,
tags:
[
String
],
name: String,
content: AA==
},
abrufCode: String,
datenLieferant: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
empfangsbestaetigungen:
[
{
id: String,
idnr: String,
veranlagungsjahr: 0
}
],
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: {}
}
}
]
}
},
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
}
}
}