DataBox-Download-Webservice

Transkript

1 Bundesministerium für Finanzen Seite 1 von 10 DataBox-Download-Webservice 1 Einleitung Die Einrichtung eines Webservices richtet sich an Spezialisten. WSDL ist ein Standard für Webservices im Internet. Wir ersuchen daher um Verständnis, dass das BMF und die FinanzOnline-Hotline für die Lösung von technischen Problemen im Zusammenhang mit der Einrichtung des Webservices nicht zur Verfügung stehen können. Der Aufruf des Webservices kann aus Programmen auf nahezu jeder Plattform (z.b. Java) erfolgen. 2 Beschreibung Voraussetzung für das Webservice o o o o o Der Übermittler muss FinanzOnline Teilnehmer sein. Der Teilnehmer muss in der Benutzerverwaltung einen Benutzer für 'Webservices' anlegen. Das Webservice muss mit diesem Benutzer verwendet werden. Der Webservice-Benutzer hat alle Rechte des Teilnehmers. Der Webservice-Benutzer kann im Online-Verfahren nicht verwendet werden. WSDL Die technische Beschreibung der Webservices für FinanzOnline als WSDL ist unter erreichbar. Webservice Url Für den Verbindungsaufbau wird das Zertifikat von FinanzOnline benötigt. Das Zertifikat kann im Internet-Explorer mit dem Zertifikatsexport-Assistenten heruntergeladen werden (FinanzOnline-Startseite aufrufen, Datei/Eigenschaften/Zertifikate/Details).

2 Bundesministerium für Finanzen Seite 2 von 10 3 Ablauf 3.1 Aufruf Session-Webservice (Methode Login ) Das WSDL-Servicedokument für das Session-Webservice ist unter zu finden. Client tid, benid, pin > < id / error Webservice Verbindung aufbauen Verschlüsselte Verbindung aufbauen mittels FinanzOnline-Zertifikat Parameter belegen Die Parameter zum Starten des Webservices sind wie folgt zu belegen: string parameter: tid benid pin = 'Teilnehmer-Identifikation' = 'Benutzer-Identifikation des Webservice-Benutzers', der in der Benutzerverwaltung angelegt wurde = 'Pin des Webservice-Benutzers' Methode 'Login' aufrufen Antwort auswerten Es wird ein string mit der SessionID zurückgegeben 3.2 Aufruf DataBox-Download-Webservice Das WSDL-Servicedokument für das DataBox-Download-Webservice ist unter zu finden. Mit der Methode 'getdataboxbydate' können gelesene und ungelesene Databox-Inhalte für einen bestimmten Zeitraum abgerufen werden, wobei die Databox-Inhalte höchstens 31 Tage zurück abgerufen werden können und die Zeitspanne pro Aufruf höchstens 7 Tage sein kann. Client tid, benid, id, art, (datvon, datbis) > < array / string / error tid, benid, id, sid, appl, applkey, fileart > < base64-codierter string / error Webservice

3 Bundesministerium für Finanzen Seite 3 von 10 Parameter belegen Die Parameter, um das Webservice zu starten, sind wie folgt zu belegen: string parameter: tid = 'Teilnehmercode' benid = 'Benutzer-Identifikation des Webservice-Benutzers' id = mit Methode 'login' ermittelte SessionID art = Art des DataBox-Inhalts; wird keine Art angegeben, werden alle ungelesenen behördlich zugestellten DataBox-Inhalte zurückgeliefert keine Einschränkung AE Amtshilfeersuchen Einheitswerte (nur für Notare) AF Amtshilfeersuchen Erledigung durch Finanzamt (nur für Notare) AK Amtshilfeersuchen Kontoabfragen (nur für Notare) AZ Amtshilfeersuchen Abschluss (nur für Notare) B Bescheide, Ergänzungsersuchen und Bescheinigungen DL Dienstgeberbeitragslisten (nur für Gemeinden) E Prüfungsergebnisse (nur für Gemeinden) EU EU-Erledigungen FB Firmenbuchzustellungen (nur für Wirtschaftstreuhänder, Notare und Rechtsanwälte) GM Grundsteuermessbeträge I Informationen KG Kommunalsteuergrundlagen (nur für Gemeinden) M Mitteilungen P Protokolle QL Quotenlisten (nur für Parteienvertreter) SS Selbstberechnungserklärungen (nur für Wirtschaftstreuhänder, Notare und Rechtsanwälte) datvon Das Datum darf max. 31 Tage in der Vergangenheit liegen (nur bei Methode 'getdataboxbydate') datbis Das Datum darf max. 7 Tage nach 'datvon' liegen (nur bei Methode 'getdataboxbydate') Methode 'getdatabox' bzw. 'getdataboxext' bzw. 'getdataboxbydate' aufrufen 'getdatabox' und 'getdataboxext' liefern nur ungelesene Databox-Inhalte. Der Unterschied der beiden Methoden liegt im Umfang der zurückgegebenen Daten. Bei der Methode 'getdataboxext' wird zusätzlich das Feld 'FILEBEZ' zurückgegeben, das bei Protokollen auf Grund von Datenstromübermittlungen den Namen der übermittelten Datei enthält. Somit kann über das Feld 'FILEBEZ' die Verbindung zwischen übermittelter Datei und Protokoll hergestellt werden. 'getdataboxbydate' liefert gelesene und ungelesene Databox-Inhalte für den Zeitraum zwischen 'datvon' und 'datbis'. Bei dieser Methode wird zusätzlich das Feld 'STATUS' zurückgegeben, das angibt, ob der Inhalt ungelesen (' ') oder gelesen ('1') ist. Antwort auswerten Es wird ein Array von Objekten (siehe wsdl-dokument) zurückgegeben

