Report Filing Service
| POST | /async/elma/reports/batch/recall |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SearchCriteria | form | SearchCriteria | Yes | The parameters to search or filter on reports. |
| Credential | form | ElmaCredential | Yes | The credential to gain access on the ELMA server. |
| StagingEnabled | form | bool? | No | 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | Full or partial name of the item (report or protocol) to search. |
| Designation | form | Verfahren? | No | TThe ELMA product designation. |
| CC | |
| CS | |
| DC | |
| FC | |
| FS | |
| FA | |
| KM |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval. |
| Certificate | form | PemCertificate | Yes | 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) |
| AuthSteuernummer | form | string | Yes | 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" |
| AccountId | form | string | Yes | The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). |
| Password | form | string | Yes | The password to protect the certificate from unauthorized access. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | The unique identifier (e.g. the file name) of the certificate. |
| Content | form | string | Yes | The PEM-encoded content of the certificate. |
| Description | form | string | No | The description of the certificate. |
| Tags | form | List<string> | No | Tags to label or identify the certificate. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reports | form | List<Report> | No | The recalled reports. |
| ResponseStatus | form | ResponseStatus | No | The status of the recall operation. |
| 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. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/elma/reports/batch/recall HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"searchCriteria":{"name":"String","designation":"CC"},"credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"stagingEnabled":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"reports":[{"id":"String","data":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}