Report Filing Service
| POST | /sync/elma/reports/validate |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Report | form | Report | Yes | The report to validate. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | 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. |
| Data | form | string | Yes | The XML-content of the report. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | The unique identifier of the report that was processed. The identifier is usually the filename. |
| ValidationErrors | form | List<ValidationError> | No | The errors encountered during the report validation operation. |
| ResponseStatus | form | ResponseStatus | No | The status of the validation operation. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | The unique identifier of the validation faílure. This is equivalent to the file name of the validated report. |
| Message | form | string | No | The message of the validation failure. |
| Severity | form | XmlSeverityType | No | The severity of the validation faílure. |
| LineNumber | form | int | No | The line number indicating where the error occurred. |
| LinePosition | form | int | No | The line position indicating where the error occurred. |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/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"}}}