Schnittstellenbeschreibung - Personenbezogene Abfrage Webservice
←
→
Transkription von Seiteninhalten
Wenn Ihr Browser die Seite nicht korrekt rendert, bitte, lesen Sie den Inhalt der Seite unten
s
Schnittstellenbeschreibung
Personenbezogene Abfrage Webservice
Projekt: Transparenzdatenbank
Thema: Personenbezogene Abfrage in der TDB
Version: 2.00
Verfasser: Helen Matuschewski, BSc
Beschreibung: Beschreibung der Schnittstelle für die Abfrage von
personenbezogenen Leistungsdaten
Wien, 2020Änderungshistorie
Version Datum Änderung Autor/in
0.1 16.03.2015 Ersterstellung Martin Spitzenberger
0.9 24.09.2015 Aktualisierung PDF Auszug Martin Spitzenberger
1.0 10.02.2016 GZAntragsId in PDF, PV Rolle Martin Spitzenberger
1.1 12.08.2016 PVPChainedToken Martin Spitzenberger
Gemeinsame Abfrage mehrerer
1.2 03.10.2018 Helen Matuschewski
Personen
2.00 13.05.2020 Aufnahme von Förderungsfällen, Helen Matuschewski
Auszahlungen und Excel
BMF II/12-TD 2 von 38Inhalt
Abbildungsverzeichnis .......................................................................................... 4
Begriffsdefinitionen ........................................................................................... 5
SOAP Header .................................................................................................... 5
2.1 PVP-Token im Portalverbund ...................................................................................... 5
2.2 SOAP Header für das Unternehmensserviceportal ...................................................... 6
Request zur personenbezogenen Abfrage ........................................................... 7
3.1 Behördenabfrage Request ........................................................................................... 8
3.2 BehoerdenabfrageRequestType .................................................................................. 9
3.3 Request ab Version 2.00 ............................................................................................ 10
3.4 Leistungsempfänger .................................................................................................. 11
3.4.1 Nicht natürliche Person ...................................................................................... 12
3.4.2 Natürliche Person .............................................................................................. 12
3.4.3 Identifizierung .................................................................................................... 13
3.5 Zustimmungserklärung ............................................................................................. 14
3.6 Fehlercodes ............................................................................................................... 15
Response der personenbezogenen Abfrage ....................................................... 17
4.1 Response ab Version 2.00 .......................................................................................... 18
4.2 Verhalten der Schnittstelle bei fehlender Zustimmung zur Einsicht .......................... 20
4.3 Leistungsdatenauszug ............................................................................................... 21
4.3.1 Auszugdetails..................................................................................................... 22
4.3.2 Leistungsempfänger .......................................................................................... 23
4.3.3 Auszugabschnitt ................................................................................................ 26
4.3.4 Bereich ............................................................................................................... 27
4.3.5 Leistungen ......................................................................................................... 28
4.3.6 Hinweise ............................................................................................................ 31
4.4 Leistungsdatenauszug als PDF oder Excel ................................................................. 32
Anhang ........................................................................................................... 33
BMF II/12-TD 3 von 38Abbildungsverzeichnis Abbildung 1: Behördenabfrage Request 8 Abbildung 2: BehoerdenabfrageRequestType 9 Abbildung 3: RequestAbV2_00Type 10 Abbildung 4: LeistungsempfaengerType 11 Abbildung 5: NichtNatuerlichePersonType 12 Abbildung 6: NatuerlichePersonType 12 Abbildung 7: IdentificationType 13 Abbildung 8: LeistungsangebotIDsZustimmungType 14 Abbildung 9: Webservice Response 17 Abbildung 10: BehoerdenabfrageResponse 18 Abbildung 11: ResponseV2_00 19 Abbildung 12: TDBAuszug 21 Abbildung 13: Auszugdetails 22 Abbildung 14: Leistungsempfänger 23 Abbildung 15: Natürliche Person 24 Abbildung 16: Nicht natürliche Person 25 Abbildung 17: Auszug Abschnitt 26 Abbildung 18: Bereich 27 Abbildung 19: Leistung 28 Abbildung 20: Hinweis 31 Abbildung 21: Beispiel Betrag bei Hinweis 31 Abbildung 22: Dokumente 32 BMF II/12-TD 4 von 38
Begriffsdefinitionen
Die Begriffe des personenbezogene Abfrage WebService unterscheiden sich zu den verwendeten Begriffen
in der Webapplikation. In der folgenden Tabelle finden Sie gleichbedeutende Begriffe.
Webapplikation WebService
Förderung Leistungsangebot
Leistungen Förderungsfälle, Auszahlungen und Leistungsmitteilungen
LeistungsangebotID ID der Förderung
Leistungsempfänger Förderungsempfänger
Personenbezogene Abfrage Behördenabfrage
SOAP Header
Die Transparenzdatenbank bietet zwei Möglichkeiten der personenbezogenen Abfrage mittels Webservice
an. Der Zugang und die Authentifizierung kann mittels Portalverbundprotokoll erfolgen oder mittels
Unternehmensserviceportal (USP) erfolgen. Für den Zugang über das USP muss sich die Abwicklungsstelle
mit der Abteilung Transparenzdatenbank (transparenzdatenbank@bmf.gv.at) für das benötigte
Whitelisting in Verbindung setzen. Weitere Informationen zum Anlegen eines WebService Accounts im USP
sind dem Leitfaden „TDB Berechtigungen am USP“ zu entnehmen.
2.1 PVP-Token im Portalverbund
Die Schnittstelle der personenbezogenen Abfrage entspricht den E-Government Standards
Portalverbundprotokoll zur Authentifizierung von Anfrage. Das Webservice ist ein SOAP Webservice, die
Portalverbundinformationen werden gemäß PVP-Spezifikation im SOAP-Header abgebildet.
Gemäß PVP 1.9 müssen die Authentifizierungsinformationen des auf die Schnittstelle zugreifenden Systems,
im Element systemPrincipal enthalten sein. Die Informationen des zugreifenden Endbenutzers müssen
im Element pvpChainedToken enthalten sein.
Für Abfragen wird die Rolle „TDB_Personenabfrage_WS“ mit einem oder mehreren Parametern, welche
das/die Organisationskennzeichen (OKZ) der abfrageberechtigten Stellen enthält, benötigt:
BMF II/12-TD 5 von 38AT:VKZ:BMF-S5-1234
AT:VKZ:BMF-S5-1234
tdb.test@bmf.gv.at
AT:VKZ:BMF-S5-1234
Bundesministerium für Finanzen
3
AT:VKZ:BMF-S5-1234
AT:VKZ:BMF-S5-1234
tdb.test@bmf.gv.at
AT:VKZ:BMF-S5-1234
Bundesministerium für Finanzen
3
tdb.test@bmf.gv.at
OKZ
BMF-II-12
2.2 SOAP Header für das Unternehmensserviceportal
Die Abfrage über USP erfordert eine Authentifizierung gegenüber dem USP mittels Benutzername und
Passwort eines im USP angelegten Webservicekontos. Die Zugangsdaten werden anstelle des PVP Token im
SOAP Header der Nachricht übermittelt. Die Informationen zur Rolle und zum Organisationskennzeichen
(OKZ) werden automatisiert über das USP zugewiesen:
s000b000g025
123xyz
BMF II/12-TD 6 von 38Request zur personenbezogenen Abfrage
Die Version 2.00 der Webservice Schnittstelle wird durch Verwendung des Namensraums
http://transparenzportal.gv.at/behoerdenabfrageV2 aufgerufen.
Endpoint URL
Portalverbund Produktion https://pamgate2.portal.at/at.gv.bmf.tdb-p/ws/behoerdenabfrage
Portalverbund Test https://pamgate2.portal.at/at.gv.bmf.tdb-t/ws/behoerdenabfrage
USP Produktion https://txm.portal.at/at.gv.bmf/tdb/behoerdenabfrage
USP Test https://txm.portal.at/at.gv.bmf/tdb-t/behoerdenabfrage
Hinweis zur Testumgebung:
Die Produktiv- und Testumgebung verwenden verschiedene Nummernkreise für Förderungen (unterschiedliche
LeistungsangebotsIDs). Daher ist es nicht möglich Förderungen aus der Produktivumgebung in der
Testumgebung zu verwenden. Sollten sie Förderungen in der Testumgebung benötigen wenden Sie sich an die
Abteilung Transparenzdatenbank (transparenzdatenbank@bmf.gv.at). Diese wird Ihnen die Testaten zur
Verfügung stellen.
BMF II/12-TD 7 von 383.1 Behördenabfrage Request
Abbildung 1: Behördenabfrage Request
Im SOAP Body des Webservice Request wird ein XML mit dem Element BehoerdenabfrageRequest
mitgegeben, welches im Folgenden beschrieben ist und das Wurzelelement darstellt. Die Webservice
Schnittstelle erfordert (wie auch die Benutzerschnittstelle) den Transport über HTTPS. Das Zertifikat muss
von einem Portalverbund-Zertifizierungsdienstanbieter oder vom Zertifizierungsdienstanbieter A-trust
ausgestellt sein. Des Weiteren erfordert das TDB-Anwendungsportal das Vorhandensein der im
Portalverbundprotokoll definierten HTTP-Header einschließlich der Authentifizierungs- und
Autorisierungsinformationen (siehe 5).
BMF II/12-TD 8 von 383.2 BehoerdenabfrageRequestType
Abbildung 2: BehoerdenabfrageRequestType
Dem Request muss die verwendete Webservice Version und zur eindeutigen Kennung eine AbfrageId
mitgegeben werden. Die AbfrageId dient dafür eine Verbindung mit dem Suchergebnis herstellen zu
können und kann frei gewählt werden. Im Element RequestAbV2_00 werden die fachlichen Daten für die
personenbezogene Abfrage mitgegeben.
v2.00
bf678bf6-f2ed-488
[..]
min
Name / Type /max Definition
Version 1..1 Verwendete Versionsnummer der Behördenabfrage.
String Aktuell: v2.00
AbfrageId 1..1 Eindeutige ID um den Response zuordnen zu können.
String 1-36 Zeichen
RequestAbV2_00 1..1 Container für Abfragekriterien (Siehe 10)
FoerderfallType
BMF II/12-TD 9 von 383.3 Request ab Version 2.00
Im RequestAbV2_00Type sind alle Informationen mitzugeben die benötigt werden um für eine bestimmte
natürliche oder nicht natürliche Person eine personenbezogene Abfrage aus der Transparenzdatenbank
durchzuführen.
Abbildung 3: RequestAbV2_00Type
[..]
2020
2020
1001981
[..]
false
true
min
Name / Type /max Definition
GZAntragsId 0..1 Mit dem optionalen Element GZAntragsId kann der auf den
String Geschäftsfall referenziert werden, aufgrund dessen die Abfrage
durchgeführt wird.
Max 40 Zeichen
Leistungsempfaenger 1..1 Person (natürlich oder nicht natürlich) für welche die Abfrage erfolgen
LeistungsempfaengerType soll.
AbfrageJahrVon 1..1 Zeitspannen Beginn, als Jahreszahl, in welcher das Auszahlungsdatum
String der Leistungen fallen muss. Wird nur ein Jahr abgefragt ist
AbfrageJahrVon gleich AbfrageJahrBis. Z.B. 2020
4 Zeichen
AbfrageJahrBis 1..1 Zeitspannen Ende, als Jahreszahl, in welcher das Auszahlungsdatum der
String Leistungen fallen muss. Wird nur ein Jahr abgefragt ist AbfrageJahrVon
gleich AbfrageJahrBis. Z.B. 2020
4 Zeichen
LeistungsangebotIDAbfrage 1..1 Leistungsangebot welches abgefragt werden soll, angegeben als
LeistungsangebotID laut Leistungsangebotsdatenbank.
Max 9 Zeichen
BMF II/12-TD 10 von 38min
Name / Type /max Definition
LeistungsangebotIDsZustimmung 0..* Erklärung der Zustimmung zur Einsichtnahme auf sensible und der
LeistungsangebotIDsZustimmung Geheimhaltung unterliegende Leistungsangebote (siehe 3.5)
Type
PdfAuszug 1..1 Das Element PdfAuszug gibt an, ob das Ergebnis der Abfrage zusätzlich
Boolean als Dokument im PDF Format mitgeliefert werden soll.
Werte: true/false
ExcelAuszug 1..1 Das Element PdfAuszug gibt an, ob das Ergebnis der Abfrage zusätzlich
Boolean als Dokument im Excel Format mitgeliefert werden soll.
Werte: true/false
3.4 Leistungsempfänger
Abbildung 4: LeistungsempfaengerType
Die personenbezogene Abfrage kann für natürliche (siehe 3.4.2) oder nicht natürliche Personen (siehe 3.4.1)
erfolgen. Es ist nicht möglich diese Empfängertypen zu mischen. Werden mehrere Leistungsempfänger
desselben Typs angegeben, so erfolgt eine gemeinsame Abfrage dieser Personen.
Hinweis zur gemeinsamen Abfrage mehrerer Leistungsempfänger:
Die gemeinsame Abfrage ist keine Möglichkeit Massenabfragen durchzuführen. Bei einer gemeinsamen Abfrage
werden mehrere Personen in einer Abfrage gemeinsam dargestellt. Dies kann zum Beispiel bei einer
Personengemeinschaft oder einem gemeinsamen Haushalt erforderlich sein.
min
Name / Type /max Definition
NichtNatuerlichePerson 1..* Container mit Informationen über die abzufragende nicht natürliche
NichtNatuerlichePersonType Person.
NatuerlichePerson 1..* Container mit Informationen über die abzufragende natürliche Person.
NatuerlichePersonType
BMF II/12-TD 11 von 383.4.1 Nicht natürliche Person
Nicht natürliche Personen benötigen zur Identifizierung eine gültige Stammzahl.
Abbildung 5: NichtNatuerlichePersonType
R034M541N
KUR
min
Name / Type /max Definition
Identification 1..1 Container für Identifikationsdaten
IdentificationType
3.4.2 Natürliche Person
Neben der im Container angegeben vbPK-ZP-TD wird für natürliche Personen auch Vorname, Nachname und
das Geburtsdatum benötigt.
Abbildung 6: NatuerlichePersonType
Max
Mustermann
1960-01-01
iO9A77oeaIEhk5VdszkXsSa[..]hSDlCebOD8kYLAlBUGE=
urn:publicid:gv.at:ecdid+BMF+ZP-TD
BMF II/12-TD 12 von 38min
Name / Type /max Definition
Vorname 1..1 Vorname der abzufragenden Person.
String max 200 Zeichen
Nachname 1..1 Nachname der abzufragenden Person.
String max 200 Zeichen
Geburtsdatum 1..1 Geburtsdatum der abzufragenden Person
Date Format: JJJJ-MM-DD
Identification 1..1 Container für Identifikationsdaten
IdentificationType
3.4.3 Identifizierung
In diesem Element wird im Type angegeben um welche Art von Stammzahl es sich handelt. In Value wird
die Stammzahl selbst übermittelt. Für natürliche Personen ist die vbPK-ZP-TD zu übermitteln. Bei nicht
natürlichen Personen können verschiedene Stammzahl Typen übermittelt werden (Z.B.: KUR oder
Firmenbuchnummer).
Abbildung 7: IdentificationType
min
Name / Type /max Definition
Value 1..1 Identifikationswert
String NatuerlichePersonType: vbPK-ZP-TD
NichtNatuerlichePersonType: Stammzahl oder KUR
BMF II/12-TD 13 von 38min
Name / Type /max Definition
Type 1..1 NatuerlichePersonType: urn:publicid:gv.at:ecdid+BMF+ZP-
String TD
NichtNatuerlichePersonType:
Syntax: urn:publicid:gv.at:baseid+SOURCE
Im URN bezeichnet SOURCE ein Kürzel für die Herkunft der Stammzahl
und MUSS einer der folgenden Werte entsprechen
Firmenbuchnummer: XFN
Vereinsregisternummer: XZVR
Ergänzungsregister: XERSB
Global Location Number: XGLN
Gemeindekennziffer: XGKZ
Für die Kennziffer des Unternehmens wird nicht die URI-Syntax sondern
lediglich das Kürzel KUR verwendet.
3.5 Zustimmungserklärung
Für die Einsicht auf einzelne Leistungen kann es erforderlich sein, sich die Zustimmung der
Förderungsempfänger einzuholen. Sollte im Zuge einer Behördenabfrage auf solche Lesitungen Einsicht
genommen werden, so ist es erforderlich, die Zustimmung des abgefragten Leistungsempfängers
einzuholen und dies zu dokumentieren. Bei der manuellen Abfrage im Verfahren der
Transparenzdatenbank wird diese Zustimmung durch den Benutzer unmittelbar über entsprechende
Checkboxen in der Anwendung abgefragt und geprüft. Bei der Abfrage durch Webservice kommt die
Information, dass der Nutzer zuvor seine Zustimmung für die Einsicht auf alle notwendigen
Leitungsangebote erteilt hat, nicht aus der direkten Benutzerinteraktion, sondern nur mittelbar.
Hinweis zur Zustimmungserklärung:
Die Abfrage von Leistungen, welche die Zustimmung des Leistungsempfängers erfordern, darf auch wirklich
nur mit vorliegender Zustimmung des Leistungsempfängers erfolgen.
Ist die Einsicht auf das Einkommen des Leistungsempfängers nur mit Zustimmung möglich, so muss auch
dafür eine Zustimmung erfolgen. Da das Einkommen selbst keine LeistungsangebotID hat muss das Feld
LeistungsangebotID der Wert „Einkommen“ eingetragen werden.
Abbildung 8: LeistungsangebotIDsZustimmungType
BMF II/12-TD 14 von 38min
Name / Type /max Definition
LeistungsangebotID 1..1 Identifikationsnummer des Leistungsangebots dem zugestimmt wird
String oder „Einkommen“ für die Abfrage des Einkommens
Zustimmung 1..1 Information, ob der Leistungsempfänger zugestimmt hat. Format: „J“
String oder „N“
3.6 Fehlercodes
Im Fehlerfall liefert das Element Message einen CustomFaultType mit einer Fehlernummer und einer
Fehlerbeschreibung zurück. Der CustomFaultType gliedert sich in die Elemente Code, Reason und die
optionalen Felder Help und Detail.
SOAP-ENV:Client
2618
Das AbfrageJahr ist ungültig. (gültige Werte: 2013 - aktuelles Jahr)
AbfrageId
bf678bf6-f2ed-488
Fehlercode Fehlertext
1600 Das Webservice für personenbezogen Abfrage steht aktuell nicht zur Verfügung. Unbekannter Fehler.
Bitte versuchen Sie es später erneut.
2601 Die AbfrageId enthält ungültige Zeichen.
2602 Die GZAntragsId enthält ungültige Zeichen.
2604 Der Vorname muss eingegeben werden.
2605 Der Vorname enthält ungültige Zeichen.
2606 Der Zuname muss eingegeben werden.
2607 Der Zuname enthält ungültige Zeichen.
2608 Ungültiger IdentificationTyp für natürliche Person.
2609 Die übermittelte vbPK ZP-TD hat eine ungültige Länge.
2610 Ungültiger IdentificationTyp für nicht natürliche Person.
BMF II/12-TD 15 von 382611 Die angegebene KUR ist ungültig.
2612 Die angegebene Firmenbuchnummer ist ungültig.
2613 Die angegebene Vereinsregisternummer ist ungültig.
2614 Die angegebene Ergänzungsregisternummer ist ungültig.
2615 Das AbfrageJahr ist ungültig. (gültige Werte: 2013 - aktuelles Jahr)
2616 Die LeistungsangebotsIDAbfrage ist ungültig.
2617 Die LeistungsangebotsID der Zustimmung ist ungültig. (LeistungsangebotID: )
2618 Das AbfrageJahrVon muss kleiner gleich dem AbfrageJahrBis sein.
2619 Die angegebene Gemeindekennziffer ist ungültig.
2620 Die angegebene Globale Location Number ist ungültig.
2621 Versionsnummer und übermittelter Request stimmen nicht überein.
3601 Jede LeistungsangebotsID der Zustimmung darf nur einmal vorhanden sein.
4602 Die LeistungsangebotsIDAbfrage kann nicht abgefragt werden, da diese nicht in der aktuell gültigen
Verordnung vorhanden ist.
4603 Ein Unfallversicherungsauszug kann nur für eine natürliche Person erstellt werden.
4604 Nicht für die Abfrage dieser LeistungsangebotsIDAbfrage berechtigt, da das OKZ der Rolle nicht im
Leistungsangebot berechtigt wurde.
4605 Für die Abfrage dieser LeistungsangebotsIDAbfrage sind keine Zustimmungen notwendig.
4606 Die vbPK des Empfängers konnte nicht entschlüsselt werden.
4607 Die nicht natürliche Person konnte mit der angegebenen Stammzahl nicht im Unternehmensregister
ermittelt werden.
4608 Die nicht natürliche Person konnte mit der angegebenen Stammzahl nicht im Unternehmensregister
ermittelt werden.
4609 Es konnte keine Person im ZMR und/oder ERnP gefunden werden.
4610 Ein Unfallversicherungsauszug kann nur für ein Auszahlungsjahr erstellt werden. (AbfrageJahrVon und
AbfrageJahrBis müssen gleich sein)
5601 Der Zugriff auf die Daten des Hauptverbandes der österreichischen Sozialversicherungsträger ist
derzeit aus technischen Gründen nicht verfügbar, daher kann kein Unfallversicherungsauszug erstellt
werden. Versuchen Sie es bitte zu einem späteren Zeitpunkt noch einmal.
5602 Das Service zum Entschlüsseln der vbPk-Zp-TD steht zur Zeit nicht zur Verfügung.
5603 Das ZMR-Service steht aktuell nicht zur Verfügung.
5604 Das Unternehmensregister steht aktuell nicht zur Verfügung.
5605 Die Transparenzportalabfrage konnte aus technischen Gründen nicht durchgeführt werden.
5606 Die Transparenzportalabfrage konnte aus technischen Gründen nicht durchgeführt werden.
BMF II/12-TD 16 von 385607 Die Transparenzportalabfrage konnte aus technischen Gründen nicht durchgeführt werden.
5608 Die SearchRequestId für die Abfrage der Schnittstellen konnte nicht erzeugt werden.
Response der personenbezogenen Abfrage
Das Webservice liefert im Erfolgsfall alle Informationen welche auch bei der Abfrage in der Applikation
Transparenzdatenbank zurückgeliefert werden.
Abbildung 9: Webservice Response
Um den Response dem ursprünglichen Request zuordnen zu können und richtig verarbeiten zu können wird
die AbfrageId und die Version gemeinsam mit dem Ergebnis zurück geliefert.
BMF II/12-TD 17 von 38Abbildung 10: BehoerdenabfrageResponse
v2.00
bf678bf6-f2ed-488
[..]
min
Name / Type /max Definition
Version 1..1 Version des Response
VersionType
AbfrageId 1..1 Identifikationsnummer die dem Request mitgegeben wurde.
AbfrageIdType
ResponseV2_00 1..1 Container für das Abfrageergebnis
ResponseV2_00Type
4.1 Response ab Version 2.00
Die Antwort des Webservice enthält im Container ResponseV2_00 entweder einen Auszug der
Leistungsdaten des Leistungsempfängers oder eine Liste jener Leistungsangebote, für welche die
Zustimmung des Empfängers erforderlich ist (siehe 2.4). Die Antwort kann auf Anforderung das Ergebnis
zusätzlich im PDF und/oder im Excel Format mitliefern (z.B. zur Beilage für einen Akt). Die AbfrageID
entspricht der Request AbfrageID.
BMF II/12-TD 18 von 38Abbildung 11: ResponseV2_00
[..]
[..]
[..]
min
Name / Type /max Definition
ZustimmungErforderlich 1..* Container für fehlende Zustimmung (siehe 0)
ZustimmungErforderlichType
ta2_00:TDBAuszug 1..1 Leistungsdatenauszug (siehe 00)
PdfAuszug 0..1 Leistungsdaten als PDF-Auszug (siehe 0)
DokumentType
ExcelAuszug 0..1 Leistungsdaten als Excel (siehe 0)
DokumentType
BMF II/12-TD 19 von 384.2 Verhalten der Schnittstelle bei fehlender Zustimmung zur Einsicht
Die Zustimmung wird in Form der jeweiligen LeistungsangebotIDs der betroffenen Leistungsangebote sowie
eines Ja/Nein-Wertes (J/N) dokumentiert. Fehlen eine oder mehrere LeistungsangebotsIDs (für welche eine
Zustimmung erforderlich ist) gibt die Schnittstelle eine Fehlermeldung zurück. Diese Fehlermeldung enthält
eine Liste aller Leistungsangebote für die eine Zustimmung erforderlich ist.
Beispiel: Leistungsangebot 1027473 Pflegekarenzgeld hat Einsicht auf Leistungsangebote 1004647, 1004662
sowie auf das Einkommen. Die Einsicht auf alle diese Leistungen erfordern die Zustimmung des
Leistungsempfängers.
In diesen Fällen wird das Element ZustimmungErforderlich zurück geliefert. Es enthält eine Liste jener
erforderlichen LeistungsangebotIDs für die der Leistungsempfänger seine Zustimmung erklären muss, damit
Leistungsdaten abgefragt werden können. Die Liste ist in der Rückantwort enthalten, wenn im Such-Request
nicht alle erforderlichen LeistungsangebotIDs enthalten waren (siehe 3.5).
v2.00
bf678bf6-f2ed-488
Einkommen
Einkommen
1004662
Audit Pflegeundfamilie
1004647
Familienbeihilfe
BMF II/12-TD 20 von 384.3 Leistungsdatenauszug
Die Leistungsdaten werden der abfragenden Stelle in der Struktur des Leistungsdatenauszugs des
Leistungsempfängers übermittelt. Der Auszug besteht aus Details zum Auszug, Daten des
Leistungsempfängers und mehreren Abschnitten mit ausbezahlten Leistungen.
Abbildung 12: TDBAuszug
[..]
[..]
[..]
[..]
min
Name / Type /max Definition
AuszugDetails 1..1 Allgemeine Details
AuszugDetailsType
Leistungsempfaenger 1..1 Daten der Leistungsempfänger
LeistungsempfaengerType
AuszugAbschnitt 1..* Abschnitte über ausbezahlte Leistungen
AuszugAbschnittType
AuszugErgebnis 1..1 Gesamtergebnis
AuszugErgebnisType
BMF II/12-TD 21 von 384.3.1 Auszugdetails
In den Auszugdetails sind die Metainformationen zur Abfrage enthalten: Das Jahr/Jahre für welche die
Abfrage durchgeführt wird, das Datum der Abfrage, die Bezeichnung der Person welche die Abfrage
durchgeführt hat und die GZAntragsId. Das Feld GZAntragsId enthält die Kennung des Geschäftsfalls
aus der Suchanfrage von maximal 40 Zeichen. Das Element ist leer, wenn im Request keine Kennung
übermittelt wurde.
Abbildung 13: Auszugdetails
2020
2020
2020-05-11
min
Name / Type /max Definition
AbfragejahrVon 1..1 Beginnjahr des Abfragezeitraums
Short Format: JJJJ
AbfragejahrBis 1..1 Endjahr des Abfragezeitraums
Short Format: JJJJ
AbfrageDatum 1..1 Datum wann die Abfrage erstellt wurde.
Date Format: JJJ-MM-DD
AbfragePerson 1..1 Common-Name aus dem PVP-Header der Person, welche die Abfrage
String erstellt hat.
GZAntragsId 0..1 Kennung des Geschäftsfalls aus der Suchanfrage. Max. 40 Zeichen. Das
String Element ist leer wenn im Request keine Kennung übermittelt wurde.
BMF II/12-TD 22 von 384.3.2 Leistungsempfänger
Der Leistungsempfänger kann eine natürliche oder nicht natürliche Person sein. Wurde eine gemeinsame
personenbezogene Abfrage (Siehe S.11) durchgeführt, so werden mehrere Leistungsempfänger
zurückgegeben.
Ein Hinweis wird etwa dann geliefert, wenn im Zuge der Abfrage eine der Online-Schnittstellen zum
Dachverband der Sozialversicherungsträger (DVSV), zum Arbeitsmarktservice (AMS) oder zum
Bundesministerium für Finanzen (BMF) nicht verfügbar ist.
Abbildung 14: Leistungsempfänger
Zartl
Rudolf
1961-02-13
min
Name / Type /max Definition
NatuerlichePerson 0..* Container für Daten, wenn der Leistungsempfänger eine natürliche
NatuerlichePerson_Type Person ist.
NichtNatuerlichePerson 0..* Container für Daten, wenn der Leistungsempfänger eine nicht
NichtNatuerlichePerson_Type natürliche Person ist.
Hinweis 0..* Hinweise über nicht verfügbare Schnittstellen (Siehe 0)
Hinweis_Type
BMF II/12-TD 23 von 384.3.2.1 Natürliche Person
Ist der Leistungsempfänger eine natürliche Person, so wird Vorname, Zuname und Geburtsdatum in der
Abfrage zurückgeliefert.
Abbildung 15: Natürliche Person
Zartl
Rudolf
1961-02-13
min
Name / Type /max Definition
Vorname 1..1 Vorname des Leistungsempfängers
String
Zuname 1..1 Zuname des Leistungsempfängers
String
Geburtsdatum 1..1 Geburtsdatum des Leistungsempfängers
Date Format: JJJJ-MM-DD
BMF II/12-TD 24 von 384.3.2.2 Nicht natürliche Person
Bei nicht natürlichen Personen wird der Unternehmensname, Unternehmenssitz und die KUR
zurückgeliefert. Der Unternehmensvertreter wird im Behördenabfrage-WS nicht verwendet.
Abbildung 16: Nicht natürliche Person
Hintere Zollamtsstr. 4 - 1140 Wien
Faonline Testunternehmen
R034M541N
min
Name / Type /max Definition
Firmenname 1..1 Name der Firma
String
Firmensitz 1..1 Sitz der Firma
String
Unternehmensvertreter 0..1 Wird beim behördenabfrage-WS nicht verwendet
String
KUR Kennziffer des Unternehmensregister
String
BMF II/12-TD 25 von 384.3.3 Auszugabschnitt
Die Antwort des Webservice ist in die gleichen Abschnitte wie die Transparenzportalabfrage gegliedert. Jeder
Abschnitt hat eine Bezeichnung und einen oder mehrere Bereiche.
Abbildung 17: Auszug Abschnitt
Förderungen / Transferzahlungen
[..]
min
Name / Type /max Definition
AuszugAbschnittBezeichnung 1..1 Bezeichnung des Abschnitts
String
AuszugAbschnittBereich 1..* Container für die Leistungen und Hinweise
AuszugAbschnittBereich_Type
BMF II/12-TD 26 von 384.3.4 Bereich
AuszugAbschnittBereich dient als Container in welchem entweder Leistungen oder Hinweise des
jeweiligen Abschnitts transportiert werden. Jeder Abschnitt kann mehrere Elemente Leistungen haben.
Bei der personenbezogenen Abfrage mehrerer Personen wird im Element
BereichLeistungsempfänger angegeben, zu welchem abgefragten Leistungsempfänger diese
Leistungen gehören. Wird nur ein Leistungsempfänger abgefragt entfällt dieses Element.
Abbildung 18: Bereich
Mustermann Max
[..]
[..]
min
Name / Type /max Definition
BereichLeistungsempfaenger 0..1 Leistungsempfänger der Leistungen. Bei der Abfrage mehrerer Jahre
String wird das Jahr ebenfalls mitgeliefert
Leistung 0..* Container für die Leistungen
Leistung_Type
Hinweis 0..* Hinweise zu den Leistungen
Hinweis_Type
BMF II/12-TD 27 von 384.3.5 Leistungen
Im Element Leistung sind die Leistungsdaten des Auszugs enthalten. Dieses Element kann entweder Daten
zu einem Förderungsfall oder einer Auszahlung enthalten. Es werden die vorhandenen Details zu dieser
Leistung zurückgeliefert. Die Bedarfsgemeinschaft gibt an, ob ein Leistungsbezieher eine Leistung selbst
oder als Vertreter einer Gemeinschaft erhalten hat. VerpflichtungLeistungAnDritte gibt an, ob die Leistung
an einen anderen Endbegünstigten weitergegeben wird. Summen zu einem Abschnitt werden als Element
Leistung_Type zurückgegeben, dabei wird das Element ShowAsSumme als true geliefert.
Abbildung 19: Leistung
BMF II/12-TD 28 von 38Beispiel Förderungsfall mit Auszahlung
false
1002641
i2 - Die Börse für Business Angels
i2 - Die Börse für Business Angels
Beratung Investition
Beratung und sonstige Dienstleistungen Investition
11.05.2020
gewährt
300,00
Bundesministerium XY
Bezeichnung
0100000
test@test.at
true
false
1002641
i2 - Die Börse für Business Angels
TEST Auszahlung
11.05.2020
400,00
01.01.2020
29.02.2020
Land Niederösterreich
Bezeichnung
0100000
test@test.at
true
Nicht Kofinanziert
min
Name / Type /max Definition
ShowAsSumme 1..1
Boolean
Laid 0..1 Identifikationsnummer der Förderung.
String
BezLaid 0..1 Bezeichnung der Förderung
String
Bezeichnung 0..1 Bezeichnung der Leistung
String
Foerdergegenstand 0..* Es werden alle Förderungsgegenstände zurückgeliefert die dem
String Förderungsfall zugeordnet wurden.
Datum 0..1 Datum wann der Status eingetreten ist.
String
Status 0..1 Status der Leistung
String
BetragStatus 0..1 Betrag zum Status. Z.B. beim Status „gewährt“ wird der gewährte
String Betrag geliefert.
BetragLeist 0..1 Betrag der Leistung
BMF II/12-TD 29 von 38min
Name / Type /max Definition
String
SummeStatus 0..1 Summe aller Statusbeträge
String
SummeLeist 0..1 Summe aller Leistungen
String
ZeitraumVon 0..1 Beginn des Leistungszeitraums
String
ZeitraumBis 0..1 Ende des Leistungszeitraums
String
Foerdergeber 0..1 Abwicklungsstelle, welche die Auszahlung getätigt hat
String
FoerdergeberKontakt 0..1 Bezeichnung der Abwicklungsstelle
String
FoerdergeberTel 0..1 Telefonnummer der Abwicklungsstelle
String
FoerdergeberMail 0..1 E-Mail der Abwicklungsstelle
String
DeminimisRelevant 0..1 Indikation, ob die Leistung De-minimis relevant ist.
Boolean
Bedarfsgemeinschaft 0..1 Gibt an ob ein Leistungsbezieher eine Leistung selbst oder als Vertreter
Boolean einer Gemeinschaft erhalten hat.
VerpflichtungLeistungAnDritte 0..1 Gibt an, ob die Leistung an andere Endbegünstigte weitergegeben wird
Boolean
CoFinanziert 0..1 Wenn die Auszahlung durch mehrere Stellen finanziert wird, wird die
String kofinanzierende Stelle in diesem Feld angegeben.
AnmerkungDsgvo 0..1 Wurde ein Antrag auf Berichtigung lt. DSGVO gestellt, so wird in diesem
String Element die entsprechende Anmerkung mitgeliefert.
Auszahlung 0..* Sind zu dem Förderungsfall Auszahlungen vorhanden, so werden diese
Lesitung_Type als Auszahlung zurückgeliefert.
BMF II/12-TD 30 von 384.3.6 Hinweise
Abbildung 20: Hinweis
*) BG: Auszahlung wurde vom Förderungsempfänger für eine Bedarfsgemeinschaft empfangen
min
Name / Type /max Definition
Text 1..1 Leistungsempfänger der Leistungen. Bei der Abfrage
String mehrerer Jahre wird das Jahr ebenfalls mitgeliefert
Betrag 0..1 Betrag zum Hinweis
String
In einigen Fällen wird dem Hinweis ein Betrag mitgeliefert. Dies kann zum Beispiel beim Einkommen der Fall
sein.
Abbildung 21: Beispiel Betrag bei Hinweis
BMF II/12-TD 31 von 384.4 Leistungsdatenauszug als PDF oder Excel
Wird im Request angefordert, dass die Leistungsdaten auch als PDF oder Excel geliefert werden sollen,
enthält die Antwort das Element PdfAuszug bzw. ExcelAuszug. Inhalte dieser Elemente sind die
Leistungsdaten der Person in Base64-codierter Form, der Dateiname sowie der Mime-Type.
Abbildung 22: Dokumente
UEsDBBQACAgIAA9Nq[...]GgbAAAAAA==
20200511_8976_TDB_Personenbezogene_Abfrage.xlsx
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
min
Name / Type /max Definition
Daten 1..1 Base64 codiertes Dokument
Base64Binary
Dateiname 1..1 Name der Datei
String
Mimetype 1..1 Verwendeter Mime Type
String
BMF II/12-TD 32 von 38Anhang
Beispiel Webservice Request mit PVP-ChainedToken-Header (natürliche Person)
AT:VKZ:BMF-S5-1234
AT:VKZ:BMF-S5-1234
tdb.test@bmf.gv.at
AT:VKZ:BMF-S5-1234
Bundesministerium für Finanzen
3
AT:VKZ:BMF-S5-1234
AT:VKZ:BMF-S5-1234
tdb.test@bmf.gv.at
AT:VKZ:BMF-S5-1234
Bundesministerium für Finanzen
3
tdb.test@bmf.gv.at
OKZ
BMF-II-12
v2.00
bf678bf6-f2ed-488
Max
Mustermann
1960-01-01
iO9A77oeaIEhk5VdszkXsSa[..]hSDlCebOD8kYLAlBUGE=
urn:publicid:gv.at:ecdid+BMF+ZP-TD
2020
2020
1001981
Einkommen
J
1004639
J
false
true
BMF II/12-TD 33 von 38Beispiel Response bei fehlender Zustimmung im Request
v2.00
bf678bf6-f2ed-488
Einkommen
Einkommen
1004639
Audit Pflegeundfamilie
1000884
Familienbeihilfe
1000736
Freifahrt für Lehrlinge
1006808
Gewinnfreibetrag
BMF II/12-TD 34 von 38Beispiel Webservice Response (natürliche Person)
v2.00
bf678bf6-f2ed-488
2020
2020
2020-05-11
Zartl
Rudolf
1961-02-13
Förderungen / Transferzahlungen
false
1002641
i2 - Die Börse für Business Angels
i2 - Die Börse für Business Angels
Beratung Investition
Beratung und sonstige Dienstleistungen Investition
11.05.2020
gewährt
300,00
Land Niederösterreich
Bezeichnung
0100000
test@test.at
true
false
1002641
i2 - Die Börse für Business Angels
TEST Auszahlung
11.05.2020
400,00
01.01.2020
29.02.2020
Land Niederösterreich
Bezeichnung
0100000
test@test.at
true
Nicht Kofinanziert
true
Zwischensumme
300,00
400,00
*) BG: Auszahlung wurde vom Förderungsempfänger für eine Bedarfsgemeinschaft empfangen
*) LV: Auszahlung wurde vom Förderungsempfänger als Leistungsverpflichteter empfangen, die Auszahlung wurde
an Dritte weitergegeben
Alle angeführten Beträge in Euro
UEsDBBQACAgIAA9Nq[...]GgbAAAAAA==
20200511_8976_TDB_Personenbezogene_Abfrage.xlsx
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
BMF II/12-TD 35 von 38Beispiel Webservice Response mehrere Leistungsempfänger (natürliche Personen)
v2.00
bf678bf6-f2ed-488
2020
2020
2020-05-12
Zartl
Rudolf
1961-02-13
Mustermann
Max
1940-01-01
Förderungen / Transferzahlungen
Zartl Rudolf
false
1002641
i2 - Die Börse für Business Angels
i2 - Die Börse für Business Angels
Beratung Investition
Beratung und sonstige Dienstleistungen Investition
11.05.2020
gewährt
300,00
Land Niederösterreich
Bezeichnung
0100000
test@test.at
true
TDB111374
TDB2390
false
1002641
i2 - Die Börse für Business Angels
TEST Auszahlung
11.05.2020
400,00
01.01.2020
29.02.2020
Land Niederösterreich
Bezeichnung
0100000
test@test.at
true
Nicht Kofinanziert
TDB111374
TDB2390
TDB2391
true
Zwischensumme
300,00
400,00
*) BG: Auszahlung wurde vom Förderungsempfänger für eine Bedarfsgemeinschaft empfangen
*) LV: Auszahlung wurde vom Förderungsempfänger als Leistungsverpflichteter empfangen, die Auszahlung wurde
an Dritte weitergegeben
Mustermann Max
BMF II/12-TD 36 von 38false
1013499
1. Testangebot
;?!
04.02.2020
10,00
01.01.2019
01.01.2019
Land Niederösterreich
Test
TDB2349
false
1013499
1. Testangebot
Test _ ; ? !
04.02.2020
10,00
01.01.2019
01.01.2019
Land Niederösterreich
Test
TDB2345
false
1002641
i2 - Die Börse für Business Angels
i2 - Die Börse für Business Angels
Beratung Beschäftigungsrelevanz
24.03.2020
gewährt
2.333,00
Land NÖ
test neu
true
TDB2363
false
1002641
i2 - Die Börse für Business Angels
Test _;!?
05.03.2020
2.333,00
01.01.2020
01.01.2020
Land NÖ
test neu
true
TDB2363
TDB2364
true
Zwischensumme
2.333,00
2.353,00
*) BG: Auszahlung wurde vom Förderungsempfänger für eine Bedarfsgemeinschaft empfangen
*) LV: Auszahlung wurde vom Förderungsempfänger als Leistungsverpflichteter empfangen, die Auszahlung wurde
an Dritte weitergegeben
Alle angeführten Beträge in Euro
JVBERi0xLjQNCiXIycrLDQo2I[..]UlRU9GCg==
20200512_9016_TDB_Personenbezogene_Abfrage.pdf
application/pdf
UEsDBBQACAgIAGWCrFAAAAA[..]AoHQAAAAA=
20200512_9016_TDB_Personenbezogene_Abfrage.xlsx
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
BMF II/12-TD 37 von 38Bundesministerium für Finanzen Johannesgasse 5, 1010 Wien +43 1 514 33-0 bmf.gv.at
Sie können auch lesen
