Report Filing Service
| GET | /sync/webhooks/subscriptions/find |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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). |
| EventName | form | string | Yes | The unique identifier of the subscriber. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Subscription | form | WebhookSubscription | No | The encapsulated webhook subscription of the response. The secret of the webhook subscription is encrypted and can only be decrypted by the owner of the private key. |
| History | form | List<SubscriptionDeliveryResult> | No | The history of the subscription event. |
| ResponseStatus | form | ResponseStatus | No | The status of the response. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | |
| Event | form | string | No | |
| IsActive | form | bool | No | |
| CreatedDateUtc | form | DateTime | No | |
| CreatedById | form | string | No | |
| LastModifiedDateUtc | form | DateTime | No | |
| Config | form | SubscriptionConfig | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Url | form | string | No | |
| ContentType | form | string | No | |
| Secret | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttemptedDateUtc | form | DateTime | No | |
| StatusDescription | form | string | No | |
| StatusCode | form | HttpStatusCode | No | |
| SubscriptionId | form | string | No | |
| Id | form | string | No | |
| EventId | form | string | No |
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.
GET /sync/webhooks/subscriptions/find HTTP/1.1 Host: reportfiling.pwc.de Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"subscription":{"id":"String","name":"String","event":"String","isActive":false,"createdDateUtc":"\/Date(-62135596800000-0000)\/","createdById":"String","lastModifiedDateUtc":"\/Date(-62135596800000-0000)\/","config":{"url":"String","contentType":"String","secret":"String"}},"history":[{"attemptedDateUtc":"\/Date(-62135596800000-0000)\/","statusDescription":"String","statusCode":"Continue","subscriptionId":"String","id":"String","eventId":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}