4 Bundesministerium für Finanzen Seite 4 von 10 Parameter belegen Die Parameter, um das Webservice zu starten, sind wie folgt zu belegen: string parameter: tid = 'Teilnehmercode' benid = 'WS -Benutzer' der in der Benutzerverwaltung angelegt wurde id = von Methode 'login' zurückgegebene SessionID sid appl applkey fileart Methode 'getdataboxentry' mit jedem Objekt aus dem von der Methode 'getdatabox' zurückgegebenen Array aufrufen Antwort auswerten von Methode 'getdatabox' bzw. 'getdataboxext' zurückgegebene Daten Es wird ein Base64-codierter String zurückgegeben 3.3 Aufruf Session-Webservice (Methode Logout ) Das WSDL-Servicedokument für das Session-Webservice ist unter zu finden. Client id, tid, benid ok / error Webservice Parameter belegen Die Parameter zum Starten des Webservices sind wie folgt zu belegen: string parameter: id = mit Methode login ermittelte SessionID tid = Teilnehmer-Identifikation benid = Benutzer-Identifikation des Webservice-Benutzers Methode Logout aufrufen

5 Bundesministerium für Finanzen Seite 5 von 10 Alternativ zu den Methoden getdatabox bzw. getdataboxext, bei denen ein Array zurückgegeben wird, kann auch die Methode getdataboxxml aufgerufen werden, welche die DataBox-Einträge als xml in einem String zurückgibt. Parameter belegen Die Parameter, um das Webservice zu starten, sind wie folgt zu belegen: string parameter: tid = Teilnehmercode benid = WS Benutzer der in der Benutzerverwaltung angelegt wurde id = mit Methode login ermittelte SessionID art = Art des DataBox-Inhalts; wird keine Art angegeben, werden alle ungelesenen behördlich zugestellten DataBox-Inhalte zurückgeliefert keine Einschränkung AE Amtshilfeersuchen Einheitswerte (nur für Notare) AF Amtshilfeersuchen Erledigung durch Finanzamt (nur für Notare) AK Amtshilfeersuchen Kontoabfragen (nur für Notare) AZ Amtshilfeersuchen Abschluss (nur für Notare) B Bescheide, Ergänzungsersuchen und Bescheinigungen DL Dienstgeberbeitragslisten (nur für Gemeinden) E Prüfungsergebnisse (nur für Gemeinden) EU EU-Erledigungen FB Firmenbuchzustellungen (nur für Wirtschaftstreuhänder, Notare und Rechtsanwälte) GM Grundsteuermessbeträge I Informationen KG Kommunalsteuergrundlagen (nur für Gemeinden) M Mitteilungen P Protokolle QL SS Methode getdataboxxml aufrufen Antwort auswerten Quotenlisten (nur für Parteienvertreter) Selbstberechnungserklärungen (nur für Wirtschaftstreuhänder, Notare und Rechtsanwälte) Es wird ein string der DataBox-Einträge im xml-format zurückgegeben. Folgende tags werden übertragen: <DBX> <ANBRINGEN> <APPL> <APPLKEY> <DATBESCH> <ERLTYP> <FILEART> <FILEBEZ> <NAME> <SID> <STNR> <TSZUST> <ZRVON> <ZRBIS> </DBX>

