Report Filing Service

ValidateReportAsync

ValidateReportAsync

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

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

"use strict";
export class Report {
    /** @param {{id?:string,data?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @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. */
    id;
    /**
     * @type {string}
     * @description The XML-content of the report. */
    data;
}
export class ValidateReportBase {
    /** @param {{report?:Report}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Report}
     * @description The report to validate. */
    report;
}
export class ValidationError {
    /** @param {{id?:string,message?:string,severity?:XmlSeverityType,lineNumber?:number,linePosition?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The unique identifier of the validation faílure.
 This is equivalent to the file name of the validated report. */
    id;
    /**
     * @type {string}
     * @description The message of the validation failure. */
    message;
    /**
     * @type {XmlSeverityType}
     * @description The severity of the validation faílure. */
    severity;
    /**
     * @type {number}
     * @description The line number indicating where the error occurred. */
    lineNumber;
    /**
     * @type {number}
     * @description The line position indicating where the error occurred. */
    linePosition;
}
export class ValidationResponse {
    /** @param {{id?:string,validationErrors?:ValidationError[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The unique identifier of the report that was processed.
The identifier is usually the filename. */
    id;
    /**
     * @type {ValidationError[]}
     * @description The errors encountered during the report validation operation. */
    validationErrors;
    /**
     * @type {ResponseStatus}
     * @description The status of the validation operation. */
    responseStatus;
}
export class ValidateReportAsync extends ValidateReportBase {
    /** @param {{report?:Report,report?:Report}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {Report}
     * @description The report to validate. */
    report;
}

JavaScript ValidateReportAsync DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}