Tax Filing Service

<back to all web services

ProtokollRequest17

SyncDatenabholungVerarbeitungsprotokolle

Represents the service request to retrieve logs about a specified tax assessement.

Requires Authentication
The following routes are available for this service:
POST/datenabholungen/protokolle/17/verarbeitungsprotokoll
ProtokollRequestBase17 Parameters:
NameParameterData TypeRequiredDescription
BescheidformAbholung17NoThe tax assessement, whose processing records shall be obtained.
ProtokollRequestBase Parameters:
NameParameterData TypeRequiredDescription
ZertifikatformPortalCertificateYesThe authentification certificate.
PortalCertificate Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNoThe unique identifier of the certificate.
IndexformintNoThe position of the certificate element in an indexed collection of certificates.
PinformstringNoThe password to protect the certificate from unauthorized access.
DescriptionformstringNoThe description of the certificate.
TagsformList<string>NoTags that can be used to label or identify the certificate.
NameformstringNoGets or sets the file name of the certificate.
FileBase Parameters:
NameParameterData TypeRequiredDescription
Contentformbyte[]NoThe raw data content of the file.
Abholung17 Parameters:
NameParameterData TypeRequiredDescription
SteuerartformSteuerart?NoThe tax type (e.g. ESB) of the data record.
MetaInformationenformMetaInformationen17NoThe meta information of the identifier.
BereitstellungsticketformstringNoDie Transfertickets der Datensaetze. Es duerfen max. 100 Bereitstellungstickets in einem Request angegeben werden.
AnhaengeformAnhaenge17NoThe attachments of the data records.
Abholung Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe identifier of the data record.
IdnrformstringNoThe ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.
Veranlagungsjahrformint?NoThe assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.
UebertragungswegformUebertragungsweg?NoThe transmission path used.
EncodingformstringNoThe character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.
MandantennummerformstringNoThe client number; only applicable to the tax type 'ElsterDIVADaten'.
SteuernummerformstringNoThe tax number; only applicable to the tax type 'ElsterDIVADaten'.
BescheiddatumformDateTime?NoThe asessment date; only applicable to the tax type 'ElsterDIVADaten'.
DatenpaketformDatenpaketNoDas Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.
DownloadformDownloadNoDownload requested data records. Ensure the second payload data block is empty for bulk retrieval operations.
Uebertragungsweg Enum:
direktRetrieve the data directly via an ERiClet.
linkRetrieve the data via a link to the available data on the web server.
sammellinkRetrieve the bulk data via a link to the available data on the web server.
Datenpaket Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNoEncoded (compressed and encrypted) requested data record
Download Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNoThe link to the data on the web server.
BenutzerformstringNoThe user name for the web server.
PasswortformstringNoPassword for the web server.
Steuerart Enum:
ESBMaps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'.
GEWMBMaps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'.
GSBMaps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'.
USBMaps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'.
EPBescheidMaps to tax type 'ElsterEPBescheidDaten'.
EPMitteilungMaps to tax type 'ElsterEPMitteilungDaten'.
GewerbesteuerbescheidMaps to tax type the 'EPStBescheidAbholung'.
GewerbesteuermitteilungMaps to tax type 'EPStMitteilungAbholung'.
AntwortCoronaSoforthilfeThe role of a sender
BLZMaps to tax type 'ElsterFTDaten'.
DEICHMaps to tax type 'ElsterFTDaten'.
EURSMaps to tax type 'ElsterFTDaten'.
ESSGSMaps to tax type 'ElsterFTDaten'.
ESTGSMaps to tax type 'ElsterFTDaten'.
FEIGSMaps to tax type 'ElsterFTDaten'.
GDAMaps to tax type 'ElsterFTDaten'.
GELFMaps to tax type 'ElsterFTDaten'.
GEWBAMaps to tax type 'ElsterFTDaten'.
GEWGIMaps to tax type 'ElsterFTDaten'.
GEWGSMaps to tax type 'ElsterFTDaten'.
GEWTPMaps to tax type 'ElsterFTDaten'.
GEWXXMaps to tax type 'ElsterFTDaten'.
GMBMaps to tax type 'ElsterFTDaten'.
GMBAEMaps to tax type 'ElsterFTDaten'.
GMBAXMaps to tax type 'ElsterFTDaten'.
GMBVMaps to tax type 'ElsterFTDaten'.
GMBXMaps to tax type 'ElsterFTDaten'.
GRSTEMaps to tax type 'ElsterFTDaten'.
GWPH1Maps to tax type 'ElsterFTDaten'.
HHREMaps to tax type 'ElsterFTDaten'.
HWKDMaps to tax type 'ElsterFTDaten'.
KATEWMaps to tax type 'ElsterFTDaten'.
KBLMaps to tax type 'ElsterFTDaten'.
KISTMMaps to tax type 'ElsterFTDaten'.
KSTGSMaps to tax type 'ElsterFTDaten'.
KVMaps to tax type 'ElsterFTDaten'.
RDALMaps to tax type 'ElsterFTDaten'.
SVMaps to tax type 'ElsterFTDaten'.
TEST7Maps to tax type 'ElsterFTDaten'.
USTGSMaps to tax type 'ElsterFTDaten'.
UVVGSMaps to tax type 'ElsterFTDaten'.
VWDVGMaps to tax type 'ElsterFTDaten'.
WPMBRMaps to tax type 'ElsterFTDaten'.
BAAMaps to tax type 'ElsterFTDaten'.
GMBVXMaps to tax type 'ElsterFTDaten'.
BMBAXMaps to tax type 'ElsterFTDaten'.
DIVAAnzeigeEinerLotterieMaps to tax type 'ElsterDIVADaten'.
DIVABescheidMaps to tax type 'ElsterDIVADaten'.
DivaBescheidEStMaps to tax type 'ElsterDIVADaten'.
DIVABuchmachersteuerMaps to tax type 'ElsterDIVADaten'.
DIVALotteriesteuerEinmalMaps to tax type 'ElsterDIVADaten'.
DIVALotteriesteuerMehrMaps to tax type 'ElsterDIVADaten'.
DIVASportwettensteuerMaps to tax type 'ElsterDIVADaten'.
DIVATotalisatorMaps to tax type 'ElsterDIVADaten'.
OZGBescheidMaps to tax type 'ElsterDIVADaten'.
VerbindlicheZusageMaps to tax type 'ElsterDIVADaten'.
DivaSonstigerVAMaps to tax type 'ElsterDIVADaten'.
DivaBescheidGewStMaps to tax type 'ElsterDIVADaten'.
DivaBescheidUStMaps to tax type 'ElsterDIVADaten'.
DivaBescheidKStMaps to tax type 'ElsterDIVADaten'.
DivaBescheidFEINMaps to tax type 'ElsterDIVADaten'.
DIVATroncabgabeMaps to tax type 'ElsterDIVADaten'.
DIVAVirtuelleAutomatenStBMaps to tax type 'ElsterDIVADaten'.
DIVAOnlinePokerStBMaps to tax type 'ElsterDIVADaten'.
VerbindlicheAuskunftMaps to tax type 'ElsterDIVADaten'.
LStHVVMRMMaps to tax type 'ElsterVollmachtDaten'.
EinlagenrueckgewaehrVAMaps to tax type 'DIVADatenBZSt'.
FTTMeldungVAMaps to tax type 'DIVADatenBZSt'.
StatusInvStGVAMaps to tax type 'DIVADatenBZSt'.
UStVEUVAMaps to tax type 'DIVADatenBZSt'.
VERSVAMaps to tax type 'DIVADatenBZSt'.
AltZertVAMaps to tax type 'DIVADatenBZSt'.
KapEStEntlastungVAMaps to tax type 'DIVADatenBZSt'.
PostUDLVAMaps to tax type 'DIVADatenBZSt'.
StAb50aVAMaps to tax type 'DIVADatenBZSt'.
StAbEntlastungVAMaps to tax type 'DIVADatenBZSt'.
KassenangelegenheitenVAMaps to tax type 'DIVADatenBZSt'.
KStOptVAMaps to tax type 'DIVADatenBZSt'.
SteueroasenabwehrVAMaps to tax type 'DIVADatenBZSt'.
KDBVollmachtRMMaps to tax type 'ElsterDIVADaten'.
STBKEMaps to tax type 'ElsterDIVADaten'.
VDBKDBRueckmeldungLiefMaps to tax type 'ElsterDIVADaten'.
AnhangRueckmeldungMaps to tax type 'MitteilungAbholung'.
DivaEinwilligungRMMaps to tax type 'MitteilungAbholung'.
GlueckspielFMaps to tax type 'MitteilungAbholung'.
OZGMitteilungMaps to tax type 'MitteilungAbholung'.
VerbindlicheAuskunftInfoFMaps to tax type 'MitteilungAbholung'.
ELOProtokollELOProtokoll
MetaInformationen17 Parameters:
NameParameterData TypeRequiredDescription
MetaformList<Meta17>NoList of metadata.
MetaInfoMapsformMetaInfoMaps17NoList of meta infomation maps.
Meta17 Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe type of metadata, e.g. datei [file]
CodingformCoding?NoThe encoding of the metadata (text or base64)
ValueformstringNoThe content of the metadata
Coding Enum:
textPlain text.
base64Base-64 encoded content.
ProtokollResponse Parameters:
NameParameterData TypeRequiredDescription
ProtokollformProtokoll06NoThe processing record of a tax statement.
ServiceReponseBase Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe unique identifier of the response.
IndexformintNoThe position of the response element in an indexed collection.
ResponseStatusformResponseStatusNoMetadata that contains structured error information on the service response.
Protokoll06 Parameters:
NameParameterData TypeRequiredDescription
Versionformint?NoVersion des Protokolls.
ZeitStempelformDateTime?NoDer Zeitstempel der Protokoll-Aufbereitung. Es wird der Zeitstempel der serverseitigen Verarbeitung der Protokollanfrage zurück übermittelt. Das String-Format des ZeitStempels lautet: JJJJMMTThhmmss.
DatenTeilformDatenTeil06NoDer Datenteil des Protokolls.
DatenTeil06 Parameters:
NameParameterData TypeRequiredDescription
TransferTicketformstringNoDas Transferticket der Datenlieferung.
Codeformint?NoDer 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).
TextformstringNoDer 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.
NutzdatenbloeckeformList<Nutzdatenblock06>NoDer Datenteil des Protokolls.
Nutzdatenblock06 Parameters:
NameParameterData TypeRequiredDescription
NutzdatenTicketformstringNoÜber das Nutzdatenticket im Verarbeitungsprotokoll wird der Nutzdatenblock aus der Datenlieferung referenziert.
Codeformint?NoDer Statuscode zum Nutzdatenblock.
TextformstringNoDer Statustext zum Nutzdatenblock.
VerarbeiteteNdsformuint?NoAnzahl der Verarbeiteten Nutzdatensätze.
NichtverarbeiteteNdsformuint?NoAnzahl der nichtverarbeiteten Nutzdatensätze.
NdSFehlerformList<NdSFehler06>NoDer Datenteil des Protokolls.
NdSFehler06 Parameters:
NameParameterData TypeRequiredDescription
LfdNrformstringNoDie laufende Nummer des fehlerhaften Datensatzes in einem Nutzdatenblock.
KmIdformstringNoBei der kmId handelt es sich um die durch den Verfasser vorgegebene KmId des Nutzdatensatzes.
OrdnungsMerkmalformstringNoDie durch den Verfasser vorgegebene bundesweit eindeutige Identifikation des Nutzdatensatzes (z.B. bei LStB, Lohnersatzleistungen).
FehlerNummerformuint?NoEs wird die vom Elstersystem für diesen Fehler vergebene Fehlernummer i.d.R. eine 9-stellige Nummer zurückgemeldet.
FehlerTextformstringNoEs 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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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":"String","wertAnhang":"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/json
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"}}}