Report Filing Service

SubmitReport

SubmitReportSync

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

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

"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 PemCertificate {
    /** @param {{id?:string,content?:string,description?:string,tags?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The unique identifier (e.g. the file name) of the certificate. */
    id;
    /**
     * @type {string}
     * @description The PEM-encoded content of the certificate. */
    content;
    /**
     * @type {string}
     * @description The description of the certificate. */
    description;
    /**
     * @type {string[]}
     * @description Tags to label or identify the certificate. */
    tags;
}
export class ElmaCredential {
    /** @param {{id?:string,certificate?:PemCertificate,authSteuernummer?:string,accountId?:string,password?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval. */
    id;
    /**
     * @type {PemCertificate}
     * @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) */
    certificate;
    /**
     * @type {string}
     * @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" */
    authSteuernummer;
    /**
     * @type {string}
     * @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
    accountId;
    /**
     * @type {string}
     * @description The password to protect the certificate from unauthorized access. */
    password;
}
export class SubmitReportBase {
    /** @param {{report?:Report,credential?:ElmaCredential,validationEnabled?:boolean,stagingEnabled?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Report}
     * @description The report to submit. */
    report;
    /**
     * @type {ElmaCredential}
     * @description The credential to gain access on the ELMA server. */
    credential;
    /**
     * @type {boolean}
     * @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. */
    validationEnabled;
    /**
     * @type {?boolean}
     * @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. */
    stagingEnabled;
}
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 SubmissionResponse {
    /** @param {{id?:string,xml?:string,validationErrors?:ValidationError[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The unique identifier of the report that was processed. */
    id;
    /**
     * @type {string}
     * @description The submitted XML-based report content. */
    xml;
    /**
     * @type {ValidationError[]}
     * @description The errors encountered during the validation phase of the report submission operation. */
    validationErrors;
    /**
     * @type {ResponseStatus}
     * @description The status of the report submission operation. */
    responseStatus;
}
export class SubmitReport extends SubmitReportBase {
    /** @param {{report?:Report,credential?:ElmaCredential,validationEnabled?:boolean,stagingEnabled?:boolean,report?:Report,credential?:ElmaCredential,validationEnabled?:boolean,stagingEnabled?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {Report}
     * @description The report to submit. */
    report;
    /**
     * @type {ElmaCredential}
     * @description The credential to gain access on the ELMA server. */
    credential;
    /**
     * @type {boolean}
     * @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. */
    validationEnabled;
    /**
     * @type {?boolean}
     * @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. */
    stagingEnabled;
}

JavaScript SubmitReport 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 /sync/elma/reports/submit HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}