Übersicht
Mit dieser API können die Vorgänge aus der Europace Plattform ausgelesen werden.
Aktuelle Version
Version : 3.0
Kontaktinformationen
Kontakt : Europace AG
Kontakt E-Mail : helpdesk@europace2.de
Weitere Informationen : www.europace2.de
URI Schema
Host : https://baufismart.api.europace.de
Basis-Pfad : /
Schemata : HTTPS
Sicherheit
oauth2
Typ : oauth2
Flow : application
Token URL : https://api.europace.de/auth/access-token
Für den Aufruf der API benötigte Scopes.
Name | Beschreibung |
---|---|
|
Erlaubt das Anlegen von Vorgängen im Echtgeschäft |
|
Erlaubt das Lesen von Vorgängen |
|
Erlaubt das Schreiben von Vorgängen |
Ressourcen
Finanzierungsvorschlag
Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer erwartet. Bei Finanzierungsvorschlägen handelt es sich um ausgehändigte Finanzierungsvorschläge in Baufsmart. Achtung: Bei den ausgegebenen Finanzierungsvorschlägen handelt es sich um Mockdaten. (getFinanzierungsvorschlaege)
get /v3/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.
|
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer und die Id des Finanzierungsvorschlags erwartet. Achtung: Bei dem ausgegebenen Finanzierungsvorschlag handelt es sich um Mockdaten. (getFinanzierungsvorschlag)
get /v3/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege/{finanzierungsvorschlagId}
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.
|
|
|
Path |
finanzierungsvorschlagId |
Die Id des Finanzierungsvorschlags.
|
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Vorgaenge
Schreibt eine Nachricht an den Vorgang in BaufiSmart (addNachricht)
post /v3/vorgaenge/{vorgangsNummer}/nachricht
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Body |
body |
|||
Path |
vorgangsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
201 |
CREATED |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Konsumiert
application/json
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Alle Anträge zum Vorgang (getAllVorgangsAntraege)
get /v3/vorgaenge/{vorgangsNummer}/antraege
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Ein spezifischer Antrag des Vorgangs (getAntrag)
get /v3/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}/{teilantragsNummer}
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
|
||
Path |
antragsNummer |
|
||
Path |
teilantragsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer erwartet. Bei Finanzierungsvorschlägen handelt es sich um ausgehändigte Finanzierungsvorschläge in Baufsmart. Achtung: Bei den ausgegebenen Finanzierungsvorschlägen handelt es sich um Mockdaten. (getFinanzierungsvorschlaege)
get /v3/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.
|
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer und die Id des Finanzierungsvorschlags erwartet. Achtung: Bei dem ausgegebenen Finanzierungsvorschlag handelt es sich um Mockdaten. (getFinanzierungsvorschlag)
get /v3/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege/{finanzierungsvorschlagId}
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.
|
|
|
Path |
finanzierungsvorschlagId |
Die Id des Finanzierungsvorschlags.
|
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Den Kundenbetreuer des Vorgangs abrufen (getKundenbetreuer)
get /v3/vorgaenge/{vorgangsNummer}/kundenBetreuer
Beschreibung
Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
alle sichtbaren Vorgänge (getVorgaenge)
get /v3/vorgaenge
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Query |
datenKontext |
Datenkontext
|
|
|
Query |
aenderungSeit |
Der 'aenderungSeit' Parameter hat das 'ISO 8601' Format. Beispiele: '2020-07-10', '2020-07-10T13:00Z'
|
|
|
Query |
aenderungBis |
Der 'aenderungBis' Parameter hat das 'ISO 8601' Format. Beispiele: '2020-07-10', '2020-07-10T14:00Z'
|
|
|
Query |
sort |
Sortierung der Vorgänge, aufsteigend oder absteigend
|
|
absteigend |
Query |
page |
|
0 |
|
Query |
limit |
|
10 |
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
einen Vorgang abrufen (getVorgang)
get /v3/vorgaenge/{vorgangsNummer}
Beschreibung
Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
Nummer des Vorgangs
|
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Anträge zum Vorgang (getVorgangsAntraege)
get /v3/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
|
||
Path |
antragsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Den Vorgangsbearbeiter des Vorgangs abrufen (getVorgangsBearbeiter)
get /v3/vorgaenge/{vorgangsNummer}/vorgangsBearbeiter
Beschreibung
Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Path |
vorgangsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
(putVorgangsBearbeiterId)
put /v3/vorgaenge/{vorgangsNummer}/vorgangsBearbeiter
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Body |
body |
|||
Path |
vorgangsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Konsumiert
application/json
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Zum Setzen des Antragsstatus (setAntragsStatus)
post /v3/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}/{teilantragsNummer}/status
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Body |
body |
|||
Path |
vorgangsNummer |
|
||
Path |
antragsNummer |
|
||
Path |
teilantragsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
202 |
Accepted |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Konsumiert
application/json
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Zum Senden eines Signals an den Produktanbieter, dass er mit der Kreditentscheidung beginnen kann (setEntscheidungsreife)
post /v3/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}/{teilantragsNummer}/entscheidungsreife
Beschreibung
Um das Entscheidungsreifesignal senden zu können bedarf es folgender Kriterien. 1. Der Aufrufer muss Vorgangsbearbeiter sein. 2. Der Antrag ist im Status: Antragsteller.BEANTRAGT, ProduktAnbieter.NICHT_BEARBEITET. 3. Das Signal kann nur einmal geschickt werden.
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Body |
body |
|||
Path |
vorgangsNummer |
|
||
Path |
antragsNummer |
|
||
Path |
teilantragsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
202 |
Accepted |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Konsumiert
application/json
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Den Kundenbetreuer ändern (updateKundenBetreuer)
put /v3/vorgaenge/{vorgangsNummer}/kundenBetreuer
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Body |
body |
|||
Path |
vorgangsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
204 |
No Content |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Konsumiert
application/json
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Änderung von Metadaten an einem bestehenden Vorgang (updateVorgang)
patch /v3/vorgaenge/{vorgangsNummer}
Beschreibung
Parameter
Typ | Name | Beschreibung | Typ | Standard |
---|---|---|---|---|
Body |
body |
|
||
Path |
vorgangsNummer |
|
Antworten
HTTP Code | Beschreibung | Typ |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
|
502 |
Bad Gateway |
|
504 |
Gateway Timeout |
Konsumiert
application/json-patch+json
Erzeugt
application/json
Sicherheit
Typ | Name | Scopes |
---|---|---|
oauth2 |
|
Definitionen
Hinweis zu @type Feldern
Wenn in einem Feld verschiedene Typen verwendet werden können, wird der verwendete Typ mit Hilfe des @type
Feldes definiert. Dabei ist zu beachten, dass der Typ im SCREAMING_SNAKE_CASE
angegeben wird.
Beispiel:
- Typ: Arbeitsloser wird zu
"@type": "ARBEITSLOSER"
- Typ: KaufNeubauVomBautraeger wird zu
"@type": "KAUF_NEUBAU_VOM_BAUTRAEGER"
Absicherung
Name | Beschreibung | Typ |
---|---|---|
abgesicherteRisiken
|
|
|
gesamtPraemie
|
|
|
praemienZahlungsweise
|
|
|
tarifBezeichnung
|
|
|
tarifKennung
|
|
|
versichertePersonId
|
|
|
versicherungsArt
|
|
|
versicherungsNummer
|
|
|
versicherungsZeitraum
|
|
AbsicherungsAngaben
Name | Beschreibung | Typ |
---|---|---|
betraegtWoechentlicheArbeitsZeitMindestens15Stunden
|
|
|
pruefungVorhandenerAbsicherungen
|
|
Absicherungswunsch
Name | Beschreibung | Typ |
---|---|---|
id
|
|
|
versicherungsWuensche
|
|
Angebot
Name | Beschreibung | Typ |
---|---|---|
_links
|
|
|
absicherungen
|
|
|
bausparvertraege
|
|
|
beleihungsRechnung
|
|
|
bewertungDesAngebots
|
|
|
darlehen
|
|
|
erzeugtAm
|
Erzeugungsdatum des Angebots |
|
kennung
|
|
|
machbarkeitsStatus
|
|
|
meldungen
|
|
|
nummerAmVorgang
|
Nummer des gemerkten Angebotes eines Vorgangs. |
|
pruefungsErgebnisse
|
|
|
zahlungsplaene
|
Link zu den Zahlungsplänen des Angebots. |
AngebotsPruefungsErgebnis
Name | Beschreibung | Typ |
---|---|---|
produktAnbieter
|
|
|
weitereAngaben
|
Vom Produktanbieter bei der Angebotsprüfung ergänzte Daten. Das Format entspricht der Definition des Produktanbieters. |
AnnuitaetenDarlehensWunsch
Name | Beschreibung | Typ |
---|---|---|
auszahlungsDatum
|
Bitte 'auszahlungsZeitpunkt' verwenden |
|
auszahlungsZeitpunkt
|
|
|
bereitstellungsZinsFreieZeitInMonaten
|
|
|
darlehensBetrag
|
|
|
provision
|
|
|
riesterFoerderung
|
|
|
riesterGefoerdertePerson
|
|
|
sondertilgungOptionalJaehrlich
|
|
|
tilgungsWunsch
|
|
|
zinsBindungInJahren
|
|
Antrag
Diese Resource repräsentiert einen Antrag in Baufi Smart.
Name | Beschreibung | Typ |
---|---|---|
_links
|
|
|
angebot
|
Das angenommene Angebot, auf dem dieser Antrag basiert |
|
ansprechpartner
|
|
|
antragsNummer
|
Nummer des Antrags auf der Europace Plattform |
|
antragsReferenzen
|
Referenzen am Antrag, die durch den Produktanbieter gesetzt wurden |
|
beratung
|
Informationen zum Geschäftsabschluss |
|
datenKontext
|
Gibt an, ob es sich um einen Antrag aus dem Testmodus oder Echtgeschäft handelt |
|
dokumente
|
Enthält alle Plattformdokumente, freigegebene Dokumente des Vertriebs, sowie die hochgeladenen Dokumente des Produktanbieters. <strong>Aktuell sind nur Selbstauskunft und Kreditentscheidungsinformation enthalten.</strong> |
|
kreditSachbearbeiter
|
|
|
produktAnbieter
|
|
|
status
|
Bearbeitungsfortschritt des Antrags |
|
vermittler
|
Partner auf Seite des Vertriebs |
|
zeitpunktDerAnnahme
|
Zeitpunkt, zu dem der Antrag im System erstellt wurde. |
|
zugrundeliegendeDaten
|
Basisdaten des Kunden, die für die Berechnung des Angebots relevant waren |
AntragsStatus
Name | Beschreibung | Typ |
---|---|---|
antragsteller
|
Willenserklärung des Antragstellers |
|
antragstellerAblehnungsgrund
|
Ablehnungsgrund des Antragstellers |
|
bearbeitungsFortschritt
|
Bearbeitungsfortschritt des Antrags nach beidseitiger Unterzeichnung |
|
produktAnbieter
|
Willenserklärung des Produktanbieters |
|
produktanbieterAblehnungsgrund
|
Ablehnungsgrund des Produktanbieters |
Antragsteller
Name | Beschreibung | Typ |
---|---|---|
absicherungsAngaben
|
|
|
anrede
|
|
|
anschrift
|
|
|
arbeitserlaubnis
|
wenn keine deutsche Staatsangehörigkeit |
|
arbeitserlaubnisBefristetBis
|
wenn Arbeitserlaubnis befristet |
|
aufenthaltsTitel
|
wenn keine deutsche Staatsangehörigkeit |
|
aufenthaltsTitelBefristetBis
|
wenn Aufenthaltstitel befristet |
|
beschaeftigung
|
|
|
bruttoJahresEinkommenErwartet
|
|
|
bruttoVorjahresEinkommen
|
|
|
dritteStaatsangehoerigkeit
|
|
|
email
|
Eine valide Emailadresse |
|
externeAntragstellerId
|
|
|
familienstand
|
|
|
geburtsdatum
|
|
|
geburtsland
|
|
|
geburtsort
|
|
|
guetertrennungVereinbartWennVerheiratet
|
nur wenn verheiratet |
|
id
|
|
|
inDeutschlandSeit
|
wenn keine deutsche Staatsangehörigkeit |
|
legitimationsDaten
|
|
|
nachname
|
|
|
privateKrankenversicherungMonatlicheAusgaben
|
|
|
schufaErgebnis
|
|
|
sozialversicherungsnummer
|
|
|
staatsangehoerigkeit
|
|
|
steuerId
|
|
|
telefonnummer
|
|
|
telefonnummerVorwahl
|
|
|
titel
|
|
|
titelDoktor
|
|
|
titelProfessor
|
|
|
vorAnschrift
|
|
|
vorname
|
|
|
weitereKontaktMoeglichkeiten
|
|
|
wohnhaftSeit
|
|
|
zweiteStaatsangehoerigkeit
|
|
AusgabenMonatlich
Name | Beschreibung | Typ |
---|---|---|
ausgabenMonatlich
|
|
|
berechnungsHilfeVermoegen
|
|
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
Autostellplatz
Name | Beschreibung | Typ |
---|---|---|
mieteinnahmenMonatlich
|
|
|
typ
|
|
|
vermietet
|
|
BankUndSparguthaben
Name | Beschreibung | Typ |
---|---|---|
aktuellerWert
|
|
|
ertrag
|
|
|
maximalAufzuloesenderWert
|
|
|
vermoegensEinsatz
|
|
|
vermoegensTyp
|
Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium |
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
|
zinsertragJaehrlich
|
|
|
zukuenftigeEinnahmen
|
|
Bankverbindung
Name | Beschreibung | Typ |
---|---|---|
bic
|
|
|
iban
|
|
|
id
|
|
|
kontoinhaberIds
|
|
|
kontoinhaberName
|
|
|
kreditinstitut
|
|
BausparAngebot
Name | Beschreibung | Typ |
---|---|---|
abschlussGebuehr
|
|
|
angebotsHinweisFuerAntragsteller
|
nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten |
|
bausparSumme
|
|
|
einmalzahlung
|
Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. |
|
guthabenZins
|
|
|
id
|
|
|
produktAnbieter
|
|
|
sonderZahlungen
|
|
|
sparBeginn
|
Der berechnete Beginn des Besparens des Bausparvertrags. |
|
sparPhase
|
|
|
tarif
|
|
|
tilgungsPhase
|
|
|
typ
|
|
|
vertragsBeginn
|
|
|
vertragsNummer
|
|
|
verwaltungsgebuehrenJaehrlich
|
|
|
zuteilungsDatum
|
|
BausparDarlehensWunsch
Name | Beschreibung | Typ |
---|---|---|
bausparGuthaben
|
|
|
bausparSumme
|
|
|
bausparTarif
|
|
|
darlehensBetrag
|
|
|
provision
|
|
|
tilgungsBeitragMonatlich
|
|
|
vertragsNummer
|
|
|
vertragsPartnerIds
|
|
|
zuteilungsAnnahme
|
|
BausparTarif
Name | Beschreibung | Typ |
---|---|---|
id
|
|
|
kurzName
|
|
|
langName
|
|
|
produktAnbieter
|
|
|
riesterFoerderung
|
|
|
status
|
|
BausparWunsch
Von den Feldern bausparSummeAbsolut, bausparSummeRelativ, sparBeitragMonatlichAbsolut, sparBeitragMonatlichRelativ, tilgungsBeitragMonatlich, zuteilungsDatum und sparBeginn können maximal drei befüllt sein.
Name | Beschreibung | Typ |
---|---|---|
abschlussGebuehrenVerrechnung
|
|
|
bausparSummeAbsolut
|
|
|
bausparSummeRelativ
|
|
|
bausparTarif
|
|
|
bausparTarife
|
Deprecated, Zukünftig sind die Informationen zum gewünschen Tarif unter bausparTarif zu finden. |
|
id
|
|
|
riesterFoerderung
|
|
|
sonderZahlungEinmalig
|
Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. |
|
sonderZahlungen
|
|
|
sparBeginn
|
Der Beginn des Besparens des Bausparvertrags ist frei festlegbar. |
|
sparBeitragMonatlichAbsolut
|
|
|
sparBeitragMonatlichRelativ
|
|
|
tilgungsBeitragMonatlich
|
|
|
vertragsPartnerIds
|
|
|
verwendung
|
|
|
verwendungZulagen
|
|
|
zuteilungsDatum
|
|
Bausparvertrag
Name | Beschreibung | Typ |
---|---|---|
abschlussGebuehr
|
|
|
angebotsHinweisFuerAntragsteller
|
nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten |
|
bausparSumme
|
|
|
einmalzahlung
|
Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. |
|
gesamtLaufzeitInJahren
|
|
|
guthabenZins
|
|
|
id
|
|
|
produktAnbieter
|
|
|
sonderZahlungen
|
|
|
sparBeginn
|
Der berechnete Beginn des Besparens des Bausparvertrags. |
|
sparPhase
|
|
|
tarif
|
|
|
tarifId
|
Produktanbieter-spezifische Tarif-ID des Bauspartarifs |
|
tilgungsPhase
|
|
|
typ
|
|
|
vertragsBeginn
|
|
|
vertragsNummer
|
|
|
verwaltungsgebuehrenJaehrlich
|
|
|
zuteilungsDatum
|
|
BeleihungsRechnung
Name | Beschreibung | Typ |
---|---|---|
beleihungsAuslauf
|
Der Beleihungsauslauf aus Sicht des Produktanbieters. Berechnet sich aus dem Verhältnis anerkannter Darlehen zur Summe der anerkannten Beleihungswerte. |
|
beleihungsWerte
|
Enthält die vom Produktanbieter anerkannten Beleihungswerte |
|
beleihungsWerteSumme
|
Berechnungshilfe: Die Summe aller vom Produktanbieter anerkannten Beleihungswerte |
|
produktAnbieter
|
|
BeleihungsWert
Name | Beschreibung | Typ |
---|---|---|
adresse
|
|
|
beleihungsWert
|
|
|
immobilie
|
|
|
produktAnbieter
|
|
Beratung
Name | Beschreibung | Typ |
---|---|---|
art
|
|
|
hinweisFuerProduktAnbieter
|
|
|
istKundenBetreuerVerkaeuferOderMaklerDerImmobilie
|
Mit diesem Wert wird ausgedrückt, ob der Kundenbetreuer auch der Immobilienmakler ist. |
BerechnungsHilfeBetrag
Name | Beschreibung | Typ |
---|---|---|
betragNachFinanzierung
|
|
|
betragVorFinanzierung
|
|
Bereitstellung
Name | Beschreibung | Typ |
---|---|---|
bereitstellungsZins
|
|
|
bereitstellungsZinsFreieZeitInMonaten
|
|
Beschaeftigung
Name | Beschreibung | Typ |
---|---|---|
anzahlGehaelterProJahr
|
nur bei art==ANGESTELLTER,ARBEITER,BEAMTER |
|
arbeitgeber
|
nur bei art==ANGESTELLTER,ARBEITER,BEAMTER |
|
arbeitgeberInDeutschlandAnsaessig
|
nur bei art==ANGESTELLTER,ARBEITER,BEAMTER |
|
arbeitgeberLand
|
nur bei arbeitgeberInDeutschlandAnsaessig==false |
|
art
|
|
|
befristungsStatus
|
nur bei art==ANGESTELLTER,ARBEITER |
|
beruf
|
nur bei art!=RENTNER |
|
beschaeftigtSeit
|
nur bei art==ANGESTELLTER,ARBEITER,BEAMTER,FREIBERUFLER,SELBSTAENDIGER |
|
branche
|
Berufsgruppe des Antragstellers. |
|
einkommenNettoJaehrlich
|
nur bei art==FREIBERUFLER,SELBSTAENDIGER |
|
einkommenNettoMonatlich
|
nur bei art!=FREIBERUFLER,SELBSTAENDIGER |
|
firma
|
nur bei art==FREIBERUFLER,SELBSTAENDIGER |
|
inProbezeit
|
nur bei art==ANGESTELLTER,ARBEITER,BEAMTER |
|
situationNachRenteneintritt
|
nur bei art!=RENTNER |
|
taetigkeit
|
nur bei art==FREIBERUFLER,SELBSTAENDIGER |
BestehendeImmobilie
Name | Beschreibung | Typ |
---|---|---|
adresse
|
|
|
autostellplaetze
|
|
|
bestehendeDarlehen
|
|
|
bewirtschaftungsKostenJaehrlich
|
|
|
bezeichnung
|
|
|
bodenRichtwert
|
|
|
bundesland
|
|
|
effektivZinsErhoehendeKosten
|
|
|
einzusetzenderBetragBeiEinsatzAlsZusatzsicherheit
|
|
|
erbbaurecht
|
|
|
gebaeude
|
|
|
grundbuchAngabe
|
|
|
grundstueck
|
|
|
id
|
|
|
immobilienEinsatz
|
|
|
keinBaulandFlaecheInQm
|
|
|
keineBestehendenDarlehenVorhanden
|
|
|
marktueblicherKaufpreisProQm
|
|
|
marktwert
|
Nur relevant bei Finanzbedarf AnschlussFinanzierung, Modernisierung und Kapitalbeschaffung. |
|
maximalEinzusetzenderBetragWennVerkauf
|
|
|
objektArt
|
|
|
vergleichsmieteFuerGewerbeflaecheProQm
|
|
|
vergleichsmieteFuerWohnflaecheProQm
|
|
|
verkehrswert
|
Hat den selben Inhalt wie das Feld marktwert. (Wird in v3 nicht mehr enthalten sein) |
|
vorlaeufigerVerkehrswert
|
Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt. |
|
wohnlage
|
|
BestehenderBausparvertrag
Name | Beschreibung | Typ |
---|---|---|
abschlussGebuehr
|
|
|
aktuellerWert
|
|
|
bausparSumme
|
|
|
einmalzahlung
|
Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. |
|
ertrag
|
|
|
guthabenZins
|
|
|
id
|
|
|
maximalAufzuloesenderBetrag
|
|
|
produktAnbieter
|
|
|
sonderZahlungen
|
|
|
sparBeitragMonatlich
|
|
|
tarif
|
|
|
typ
|
|
|
vermoegensEinsatz
|
|
|
vermoegensTyp
|
Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium |
|
vertragsBeginn
|
|
|
vertragsNummer
|
|
|
verwaltungsgebuehrenJaehrlich
|
|
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
|
zukuenftigeEinnahmen
|
|
|
zuteilungsDatum
|
|
BestehendesDarlehen
Name | Beschreibung | Typ |
---|---|---|
abzuloesendeRestschuld
|
|
|
aktuelleRestschuldWennNichtAbzuloesen
|
|
|
darlehensArt
|
Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können. |
|
darlehensBetrag
|
|
|
darlehensGeber
|
|
|
darlehensKontonummer
|
|
|
eingetrageneGrundschuld
|
|
|
grundschuldArt
|
|
|
id
|
|
|
laufzeitEnde
|
|
|
rateMonatlich
|
|
|
sollZins
|
|
|
sondertilgungZumZinsBindungsEnde
|
für Prolongation, d.h. technisch: Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG |
|
zinsBindungEndetAm
|
|
BestehendesDarlehenDesFinanzierungsObjekts
Name | Beschreibung | Typ |
---|---|---|
abzuloesendeRestschuld
|
|
|
aktuelleRestschuldWennNichtAbzuloesen
|
|
|
darlehensArt
|
Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können. |
|
darlehensBetrag
|
|
|
darlehensGeber
|
|
|
darlehensKontonummer
|
|
|
eingetrageneGrundschuld
|
|
|
grundschuldArt
|
|
|
id
|
|
|
laufzeitEnde
|
|
|
rateMonatlich
|
|
|
sollZins
|
|
|
sondertilgungZumZinsBindungsEnde
|
für Prolongation, d.h. technisch: Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG |
|
verwendenAls
|
Beschreibt wie das Darlehen im Zusammenhang mit dem Vorhaben, behandelt werden soll. |
|
zinsBindungEndetAm
|
|
CharSequence
Name | Beschreibung | Typ |
---|
Darlehen
Name | Beschreibung | Typ |
---|---|---|
auszahlungsBetrag
|
|
|
auszahlungsDatum
|
nur bei darlehensTyp IN [FORWARD_DARLEHEN, ANNUITAETEN_DARLEHEN] |
|
auszahlungsKurs
|
|
|
bausparTarif
|
nur bei darlehensTyp==BAUSPAR_DARLEHEN |
|
bereitstellung
|
nicht bei darlehensTyp==PRIVAT_DARLEHEN |
|
darlehensBetrag
|
|
|
darlehensTyp
|
|
|
detailsZurVerwendung
|
nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG |
|
effektivZins
|
|
|
effektivZinsRelevanteKosten
|
|
|
forwardPeriodeInMonaten
|
nur bei darlehensTyp==FORWARD_DARLEHEN |
|
gesamtlaufzeitInMonaten
|
|
|
id
|
|
|
kfwEnergieEffizienzGruppe
|
nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261 (SANIERUNG).Es können auch weitere Werte zulässig werden. |
|
kfwEnergieEffizienzStandard
|
nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261, 297, 298 und 300 relevant. Bei neuen Energieeffizienzstandards können auch weitere Werte zulässig werden. |
|
kfwProgramm
|
nur bei darlehensTyp==KFW_DARLEHEN. Bei neu aufgelegten KfW-Programmen können auch weitere Werte zulässig werden. Folgende Programme sind aktiv: 124, 159, 261 (Sanierung), 297, 298 und 300 |
|
kfwSanierungsFahrplanLiegtVor
|
nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261 relevant. |
|
konditionWurdeManuellAngepasst
|
|
|
konditionsAnpassungsBegruendung
|
Begründung, wenn die Kondition angepasst wurde |
|
laufZeitInJahren
|
|
|
laufzeitInMonaten
|
nur bei darlehensTyp==PRIVAT_DARLEHEN. Deprecated. Aktuell ist die Information in gesamtlaufzeitInMonaten zu finden. |
|
maximaleLaufzeitInMonaten
|
nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG. Deprecated. Aktuell ist die Information in gesamtlaufzeitInMonaten zu finden. |
|
produktAnbieter
|
|
|
rateMonatlich
|
Die monatliche Rate in Euro |
|
rateMonatlichInDerTilgungsfreienAnlaufzeit
|
nur bei darlehensTyp IN [KFW_DARLEHEN, REGIONAL_FOERDER_DARLEHEN] |
|
regionalFoerderbankProgramm
|
nur bei darlehensTyp==REGIONAL_FOERDER_DARLEHEN. Bei neu aufgelegten Regional-Förderbank-Programmen können auch weitere Werte zulässig werden. Der Client muss daher mit unbekannten Werten umgehen können. |
|
riesterGefoerdert
|
|
|
sollZins
|
Der Sollzinssatz in Prozent |
|
tilgung
|
nicht bei darlehensTyp==ZWISCHEN_FINANZIERUNG |
|
tilgungsFreieAnlaufJahre
|
nur bei darlehensTyp IN [KFW_DARLEHEN, REGIONAL_FOERDER_DARLEHEN] |
|
vertragsPartnerIds
|
nur bei darlehensTyp==BAUSPAR_DARLEHEN |
|
verwendungszweck
|
nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG |
|
zinsBindung
|
nicht bei darlehensTyp IN [VARIABLES_DARLEHEN,ZWISCHEN_FINANZIERUNG] |
|
zinsZahlungsBeginnAm
|
|
DarlehensWunsch
Name | Beschreibung | Typ |
---|---|---|
annuitaetenDarlehen
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
bausparDarlehen
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
forwardDarlehen
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
id
|
|
|
kfwDarlehen
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
privatDarlehen
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
regionalFoerderDarlehen
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
variablesDarlehen
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
zwischenFinanzierung
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
Dokument
Name | Beschreibung | Typ |
---|---|---|
art
|
ist nicht immer vorhanden |
|
href
|
|
|
name
|
|
|
titel
|
Name des Dokuments |
|
type
|
|
EffektivZinsErhoehendeKosten
Name | Beschreibung | Typ |
---|---|---|
anpassen
|
|
|
grundbuchEintragungsKostenEinmalig
|
|
|
sonstigeKostenBezeichnung
|
|
|
sonstigeKostenEinmalig
|
|
|
wohnGebaeudeVersicherungsKostenJaehrlich
|
|
EffektivZinsKosten
Name | Beschreibung | Typ |
---|---|---|
beratungsHonorar
|
|
|
grundbuchKosten
|
|
|
sonstigeKosten
|
|
|
tilgungsErsatzProduktKosten
|
|
|
wohnGebaeudeVersicherungsKosten
|
|
|
zinsabsicherungsKosten
|
|
|
zusatzSicherheitsKosten
|
|
EinkuenfteAusNebentaetigkeit
Name | Beschreibung | Typ |
---|---|---|
beginnDerNebentaetigkeit
|
|
|
einnahmenMonatlich
|
|
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
EinnahmenMonatlich
Name | Beschreibung | Typ |
---|---|---|
einnahmenMonatlich
|
|
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
Name | Beschreibung | Typ |
---|
EnergieEffizienzAusweis
Name | Beschreibung | Typ |
---|---|---|
ausweisTyp
|
|
|
co2Emissionen
|
|
|
effizienzklasse
|
class of energy efficiency |
|
endEnergie
|
|
|
primaerEnergieTraeger
|
primary used energy carrier |
Entscheidungsreife
Name | Beschreibung | Typ |
---|---|---|
entscheidungsreifeVomVertriebSignalisiert |
Es wird nur 'true' zugelassen. Die API berücksichtigt Weiterentwicklungen ohne einen BreakingChange zu forcieren. |
Erbbaurecht
Name | Beschreibung | Typ |
---|---|---|
erbbaurecht
|
|
|
erbbauzinsJaehrlich
|
|
|
grundstuecksEigentuemer
|
|
|
laufzeitBisJahr
|
|
Error
Kommuniziert einen Fehler in der Antwort der API
Name | Beschreibung | Typ |
---|---|---|
message
|
|
|
statusCode
|
|
|
statusMessage
|
|
|
timestamp
|
|
|
traceId
|
|
Euro
Name | Beschreibung | Typ |
---|
EuropaceBausparAngebot
Name | Beschreibung | Typ |
---|---|---|
abschlussGebuehr
|
|
|
angebotsHinweisFuerAntragsteller
|
nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten |
|
bausparSumme
|
|
|
einmalzahlung
|
Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. |
|
gesamtLaufzeitInJahren
|
|
|
guthabenZins
|
|
|
id
|
|
|
produktAnbieter
|
|
|
sonderZahlungen
|
|
|
sparBeginn
|
Der berechnete Beginn des Besparens des Bausparvertrags. |
|
sparPhase
|
|
|
tarif
|
|
|
tarifId
|
Produktanbieter-spezifische Tarif-ID des Bauspartarifs |
|
tilgungsPhase
|
|
|
typ
|
|
|
vertragsBeginn
|
|
|
vertragsNummer
|
|
|
verwaltungsgebuehrenJaehrlich
|
|
|
zuteilungsDatum
|
|
Finanzbedarf
Name | Beschreibung | Typ |
---|---|---|
anzahlTeilzahlungen
|
Anzahl Teilzahlungen bei Neubau, Kauf vom Bauträger sowie Modernisierung |
|
aussenAnlagen
|
|
|
bauNebenkosten
|
|
|
beratungsHonorar
|
|
|
bereitsBeglichen
|
|
|
erschliessung
|
|
|
grunderwerbsteuer
|
Nebenkosten |
|
grundstueckBereitsBezahlt
|
|
|
grundstuecksKaufpreis
|
|
|
herstellung
|
inklusive Eigenleistungen |
|
kapitalBeschaffung
|
|
|
kapitalWirdBeschafft
|
|
|
kaufpreis
|
inklusive Eigenleistungen |
|
maklergebuehr
|
Nebenkosten |
|
mobiliar
|
|
|
modernisieren
|
|
|
modernisierung
|
inklusive Eigenleistungen |
|
notargebuehr
|
Nebenkosten |
|
renovierung
|
|
|
sonstigeKosten
|
|
|
zusaetzlichesKapital
|
|
FinanzierungsObjekt
Name | Beschreibung | Typ |
---|---|---|
adresse
|
|
|
autostellplaetze
|
|
|
bestehendeDarlehen
|
|
|
bewirtschaftungsKostenJaehrlich
|
|
|
bodenRichtwert
|
|
|
bundesland
|
|
|
effektivZinsErhoehendeKosten
|
|
|
erbbaurecht
|
|
|
gebaeude
|
|
|
grundbuchAngabe
|
|
|
grundstueck
|
|
|
id
|
|
|
keinBaulandFlaecheInQm
|
|
|
marktueblicherKaufpreisProQm
|
|
|
marktwert
|
Nur relevant bei Finanzbedarf AnschlussFinanzierung, Modernisierung und Kapitalbeschaffung. |
|
objektArt
|
|
|
vergleichsmieteFuerGewerbeflaecheProQm
|
|
|
vergleichsmieteFuerWohnflaecheProQm
|
|
|
verkehrswert
|
Hat den selben Inhalt wie das Feld marktwert. (Wird in v3 nicht mehr enthalten sein) |
|
vorlaeufigerVerkehrswert
|
Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt. |
|
wohnlage
|
|
FinanzierungsvorschlaegeResource
Name | Beschreibung | Typ |
---|---|---|
_links
|
|
|
finanzierungsvorschlaege
|
|
Finanzierungsvorschlag
Ein in BaufiSmart ausgehändigter Finanzierungsvorschlag.
Name | Beschreibung | Typ |
---|---|---|
_links
|
|
|
annahmeFrist
|
Die Annahmefrist des Angebots. |
|
bausparvertraege
|
Liste von allen Bausparverträgen, die Bestandteil dieses Finanzierungsvorschlags sind. |
|
beleihung
|
|
|
darlehen
|
Liste von allen Darlehen, die Bestandteil dieses Finanzierungsvorschlags sind. |
|
darlehensSumme
|
Die gesamte Darlehenssumme in Euro für alle im Finanzierungsvorschlag enthaltenen Darlehen. |
|
effektivZins
|
Aus allen Darlehens Effektivzinssätzen wird ein aggregierter Mischzins in Prozent ausgegeben. |
|
historie
|
Historie, in der für jedes Aushändigen, ein Eintrag mit Datum und Akteur ausgegeben wird. |
|
id
|
Id des Finanzierungsvorschlags |
|
machbarkeitsStatus
|
|
|
rateMonatlich
|
Die gesamte monatliche Rate in Euro. |
|
sollZins
|
Aus allen Darlehens Sollzinssätzen wird ein aggregierter Sollzins in Prozent ausgegeben. |
|
zinsBindung
|
Die Zinsbindung wird über alle Darlehen als Intervall in Jahren angegeben. |
FinanzierungsvorschlagHistorienEintrag
Wird ein Angebot als Finanzierungsvorschlag ausgehändigt, wird ein Eintrag in die Historie geschrieben.
Name | Beschreibung | Typ |
---|---|---|
akteur
|
|
|
erzeugtAm
|
|
Finanzierungswunsch
Name | Beschreibung | Typ |
---|---|---|
bausparWuensche
|
|
|
darlehensWuensche
|
|
|
id
|
|
Flaeche
Name | Beschreibung | Typ |
---|
Flurstueck
Name | Beschreibung | Typ |
---|---|---|
anteil
|
|
|
flur
|
|
|
flurstuecksNummer
|
|
|
groesse
|
|
ForwardDarlehensWunsch
Name | Beschreibung | Typ |
---|---|---|
auszahlungsDatum
|
Bitte 'auszahlungsZeitpunkt' verwenden |
|
auszahlungsZeitpunkt
|
|
|
bereitstellungsZinsFreieZeitInMonaten
|
|
|
darlehensBetrag
|
|
|
provision
|
|
|
sondertilgungOptionalJaehrlich
|
|
|
tilgungsWunsch
|
|
|
zinsBindungInJahren
|
|
Gebaeude
Name | Beschreibung | Typ |
---|---|---|
anzahlDerGewerbeeinheiten
|
|
|
anzahlDerWohneinheitenImGebaeude
|
|
|
anzahlVollgeschosse
|
|
|
aufbauFinanzierung
|
|
|
aufzugVorhanden
|
|
|
ausstattung
|
|
|
baujahr
|
Baujahr des Gebäudes. Bei Verwendungszweck != NEUBAU 2016 |
|
bauweise
|
|
|
bezeichnungWohneinheit
|
|
|
dachgeschossAusbau
|
|
|
denkmalschutz
|
|
|
einliegerwohnungVorhanden
|
|
|
energieEffizienzAusweis
|
|
|
geschossLage
|
|
|
gewerbeflaeche
|
|
|
hausAnordnung
|
|
|
hausTyp
|
|
|
istFertighaus
|
|
|
kellerausbau
|
|
|
kubatur
|
|
|
miteigentumsAnteil
|
|
|
modernisierungsAngaben
|
|
|
unterkellerung
|
|
|
wohnflaeche
|
|
|
zustand
|
|
GebaeudeFlaeche
Name | Beschreibung | Typ |
---|---|---|
gesamtGroesse
|
|
|
vermietungsInformationen
|
|
GrundbuchAngabe
Name | Beschreibung | Typ |
---|---|---|
amtsgericht
|
Bezirk/Bezeichnung des zuständigen Amtsgerichts |
|
anmerkungen
|
|
|
bandUndBlatt
|
Angabe von Band und Blatt |
|
flurstuecke
|
|
|
ort
|
Ort des als Grundbuchamt zuständigen Amtsgerichts |
|
rechteInAbteilung2
|
Belastungen und Beschränkungen in der Nutzbarkeit des Grundstücks. Leitungsrechte, Verzichte auf Abstandsflächen, Wegerechte, Insolvenzvermerke. |
Haushalt
Name | Beschreibung | Typ |
---|---|---|
antragsteller
|
|
|
anzahlErwachseneImHaushalt
|
|
|
anzahlKinderNichtImHaushalt
|
|
|
bestehendeImmobilien
|
|
|
erfahrungImmobilienFinanzierung
|
|
|
id
|
|
|
kfzAnzahl
|
|
|
kinder
|
|
|
lebenshaltungsKostenMonatlich
|
|
|
obligo
|
Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt. |
|
positionen
|
|
HaushaltsPositionen
Name | Beschreibung | Typ |
---|---|---|
bankUndSparguthaben
|
|
|
bausparvertraege
|
|
|
ehegattenUnterhalt
|
|
|
einkuenfteAusNebentaetigkeit
|
|
|
kindergeld
|
Read-Only-Feld. Wird dynamisch aus den Angaben zu den Kindern berechnet. Pro kindergelderhaltendem Kind ein Listenelement. |
|
lebensUndRentenVersicherungen
|
|
|
mietAusgaben
|
|
|
privateDarlehen
|
|
|
privateKrankenversicherung
|
|
|
ratenkredite
|
|
|
sonstigeAusgaben
|
|
|
sonstigeEinnahmen
|
|
|
sonstigeVerbindlichkeiten
|
|
|
sonstigeVermoegen
|
|
|
sparplaene
|
|
|
unbefristeteZusatzRenten
|
|
|
unterhaltsVerpflichtungen
|
|
|
variableEinkuenfte
|
|
|
versicherungsAusgaben
|
|
|
wertpapiere
|
|
IsoCountryCode
Name | Beschreibung | Typ |
---|
Jahreszahl
Name | Beschreibung | Typ |
---|
KfwDarlehensWunsch
Name | Beschreibung | Typ |
---|---|---|
darlehensBetrag
|
|
|
kfwEndfaellig
|
Für endfällige KfW-Darlehen wird die Quelle des Tilgungswunsches erfasst |
|
kfwEnergieEffizienzGruppe
|
Nur bei Programm 153, 261. Der Client muss mit unbekannten Werten umgehen können. |
|
kfwEnergieEffizienzStandard
|
Nur bei Programm 153, 261. Wenn die KfW-Bank neue Standards anerkennt, sind die entsprechenden neuen Ausprägungen zulässig. Der Client muss daher mit unbekannten Werten umgehen können. |
|
kfwProgramm
|
Bei neu aufgelegten KfW-Programmen können auch weitere Werte zulässig werden. Der Client muss daher mit unbekannten Werten umgehen können. |
|
kfwSanierungsFahrplanLiegtVor
|
Nur bei Programm 261. |
|
laufzeitInJahren
|
|
|
provision
|
|
|
tilgungsWunsch
|
Für endfällige KfW-Darlehen wird ein Tilgungswunsch erfasst |
|
tilgungsfreieAnlaufjahre
|
Erlaubt ist 1, 2, 3, 4, 5. Maximalwert abhängig von der Laufzeit. Wenn der Tilgungswunsch ausgesetzt ist, dann ist auch 10 erlaubt. |
|
zinsBindungInJahren
|
Programm 124: 5 oder 10, sonst: 10 oder 20 |
Kind
Name | Beschreibung | Typ |
---|---|---|
geburtsdatum
|
|
|
id
|
|
|
kindergeldWirdBezogen
|
|
|
name
|
|
|
unterhaltsEinnahmenBetragMonatlich
|
|
LeadTracking
Name | Beschreibung | Typ |
---|---|---|
kampagne
|
|
|
keyword
|
|
|
kundenBetreuerBenachrichtigen
|
|
|
trackingId
|
|
LebensOderRentenversicherungVermoegen
Name | Beschreibung | Typ |
---|---|---|
id
|
|
|
maximalAufzuloesenderBetrag
|
|
|
praemieMonatlich
|
|
|
rueckkaufsWertAktuell
|
|
|
tarif
|
|
|
typ
|
|
|
vermoegensEinsatz
|
|
|
vermoegensTyp
|
Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium |
|
versicherungsGesellschaft
|
|
|
versicherungsSumme
|
|
|
vertragsBeginn
|
|
|
vertragsEnde
|
|
|
vertragsNummer
|
|
|
verwaltungsgebuehrenJaehrlich
|
|
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
LegitimationsDaten
Name | Beschreibung | Typ |
---|---|---|
ausstellendeBehoerde
|
|
|
ausstellungsdatum
|
|
|
ausweisArt
|
|
|
ausweisArtBeiAndererAusweis
|
Nur wenn ausweisArt = ANDERE |
|
ausweisNummer
|
|
Link
Name | Beschreibung | Typ |
---|---|---|
deprecation
|
|
|
href
|
|
|
hreflang
|
|
|
name
|
|
|
profile
|
|
|
templated
|
|
|
title
|
|
|
type
|
|
Links
Name | Beschreibung | Typ |
---|
LocalDate
Name | Beschreibung | Typ |
---|
MediaType
Name | Beschreibung | Typ |
---|
Meldung
Name | Beschreibung | Typ |
---|---|---|
kategorie
|
Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können. |
|
kreditEntscheider
|
|
|
produktAnbieter
|
|
|
text
|
|
MietAusgaben
Name | Beschreibung | Typ |
---|---|---|
ausgabenMonatlich
|
|
|
berechnungsHilfeVermoegen
|
|
|
entfallenMitFinanzierung
|
|
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
ModernisierungsAngaben
Name | Beschreibung | Typ |
---|---|---|
badWc
|
|
|
bodenWandTreppe
|
|
|
dach
|
|
|
fenster
|
|
|
heizungZentral
|
|
|
modernisierungsGrad
|
|
|
modernisierungsJahr
|
|
|
raumaufteilung
|
|
|
stromAbwasserHeizkoerper
|
|
|
waermedaemmung
|
|
|
wurdeModernisiert
|
|
NachrangigesExternesDarlehen
Name | Beschreibung | Typ |
---|---|---|
darlehensBetrag
|
|
|
darlehensGeber
|
Der Name des externen Darlehensgebers (Firmierung). Es gibt keine entsprechende Beziehung zu einem Partner auf der Europace-Plattform. |
|
id
|
|
|
laufzeitEnde
|
Wenn die Laufzeit bei einem externen Darlehen angegeben wurde, dann ist das Feld gesetzt. |
|
rateMonatlich
|
|
|
typ
|
Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können. |
|
zinsBindung
|
|
Partner
Name | Beschreibung | Typ |
---|---|---|
anrede
|
|
|
anschrift
|
|
|
email
|
|
|
externePartnerId
|
|
|
externerKreditSachbearbeiterId
|
|
|
fax
|
|
|
firmenNameZusatz
|
|
|
firmierung
|
|
|
geburtsdatum
|
|
|
id
|
|
|
kreditsachbearbeiter
|
|
|
mobilTelefon
|
|
|
nachname
|
|
|
partnerId
|
|
|
telefonnummer
|
|
|
vertriebsOrganisation
|
|
|
vorname
|
|
|
webseite
|
|
PartnerId
Name | Beschreibung | Typ |
---|
PatchOperation
A JSONPatch document as defined by RFC 6902 (see http://jsonpatch.com/). Beispiel: { "op": "replace", "path": "/antraege/ABC123/1/1/status", "value": {"antragsteller": "BEANTRAGT", "produktAnbieter":"UNTERSCHRIEBEN"}}
Name | Beschreibung | Typ |
---|---|---|
from
|
|
|
op |
executed operation |
|
path |
JSON-Path in Antrag. Valid Paths: /status, /antraege/{vorgangsnummer}/{antragnummer}/{teilantragnummer}/status, /externeVorgangsNummer,/kundenBetreuer/partnerId, /vorgangsBearbeiter/partnerId |
|
value |
Value to be set or replaced. Allows: string, number or JSON object |
Postadresse
Name | Beschreibung | Typ |
---|---|---|
hausnummer
|
|
|
ort
|
|
|
postleitzahl
|
|
|
strasse
|
|
Praeferenzen
Name | Beschreibung | Typ |
---|---|---|
tilgungssatzwechselPraeferenz
|
|
PrivatDarlehensWunsch
Name | Beschreibung | Typ |
---|---|---|
darlehensBetrag
|
|
|
laufzeitInMonaten
|
|
|
provision
|
|
ProduktAnbieter
Name | Beschreibung | Typ |
---|---|---|
anrede
|
|
|
anschrift
|
|
|
email
|
|
|
externePartnerId
|
|
|
externerKreditSachbearbeiterId
|
|
|
fax
|
|
|
firmenNameZusatz
|
|
|
firmierung
|
|
|
geburtsdatum
|
|
|
id
|
|
|
kreditsachbearbeiter
|
|
|
mobilTelefon
|
|
|
nachname
|
|
|
partnerId
|
|
|
produktAnbieterId
|
|
|
telefonnummer
|
|
|
vertriebsOrganisation
|
|
|
vorname
|
|
|
webseite
|
|
Prozent
Name | Beschreibung | Typ |
---|
PruefungVorhandenerAbsicherung
Name | Beschreibung | Typ |
---|---|---|
finanzierungsRisiko
|
|
|
istAusreichendeAbsicherungVorhanden
|
|
|
zusaetzlicheKommentare
|
|
RechteAbteilung2
Name | Beschreibung | Typ |
---|---|---|
beschreibung
|
|
|
betrag
|
|
|
vorhanden
|
|
RegionalFoerderDarlehensWunsch
Name | Beschreibung | Typ |
---|---|---|
darlehensBetrag
|
|
|
laufzeitInJahren
|
Erlaubt sind 10, 20, 25 oder 30 Jahre je nach Regional-Förderbank-Programm. Bei weiteren Förderbankprogrammen können auch andere Werte zulässig sein. |
|
provision
|
|
|
regionalFoerderbankProgramm
|
Bei neu aufgelegten Regional-Förderbank-Programmen können auch weitere Werte zulässig werden. Der Client muss daher mit unbekannten Werten umgehen können. |
|
tilgungsfreieAnlaufjahre
|
Erlaubt sind 1, 2, 3, 4 oder 5 Jahre. Der Maximalwert ist abhängig von der Laufzeit. |
|
zinsBindungInJahren
|
Erlaubt sind 10, 20, 25 oder 30 Jahre je nach Regional-Förderbank-Programm. Bei weiteren Förderbankprogrammen können auch andere Werte zulässig sein. |
RisikoAbsicherung
Name | Beschreibung | Typ |
---|---|---|
abgesichertesRisiko
|
|
|
auszahlungsBetrag
|
|
|
auszahlungsTurnus
|
|
|
praemienAnteil
|
|
RisikoAbsicherungsWunsch
Name | Beschreibung | Typ |
---|---|---|
abzusicherndesRisiko
|
|
|
versicherteRate
|
nur bei abzusicherndesRisiko==ARBEITSUNFAEHIGKEIT,ARBEITSLOSIGKEIT |
|
versicherungsSumme
|
nur bei abzusicherndesRisiko==TODESFALL |
SchufaErgebnis
Name | Beschreibung | Typ |
---|---|---|
antragstellerUnbekannt
|
Der Antragsteller ist bei der Schufa unbekannt. |
|
inManuellerNachbehandlung
|
Die Ermittlung des Schufa-Scores verzögert sich, wenn sich die Anfrage bei der Schufa in manueller Nachbehandlung befindet. |
|
score
|
|
SelfRelAndEreignisse
Name | Beschreibung | Typ |
---|---|---|
antraege
|
|
|
ereignisse
|
|
|
finanzierungsvorschlaege
|
|
|
gemerkteAngebote
|
|
|
self
|
|
SituationNachRenteneintritt
Name | Beschreibung | Typ |
---|---|---|
gesetzlicheRenteMonatlich
|
|
|
privateRenteMonatlich
|
|
|
rentenBeginn
|
|
|
sonstigesEinkommenMonatlich
|
|
SonderZahlung
Name | Beschreibung | Typ |
---|---|---|
anzahl
|
Gesamtanzahl der Zahlungen |
|
betrag
|
Betrag in EUR über die Höhe der einzelnen Zahlung |
|
termin
|
Termin der Einmalzahlung (optional) oder Beginn der regelmäßigen Zahlungen |
|
zahlweise
|
Festlegung von einmaligen oder regelmäßigen Zahlungen |
SparPhase
Name | Beschreibung | Typ |
---|---|---|
guthabenBeiZuteilung
|
|
|
sparBeitragMonatlich
|
|
|
sparPhaseInJahren
|
|
Sparplaene
Name | Beschreibung | Typ |
---|---|---|
aktuellerWert
|
|
|
beitragMonatlich
|
|
|
ertrag
|
|
|
maximalAufzuloesenderWert
|
|
|
vermoegensEinsatz
|
|
|
vermoegensTyp
|
Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium |
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
|
zukuenftigeEinnahmen
|
|
Staat
Name | Beschreibung | Typ |
---|---|---|
isoCountryCode
|
ISO 3166-1 alpha-2 code |
|
name
|
|
StatusDTO
Name | Beschreibung | Typ |
---|---|---|
antragsteller |
|
|
antragstellerAblehnungsgrund
|
|
|
kommentar
|
|
|
produktAnbieter |
|
|
produktanbieterAblehnungsgrund
|
|
Tilgung
Name | Beschreibung | Typ |
---|---|---|
anfaenglicheTilgung
|
wenn null oder 0: tilgungsausgesetzt |
|
sonderTilgungJaehrlich
|
nur wenn darlehensArt IN [ANNUITAETEN_DARLEHEN,FORWARD_DARLEHEN] und KEIN tilgungsErsatz |
|
tilgungsBeginnAm
|
nullable |
|
tilgungsErsatz
|
nicht bei PRIVAT_DARLEHEN |
TilgungsErsatz
Name | Beschreibung | Typ |
---|---|---|
id
|
Id des Tilgungsersatzproduktes, das in den Vermögenswerten des Haushalts oder in den Bausparangeboten des Angebotes zu finden ist. |
|
typ
|
Menschenlesbarer Hinweis auf den Typ, z.B. BAUSPARVERTRAG oder KAPITALBILDENDE_LEBENSVERSICHERUNG |
TilgungsPhase
Name | Beschreibung | Typ |
---|---|---|
bausparDarlehenSumme
|
|
|
sollZinsNachZuteilung
|
|
|
tilgungsBeitragMonatlich
|
|
|
tilgungsPhaseInJahren
|
|
TilgungsWunsch
Name | Beschreibung | Typ |
---|---|---|
anfaenglicheTilgung
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
ausgesetztBerechnet
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
ausgesetztEigenesAngebot
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
bausparWunsch
|
|
|
rate
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
|
tilgungsBeginn
|
|
|
tilgungsErsatzProduktId
|
|
|
volltilgerWennAnnuitaetenOderForward
|
muss leer sein, wenn eines der anderen Attribute gefüllt ist |
TilgungssatzwechselPraeferenz
Name | Beschreibung | Typ |
---|---|---|
mindestensBenoetigt
|
|
|
tilgungsSatzwechselPraeferenz
|
|
|
zusaetzlicherKommentar
|
|
URI
Name | Beschreibung | Typ |
---|
VariablesDarlehensWunsch
Name | Beschreibung | Typ |
---|---|---|
darlehensBetrag
|
|
|
provision
|
|
|
tilgungsWunsch
|
|
Verbindlichkeit
Name | Beschreibung | Typ |
---|---|---|
glaeubiger
|
|
|
laufzeitEnde
|
|
|
rateMonatlich
|
|
|
restschuld
|
|
|
vermoegensTyp
|
Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium |
|
wirdAbgeloest
|
|
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
VermietungsInformationen
Name | Beschreibung | Typ |
---|---|---|
mieteinnahmenNettoKaltMonatlich
|
|
|
nutzungsArt
|
|
|
vermieteteFlaeche
|
|
Vermoegen
Name | Beschreibung | Typ |
---|---|---|
aktuellerWert
|
|
|
ertrag
|
|
|
maximalAufzuloesenderWert
|
|
|
vermoegensEinsatz
|
|
|
vermoegensTyp
|
Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium |
|
zukuenftigeEinnahmen
|
|
VermoegenVerbindlichkeit
Name | Beschreibung | Typ |
---|---|---|
aktuellerWert
|
|
|
anrechnungFuerBlankoAnteil
|
|
|
bezeichner
|
|
|
kontonummer
|
|
|
vermoegensTyp
|
|
VermoegenVerbindlichkeiten
Name | Beschreibung | Typ |
---|---|---|
vermoegenOderVerbindlichkeiten
|
|
VersicherungsWunsch
Name | Beschreibung | Typ |
---|---|---|
finanzierungsWeise
|
nur bei praemienZahlungsweise==EINMALIG |
|
id
|
|
|
praemienZahlungsweise
|
|
|
risikoAbsicherungsWuensche
|
|
|
versichertePersonId
|
|
|
versicherungsArt
|
|
|
versicherungsBeginn
|
|
|
versicherungsDauerInMonaten
|
|
VersicherungsZeitraum
Name | Beschreibung | Typ |
---|---|---|
beginn
|
|
|
dauerInMonaten
|
|
|
ende
|
|
VertriebsOrganisation
Name | Beschreibung | Typ |
---|---|---|
firma
|
|
|
name
|
|
|
vertriebsOrganisationsId
|
|
VorgaengeResourceListItem
Name | Beschreibung | Typ |
---|---|---|
_links
|
|
|
datenKontext
|
|
|
externeVorgangsNummer
|
|
|
letzteAenderung
|
|
|
letztesEreignis
|
|
|
vorgangsNummer
|
|
Vorgang
Name | Beschreibung | Typ |
---|---|---|
_links
|
|
|
antraege
|
|
|
archivierung
|
|
|
aufbewahrungBis
|
Datum, bis wann dieser Vorgang nach DSGVO aufbewahrt werden muss. Nach diesem Datum wird der Vorgang automatisch gelöscht. |
|
bankverbindung
|
|
|
datenKontext
|
|
|
erstelltAm
|
|
|
externeVorgangsNummer
|
|
|
finanzierungsObjekt
|
|
|
geschlossenAm
|
|
|
haushalte
|
|
|
importQuelle
|
|
|
kundenBetreuer
|
|
|
leadTracking
|
|
|
letztesEreignis
|
|
|
phase
|
|
|
praeferenzen
|
|
|
prioritaet
|
Priorität des Vorgangs, Werte: [NIEDRIG,NEUTRAL,HOCH] |
|
status
|
Status des Vorgangs, Werte: [AKTIV,ARCHIVIERT] |
|
tippGeber
|
|
|
vorgangsBearbeiter
|
|
|
vorgangsNummer
|
|
|
vorhaben
|
|
Vorhaben
Name | Beschreibung | Typ |
---|---|---|
absicherungswunsch
|
|
|
eigenleistungWennNeubauOderModernisierungsmassnahmen
|
|
|
energieEffizienzklasse
|
class of energy efficiency |
|
externeBausparAngebote
|
|
|
finanzbedarf
|
|
|
finanzierungswunsch
|
|
|
geplanteEnergie
|
|
|
geplanterCo2Wert
|
|
|
id
|
|
|
nachfinanzierung
|
|
|
nachrangigeExterneDarlehen
|
|
|
verwendungszweck
|
|
Wertpapiere
Name | Beschreibung | Typ |
---|---|---|
aktuellerWert
|
|
|
dividendenJaehrlich
|
|
|
ertrag
|
|
|
maximalAufzuloesenderWert
|
|
|
vermoegensEinsatz
|
|
|
vermoegensTyp
|
Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium |
|
zahlungsTyp
|
Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium |
|
zukuenftigeEinnahmen
|
|
ZinsBindung
Name | Beschreibung | Typ |
---|---|---|
endetAm
|
|
|
jahre
|
|
|
monate
|
|
|
restschuldNachZinsBindungsEnde
|
|
ZonedDateTime
Name | Beschreibung | Typ |
---|
ZugrundeliegendeDatenZumAntrag
Name | Beschreibung | Typ |
---|---|---|
_links
|
|
|
bankverbindung
|
|
|
finanzierungsObjekt
|
|
|
haushalte
|
|
|
vorhaben
|
|