6 Bundesministerium für Finanzen Seite 6 von 10 4 Fehlercodes Bei einem Fehler im Webservice wird eine SOAP-Exception ausgelöst. Der oder die aufgetretenen Fehlercodes befinden sich im Detail-String (2stellig, durch Strichpunkt getrennt). Bedeutung der Fehlercodes: 01 - Die Art darf nur 2stellig und alphanumerisch sein 02 - Die Zeitraumfelder wurden nicht korrekt übergeben 03 - datvon und datbis müssen angegeben werden 04 - datvon darf nicht größer als datbis sein 05 - datvon darf nicht größer als das aktuelle Datum sein 06 - datbis darf nicht größer als das aktuelle Datum sein 07 - datvon darf nicht kleiner als das aktuelle Datum 31 Tage sein 08 - datbis darf nicht größer als datvon + 7 Tage sein

7 Bundesministerium für Finanzen Seite 7 von 10 5 Liste der Anbringen Art Anbringen Text AE AHEEW Einheitswertinformation-AHE AF AHEFA AHE-Nachlass AK AHEKO Kontoinformation-AHE AZ AHEZU AHE-Nachlass Abschluss B BEGLEIT Begleitbrief B BPBERI Lohnsteuerprüfungsbericht B BPBESCH Haftungs- und Abgabenbescheid BPRMVERZ BPVKZBER DELBESCH Rechtsmittelverzicht zum Verkürzungszuschlag Verkürzungszuschlagsbescheid Delegierungsbescheid B E1 Einkommensteuerbescheid B E3 Einkommensteuerbescheid B E5 Einkommensteuerbescheid B E6 Feststellungsbescheid der Einkünfte von Personengesellschaften B E7 Einkommensteuerbescheid B EVZ Einkommensteuervorauszahlungsbescheid B FBB Freibetragsbescheid M FBBEST Bestätigung über den Bezug der Familienbeihilfe B FGM Feststellungsbescheid Gruppenmitglied B FGT Feststellungsbescheid Gruppenträger FSU Bescheid über die Festsetzung von Umsatzsteuer B G1 Gruppenfeststellungsbescheid B GK Körperschaftsteuerbescheid Gruppe B K1 Körperschaftsteuerbescheid B K2 Körperschaftsteuerbescheid B K3 Körperschaftsteuerbescheid B KVZ Körperschaftsteuervorauszahlungsbescheid B L1 Einkommensteuerbescheid L1BE Einkommensteuerbescheid (beschränkte Steuerpflicht) B MKZ Mehrkindzuschlagsbescheid MOSSABW MOSSAUS RAAUS STAB EU-Umsatzsteuer Abweisungsbescheid EU-Umsatzsteuer Ausschlussbescheid Rückstandsbescheinigung gemäß 229a BAO Stabilitätsabgabebescheid STAS Bescheid über die Festsetzung des Sonderbeitrags zur Stabilitätsabgabe B U1 Umsatzsteuerbescheid U15A U5 U70 UIDB UIDBA UIDE UIDNG VERF34 Neuerliche Bekanntgabe der UID-Nummer Bescheid über die Erstattung von Vorsteuern Nachweis über die Erfassung als Unternehmer UID-Bescheid UID-Bescheid UID-Bescheid UID-Bescheid Unbedenklichkeitsbescheinigung Abgabenforderungen

