Report Filing Service

BatchValidateReports

ValidateReportsBatchSync

Represents a request to validate reports in a batch operation.

The following routes are available for this service:
POST	/sync/elma/reports/batch/validate


/** @description Represents an ELMA report. */
// @Api(Description="Represents an ELMA report.")
export class Report
{
    /** @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")
    public id: string;

    /** @description The XML-content of the report. */
    // @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
    public data: string;

    public constructor(init?: Partial<Report>) { (Object as any).assign(this, init); }
}

/** @description Specifies a request to validate reports in a batch operation. */
// @Api(Description="Specifies a request to validate reports in a batch operation.")
export class BatchValidateReportsBase implements IPost
{
    /** @description The reports to validate. */
    // @ApiMember(Description="The reports to validate.", IsRequired=true, Name="Reports")
    public reports: Report[];

    public constructor(init?: Partial<BatchValidateReportsBase>) { (Object as any).assign(this, init); }
}

/** @description Represents a request to validate reports in a batch operation. */
// @Api(Description="Represents a request to validate reports in a batch operation.")
export class BatchValidateReports extends BatchValidateReportsBase
{

    public constructor(init?: Partial<BatchValidateReports>) { super(init); (Object as any).assign(this, init); }
}

TypeScript BatchValidateReports 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/batch/validate HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"reports":[{"id":"String","data":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}]