Report Filing Service

<back to all web services

BatchRetrieveElmaCredentials

RetrieveCredentialsBatchSync

Represents a service to retrieve ELMA credentials by using search criteria.

Requires Authentication
The following routes are available for this service:
POST/sync/elma/credentials/batch
BatchRetrieveElmaCredentialsBase Parameters:
NameParameterData TypeRequiredDescription
SearchCriteriaformList<CredentialSearchCriteria>YesThe parameters used to search for credentials.
CredentialSearchCriteria Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe unique identifier of the credential.
AuthSteuernummerformstringNoThe 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"
AccountIdformstringNoThe account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).

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

{"searchCriteria":[{"id":"String","authSteuernummer":"String","accountId":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

[{"id":"String","credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]