8 Bundesministerium für Finanzen Seite 8 von 10 VERF36 Abweisungsbescheid B VE1 Verspätungszuschlagsbescheid B VE7 Verspätungszuschlagsbescheid VFSU Verspätungszuschlagsbescheid B VK Verspätungszuschlagsbescheid B VK2 Verspätungszuschlagsbescheid B VK3 Verspätungszuschlagsbescheid VOAF Ergänzungsersuchen VOAF_AL Ergänzungsersuchen Abgabe von alkoholischen Getränken VOAF_E Ergänzungsersuchen Einkommensteuer VOAF_E7 Ergänzungsersuchen Einkommensteuer (beschränkte Steuerpflicht) VOAF_F Ergänzungsersuchen Feststellung der Einkünfte von Personengesellschaften VOAF_GW Ergänzungsersuchen Gewerbesteuer VOAF_K Ergänzungsersuchen Körperschaftsteuer VOAF_K3 Ergänzungsersuchen Körperschaftsteuer (beschränkte Steuerpflicht) VOAF_KR1 Ergänzungsersuchen Kraftfahrzeugsteuer VOAF_MKZ Ergänzungsersuchen Mehrkindzuschlag VOAF_U Ergänzungsersuchen Umsatzsteuer B VU Verspätungszuschlagsbescheid VWA1 Verspätungszuschlagsbescheid WA1 Werbeabgabebescheid B ZE1 Anspruchszinsenbescheid B ZE3 Anspruchszinsenbescheid B ZE5 Anspruchszinsenbescheid B ZE7 Anspruchszinsenbescheid B ZK Anspruchszinsenbescheid B ZK2 Anspruchszinsenbescheid B ZK3 Anspruchszinsenbescheid B ZL1 Anspruchszinsenbescheid B 90a Bescheid gem. 90a BAO B 90aWI Bescheid gem. 90a BAO DL DBLI Dienstgeberbeitragsliste E KOM Kommunalsteuerprüfung EU VATDECI Entscheidung VATEMPF Empfangsbestätigung FB ERV-BE Firmenbuchbeschluss FB ERV-GB Firmenbuchgebühren GM GEMDAT Grundsteuermessbeträge gemäß 194 Abs. 4 BAO GEMXGES Grundsteuermessbeträge Gesamtbestand (XML) I Informationen KG KOMMST1 Kommunalsteuergrundlagen KG KOMMST2 Kommunalsteuergrundlagen (Schließung) M AENBIL Änderung des Bilanzstichtages M AENVZ Änderung der Vorauszahlung ALF1 Information zur Gewährung der Familienbeihilfe ANF_STNR Anforderung FASTNR

9 Bundesministerium für Finanzen Seite 9 von 10 ANMPT Anmeldung zu FinanzOnline M AUFH Aufhebung gem. 299 (1) BAO M AUSEH Aussetzung der Einhebung gem. 212a BAO M BA Bekanntgabe Betriebsaufgabe M BERU Beschwerde/Berufung gem. 243 BAO BINFO Bescheidinformation BPAKD Prüfungsankündigung BUMI Kontoinformation/Buchungsmitteilung M BVE2 Zustimmung zur 2. BVE gem. 276 (5) BAO EIMIT Benachrichtigung über Vierteljahresfälligkeiten M ENDG Endgültigkeitserklärung gem. 200 (2) BAO M EWBESCH Bescheidkopie des Einheitswertes M EWFORT Wert-, Art- oder Zurechnungsfortschreibung M FRBERU Fristverlängerung Berufungsfrist M FRMBA Fristverlängerung Mängelbehebungsauftrag M FRVOR Fristverlängerung Vorhaltsbeantwortung M NSA Nachsichtsansuchen M RAK Ersuchen (Rechts)auskünfte RAMIT Mitteilung Rückstandsbescheinigung SBM_A Buchungsrelevante Daten (Anmeldung) SBM_I Buchungsrelevante Daten (Immobilienertragsteuer) M SONST Sonstige Anbringen und Anfragen M UBEIL Eilnachrichtverzichtserklärung M UBFIRM Unbedenklichkeitsbescheinigung Firmenbuch M UBSA Unbedenklichkeitsbescheinigung Staatsbürgerschaft/Aufenthalt VERF213A Mitteilung über die Vergabe einer Steuernummer VERF213B Abtretungsmitteilung M VORL Vorlageantrag gem. 276 (2) BAO 255 Zurücknahme der Berufung gem. 255 (3) BAO M 293 Berichtigung gem. 293 BAO M 293A Berichtigung gem. 293a BAO M 293B Berichtigung gem. 293b BAO M 295A Änderung gem. 295a BAO M 303 Wiederaufnahme gem. 303 (1) BAO M 308 Wiedereinsetzung gem. 308 (1) BAO P Protokoll UID Protokoll UID-Bestätigung VAT Protokoll Vorsteuererstattung VATAB Protokoll Vorsteuererstattung Abschluss QL QUOAN Androhung des Ausschlusses von der Quotenregelung QL QUOAUS Einzelfallbezogene Quotenausschlussliste QL QUOAUSFA Ausschluss von der Quotenregelung QL QUOLI Verzeichnis der vertretenen Quotenfälle SS GEM Gemischte Schenkung SS GES Gesellschaftsteuer SS GRE Grunderwerbsteuer SS SCHE Schenkungssteuer SS STIF Stiftungseingangssteuer

10 Bundesministerium für Finanzen Seite 10 von 10