Report Filing Service

<back to all web services

SubmitReport

SubmitReportSync

Represents a request to submit a report on the ELMA server.

Requires Authentication
The following routes are available for this service:
POST/sync/elma/reports/submit
<?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 an ELMA report. */
// @Api(Description="Represents an ELMA report.")
class Report implements JsonSerializable
{
    public function __construct(
        /** @description The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file. */
        // @ApiMember(Description="The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.", IsRequired=true, Name="Id")
        /** @var string */
        public string $id='',

        /** @description The XML-content of the report. */
        // @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
        /** @var string */
        public string $data=''
    ) {
    }

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

/** @description Represents a PEM-encoded certificate. */
// @Api(Description="Represents a PEM-encoded certificate.")
class PemCertificate implements JsonSerializable
{
    public function __construct(
        /** @description The unique identifier (e.g. the file name) of the certificate. */
        // @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
        /** @var string */
        public string $id='',

        /** @description The PEM-encoded content of the certificate. */
        // @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
        /** @var string */
        public string $content='',

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

        /** @description Tags to label or identify the certificate. */
        // @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
        /** @var array<string>|null */
        public ?array $tags=null
    ) {
    }

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

/** @description Represents the credentials of a user to authenticate the access of an ELMA server. */
// @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
class ElmaCredential implements IElmaCredential, JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval. */
        // @ApiMember(Description="The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id")
        /** @var string */
        public string $id='',

        /** @description The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start) */
        // @ApiMember(Description="The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)", IsRequired=true, Name="Certificate")
        // @Required()
        // @StringLength(2147483647)
        /** @var PemCertificate|null */
        public ?PemCertificate $certificate=null,

        /** @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
        // @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")
        // @Required()
        // @StringLength(11)
        /** @var string */
        public string $authSteuernummer='',

        /** @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
        // @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
        // @Required()
        // @StringLength(10)
        /** @var string */
        public string $accountId='',

        /** @description The password to protect the certificate from unauthorized access. */
        // @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
        /** @var string */
        public string $password=''
    ) {
    }

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

/** @description Specifies a request to submit a report on the ELMA server. */
// @Api(Description="Specifies a request to submit a report on the ELMA server.")
class SubmitReportBase implements IPost, IAuthenticateRequest, ISingleUploadRequest, IStageableRequest, JsonSerializable
{
    public function __construct(
        /** @description The report to submit. */
        // @ApiMember(Description="The report to submit.", IsRequired=true)
        /** @var Report|null */
        public ?Report $report=null,

        /** @description The credential to gain access on the ELMA server. */
        // @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true)
        /** @var ElmaCredential|null */
        public ?ElmaCredential $credential=null,

        /** @description Should the report data be validated before sending it to the ELMA server? true: report data is validated before it is sent to the ELMA server. false: report data sent without validation to the ELMA server. */
        // @ApiMember(Description="Should the report data be validated before sending it to the ELMA server? true: report data is validated before it is sent to the ELMA server. false: report data sent without validation to the ELMA server.", IsRequired=true)
        /** @var bool|null */
        public ?bool $validationEnabled=null,

        /** @description Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server. */
        // @ApiMember(Description="Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.")
        /** @var bool|null */
        public ?bool $stagingEnabled=null
    ) {
    }

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

/** @description Represents a  failure encountered during the validation of an ELMA report against its XML schema.  */
// @Api(Description="Represents a  failure encountered during the validation of an ELMA report against its XML schema. ")
class ValidationError implements JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of the validation faílure. This is equivalent to the file name of the validated report. */
        // @ApiMember(Description="The unique identifier of the validation faílure.\n This is equivalent to the file name of the validated report.", Name="Id")
        /** @var string|null */
        public ?string $id=null,

        /** @description The message of the validation failure. */
        // @ApiMember(Description="The message of the validation failure.", Name="Message")
        /** @var string|null */
        public ?string $message=null,

        /** @description The severity of the validation faílure. */
        // @ApiMember(Description="The severity of the validation faílure.", Name="Severity")
        /** @var XmlSeverityType|null */
        public ?XmlSeverityType $severity=null,

        /** @description The line number indicating where the error occurred. */
        // @ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
        /** @var int */
        public int $lineNumber=0,

        /** @description The line position indicating where the error occurred. */
        // @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
        /** @var int */
        public int $linePosition=0
    ) {
    }

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

/** @description Encapsulates the results of submitting a report */
// @Api(Description="Encapsulates the results of submitting a report")
class SubmissionResponse implements JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of the report that was processed. */
        // @ApiMember(Description="The unique identifier of the report that was processed.", Name="Id")
        /** @var string|null */
        public ?string $id=null,

        /** @description The submitted XML-based report content. */
        // @ApiMember(Description="The submitted XML-based report content.", Name="Xml")
        /** @var string|null */
        public ?string $xml=null,

        /** @description The errors encountered during the validation phase of the report submission operation. */
        // @ApiMember(Description="The errors encountered during the validation phase of the report submission operation.", Name="ValidationErrors")
        /** @var array<ValidationError>|null */
        public ?array $validationErrors=null,

        /** @description The status of the report submission operation. */
        // @ApiMember(Description="The status of the report submission operation.", 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['xml'])) $this->xml = $o['xml'];
        if (isset($o['validationErrors'])) $this->validationErrors = JsonConverters::fromArray('ValidationError', $o['validationErrors']);
        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->xml)) $o['xml'] = $this->xml;
        if (isset($this->validationErrors)) $o['validationErrors'] = JsonConverters::toArray('ValidationError', $this->validationErrors);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Represents a request to submit a report on the ELMA server. */
// @Api(Description="Represents a request to submit a report on the ELMA server.")
class SubmitReport extends SubmitReportBase implements JsonSerializable
{
    /**
     * @param Report|null $report
     * @param ElmaCredential|null $credential
     * @param bool|null $validationEnabled
     * @param bool|null $stagingEnabled
     */
    public function __construct(
        ?Report $report=null,
        ?ElmaCredential $credential=null,
        ?bool $validationEnabled=null,
        ?bool $stagingEnabled=null
    ) {
        parent::__construct($report,$credential,$validationEnabled,$stagingEnabled);
    }

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

PHP SubmitReport DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sync/elma/reports/submit HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"report":{"id":"String","data":"String"},"credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"validationEnabled":false,"stagingEnabled":false}

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

{"id":"String","xml":"String","validationErrors":[{"id":"String","message":"String","severity":"Error","lineNumber":0,"linePosition":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}
© 2020 - 2025 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Portions of this program may use third-party open source components governed by the respective open source license terms.