Report Filing Service

<back to all web services

ValidateReportAsync

ValidateReportAsync

Represents a request to validate a report in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
POST/async/elma/reports/validate
<?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 Specifies a request to validate a report. */
// @Api(Description="Specifies a request to validate a report.")
class ValidateReportBase implements IPost, JsonSerializable
{
    public function __construct(
        /** @description The report to validate. */
        // @ApiMember(Description="The report to validate.", IsRequired=true)
        /** @var Report|null */
        public ?Report $report=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['report'])) $this->report = JsonConverters::from('Report', $o['report']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->report)) $o['report'] = JsonConverters::to('Report', $this->report);
        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 validating a report */
// @Api(Description="Encapsulates the results of validating a report")
class ValidationResponse implements JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of the report that was processed.The identifier is usually the filename. */
        // @ApiMember(Description="The unique identifier of the report that was processed.\nThe identifier is usually the filename.", Name="Id")
        /** @var string|null */
        public ?string $id=null,

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

        /** @description The status of the validation operation. */
        // @ApiMember(Description="The status of the validation 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['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->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 validate a report in an asynchronous operation. */
// @Api(Description="Represents a request to validate a report in an asynchronous operation.")
class ValidateReportAsync extends ValidateReportBase implements JsonSerializable
{
    /**
     * @param Report|null $report
     */
    public function __construct(
        ?Report $report=null
    ) {
        parent::__construct($report);
    }

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

PHP ValidateReportAsync DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /async/elma/reports/validate HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"report":{"id":"String","data":"String"}}

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

{"id":"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.