POST | /datenabholungen/protokolle/17/verarbeitungsprotokoll |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Bescheid | body | Abholung17 | No | The tax assessement, whose processing records shall be obtained. |
Zertifikat | body | PortalCertificate | Yes | The authentification certificate. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Bescheid | form | Abholung17 | No | The tax assessement, whose processing records shall be obtained. |
Zertifikat | form | PortalCertificate | Yes | The authentification certificate. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Zertifikat | form | PortalCertificate | Yes | The authentification certificate. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | The unique identifier of the certificate. |
Index | form | int | No | The position of the certificate element in an indexed collection of certificates. |
Pin | form | string | No | The password to protect the certificate from unauthorized access. |
Description | form | string | No | The description of the certificate. |
Tags | form | List<string> | Yes | Tags that can be used to label or identify the certificate. |
Name | form | string | No | Gets or sets the file name of the certificate. |
Content | form | byte[] | No | The raw data content of the file. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Content | form | byte[] | No | The raw data content of the file. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Steuerart | form | Steuerart? | No | The tax type (e.g. ESB) of the data record. |
MetaInformationen | form | MetaInformationen17 | No | The meta information of the identifier. |
Bereitstellungsticket | form | string | No | Die Transfertickets der Datensaetze. Es duerfen max. 100 Bereitstellungstickets in einem Request angegeben werden. |
Anhaenge | form | Anhaenge17 | No | The attachments of the data records. |
Id | form | string | No | The identifier of the data record. |
Idnr | form | string | No | The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'. |
Veranlagungsjahr | form | int? | No | The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'. |
Uebertragungsweg | form | Uebertragungsweg? | No | The transmission path used. |
Encoding | form | string | No | The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING. |
Mandantennummer | form | string | No | The client number; only applicable to the tax type 'ElsterDIVADaten'. |
Steuernummer | form | string | No | The tax number; only applicable to the tax type 'ElsterDIVADaten'. |
Bescheiddatum | form | DateTime? | No | The asessment date; only applicable to the tax type 'ElsterDIVADaten'. |
Datenpaket | form | Datenpaket | No | Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet. |
Download | form | Download | No | Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | The identifier of the data record. |
Idnr | form | string | No | The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'. |
Veranlagungsjahr | form | int? | No | The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'. |
Uebertragungsweg | form | Uebertragungsweg? | No | The transmission path used. |
Encoding | form | string | No | The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING. |
Mandantennummer | form | string | No | The client number; only applicable to the tax type 'ElsterDIVADaten'. |
Steuernummer | form | string | No | The tax number; only applicable to the tax type 'ElsterDIVADaten'. |
Bescheiddatum | form | DateTime? | No | The asessment date; only applicable to the tax type 'ElsterDIVADaten'. |
Datenpaket | form | Datenpaket | No | Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet. |
Download | form | Download | No | Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations. |
direkt | Retrieve the data directly via an ERiClet. |
link | Retrieve the data via a link to the available data on the web server. |
sammellink | Retrieve the bulk data via a link to the available data on the web server. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | string | No | Encoded (compressed and encrypted) requested data record |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Url | form | string | No | The link to the data on the web server. |
Benutzer | form | string | No | The user name for the web server. |
Passwort | form | string | No | Password for the web server. |
ESB | Maps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'. |
GSB | Maps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'. |
USB | Maps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'. |
EPBescheid | Maps to tax type 'ElsterEPBescheidDaten'. |
EPMitteilung | Maps to tax type 'ElsterEPMitteilungDaten'. |
Gewerbesteuerbescheid | Maps to tax type the 'EPStBescheidAbholung'. |
Gewerbesteuermitteilung | Maps to tax type 'EPStMitteilungAbholung'. |
GEWMB | Maps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'. |
DIVAAnzeigeEinerLotterie | Maps to tax type 'ElsterDIVADaten'. |
DIVABescheid | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidESt | Maps to tax type 'ElsterDIVADaten'. |
DIVABuchmachersteuer | Maps to tax type 'ElsterDIVADaten'. |
DIVALotteriesteuerEinmal | Maps to tax type 'ElsterDIVADaten'. |
DIVALotteriesteuerMehr | Maps to tax type 'ElsterDIVADaten'. |
DIVASportwettensteuer | Maps to tax type 'ElsterDIVADaten'. |
DIVATotalisator | Maps to tax type 'ElsterDIVADaten'. |
OZGBescheid | Maps to tax type 'ElsterDIVADaten'. |
VerbindlicheAuskunft | Maps to tax type 'ElsterDIVADaten'. |
VerbindlicheZusage | Maps to tax type 'ElsterDIVADaten'. |
DivaSonstigerVA | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidErbSt | |
DivaBescheidFEIN | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidGewSt | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidKSt | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidUSt | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidSchenkSt | |
DIVATroncabgabe | Maps to tax type 'ElsterDIVADaten'. |
DIVAVirtuelleAutomatenStB | Maps to tax type 'ElsterDIVADaten'. |
DIVAOnlinePokerStB | Maps to tax type 'ElsterDIVADaten'. |
LStHVVMRM | Maps to tax type 'ElsterVollmachtDaten'. |
EinlagenrueckgewaehrVA | Maps to tax type 'DIVADatenBZSt'. |
FTTMeldungVA | Maps to tax type 'DIVADatenBZSt'. |
StatusInvStGVA | Maps to tax type 'DIVADatenBZSt'. |
UStVEUVA | Maps to tax type 'DIVADatenBZSt'. |
VERSVA | Maps to tax type 'DIVADatenBZSt'. |
AltZertVA | Maps to tax type 'DIVADatenBZSt'. |
KapEStEntlastungVA | Maps to tax type 'DIVADatenBZSt'. |
PostUDLVA | Maps to tax type 'DIVADatenBZSt'. |
StAb50aVA | Maps to tax type 'DIVADatenBZSt'. |
StAbEntlastungVA | Maps to tax type 'DIVADatenBZSt'. |
KassenangelegenheitenVA | Maps to tax type 'DIVADatenBZSt'. |
KStOptVA | Maps to tax type 'DIVADatenBZSt'. |
SteueroasenabwehrVA | Maps to tax type 'DIVADatenBZSt'. |
KDBVollmachtRM | Maps to tax type 'ElsterDIVADaten'. |
STBKE | Maps to tax type 'ElsterDIVADaten'. |
VDBKDBRueckmeldungLief | Maps to tax type 'ElsterDIVADaten'. |
AnhangRueckmeldung | Maps to tax type 'MitteilungAbholung'. |
DivaEinwilligungRM | Maps to tax type 'MitteilungAbholung'. |
GlueckspielF | Maps to tax type 'MitteilungAbholung'. |
OZGMitteilung | Maps to tax type 'MitteilungAbholung'. |
VerbindlicheAuskunftInfoF | Maps to tax type 'MitteilungAbholung'. |
ELOProtokoll | ELOProtokoll |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Meta | form | List<Meta17> | Yes | List of metadata. |
MetaInfoMaps | form | MetaInfoMaps17 | No | List of meta infomation maps. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | The type of metadata, e.g. datei [file] |
Coding | form | Coding? | No | The encoding of the metadata (text or base64) |
Value | form | string | No | The content of the metadata |
text | Plain text. |
base64 | Base-64 encoded content. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Protokoll | form | Protokoll06 | No | The processing record of a tax statement. |
Id | form | string | Yes | The unique identifier of the response. |
Index | form | int | No | The position of the response element in an indexed collection. |
ResponseStatus | form | ResponseStatus | No | Metadata that contains structured error information on the service response. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | Yes | The unique identifier of the response. |
Index | form | int | No | The position of the response element in an indexed collection. |
ResponseStatus | form | ResponseStatus | No | Metadata that contains structured error information on the service response. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Version | form | int? | No | Version des Protokolls. |
ZeitStempel | form | DateTime? | No | Der Zeitstempel der Protokoll-Aufbereitung. Es wird der Zeitstempel der serverseitigen Verarbeitung der Protokollanfrage zurück übermittelt. Das String-Format des ZeitStempels lautet: JJJJMMTThhmmss. |
DatenTeil | form | DatenTeil06 | No | Der Datenteil des Protokolls. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TransferTicket | form | string | No | Das Transferticket der Datenlieferung. |
Code | form | int? | No | Der Statuscode zur gesamten Datenlieferung. 0 (Datenlieferung ok - Alle Datensätze konnten verarbeitet werden). 1 (Es sind Fehler aufgetreten - die Nutzdatenblöcke konnten nur teilweise verarbeitet werden). 2 (Datenlieferung konnte gar nicht verarbeitet werden - alle Nutzdatenblöcke fehlerhaft). 3 (Datenlieferung wurde noch nicht verarbeitet - bitte fordern Sie das Protokoll noch mal zu einen späteren Zeitpunkt an; für Onlinebetrieb relevant). |
Text | form | string | No | Der Datenteil des Protokolls.Datenlieferung ok - Alle Datensätze konnten verarbeitet werden. Es sind Fehler aufgetreten - die Nutzdatenblöcke konnten nur teilweise verarbeitet werden. Datenlieferung konnte gar nicht verarbeitet werden - alle Nutzdatenblöcke fehlerhaft. 3Datenlieferung wurde noch nicht verarbeitet - bitte fordern Sie das Protokoll noch mal zu einen späteren Zeitpunkt an; für Onlinebetrieb relevant. |
Nutzdatenbloecke | form | List<Nutzdatenblock06> | Yes | Der Datenteil des Protokolls. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NutzdatenTicket | form | string | No | Über das Nutzdatenticket im Verarbeitungsprotokoll wird der Nutzdatenblock aus der Datenlieferung referenziert. |
Code | form | int? | No | Der Statuscode zum Nutzdatenblock. |
Text | form | string | No | Der Statustext zum Nutzdatenblock. |
VerarbeiteteNds | form | uint? | No | Anzahl der Verarbeiteten Nutzdatensätze. |
NichtverarbeiteteNds | form | uint? | No | Anzahl der nichtverarbeiteten Nutzdatensätze. |
NdSFehler | form | List<NdSFehler06> | Yes | Der Datenteil des Protokolls. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LfdNr | form | string | No | Die laufende Nummer des fehlerhaften Datensatzes in einem Nutzdatenblock. |
KmId | form | string | No | Bei der kmId handelt es sich um die durch den Verfasser vorgegebene KmId des Nutzdatensatzes. |
OrdnungsMerkmal | form | string | No | Die durch den Verfasser vorgegebene bundesweit eindeutige Identifikation des Nutzdatensatzes (z.B. bei LStB, Lohnersatzleistungen). |
FehlerNummer | form | uint? | No | Es wird die vom Elstersystem für diesen Fehler vergebene Fehlernummer i.d.R. eine 9-stellige Nummer zurückgemeldet. |
FehlerText | form | string | No | Es wird der vom Elstersystem für diesen Fehler vergebene Fehlertext zurückgemeldet. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /datenabholungen/protokolle/17/verarbeitungsprotokoll HTTP/1.1
Host: taxfiling.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length
{"bescheid":{"steuerart":"ESB","metaInformationen":{"meta":[{"name":"String","coding":"text","value":"String"}],"metaInfoMaps":[{"typ":"String","meta":[{"name":"String","coding":"text","value":"String"}]}]},"bereitstellungsticket":"String","anhaenge":[{"metadatenAnhang":[{"schluesselAnhang":{"dateibezeichnungID":"String","dateibezeichnungKurz":"String","value":"String"},"wertAnhang":{"dateibezeichnungID":"String","dateibezeichnungKurz":"String","value":"String"}}],"dateibezeichnung":"String","dateityp":"String","dateiinhalt":"String"}],"id":"String","idnr":"String","veranlagungsjahr":0,"uebertragungsweg":"direkt","encoding":"String","mandantennummer":"String","steuernummer":"String","bescheiddatum":"\/Date(-62135596800000-0000)\/","datenpaket":{"value":"String"},"download":{"url":"String","benutzer":"String","passwort":"String"}},"zertifikat":{"id":"00000000000000000000000000000000","index":0,"pin":"String","description":"String","tags":["String"],"name":"String","content":"AA=="}}
HTTP/1.1 200 OK Content-Type: application/x-msgpack Content-Length: length {"protokoll":{"version":0,"zeitStempel":"\/Date(-62135596800000-0000)\/","datenTeil":{"transferTicket":"String","code":0,"text":"String","nutzdatenbloecke":[{"nutzdatenTicket":"String","code":0,"text":"String","verarbeiteteNds":0,"nichtverarbeiteteNds":0,"ndSFehler":[{"lfdNr":"String","kmId":"String","ordnungsMerkmal":"String","fehlerNummer":0,"fehlerText":"String"}]}]}},"id":"String","index":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}