Ü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 : https://www.europace2.de

URI Schema

Host : https://baufinanzierung.api.europace.de
Basis-Pfad : /
Schemata : HTTPS

Sicherheit

oauth2

Typ : oauth2

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

vorgangsNummer
required
Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.

String
null
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

Sicherheit
Typ Name Scopes

oauth2

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

vorgangsNummer
required
Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.

String
null

finanzierungsvorschlagId
required
Die Id des Finanzierungsvorschlags.

String
null
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

Vorgaenge

Schreibt eine Nachricht an den Vorgang in BaufiSmart (addNachricht)

post /v3/vorgaenge/{vorgangsNummer}/nachricht
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

vorgangsNummer
required

String
null

Nachricht
required

Nachricht
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

Alle Anträge zum Vorgang (getAllVorgangsAntraege)

get /v3/vorgaenge/{vorgangsNummer}/antraege
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

vorgangsNummer
required

String
null
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

Ein spezifischer Antrag des Vorgangs (getAntrag)

get /v3/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}/{teilantragsNummer}
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

vorgangsNummer
required

String
null

antragsNummer
required

Integer
null

teilantragsNummer
required

Integer
null
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

Sicherheit
Typ Name Scopes

oauth2

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

vorgangsNummer
required
Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.

String
null
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

Sicherheit
Typ Name Scopes

oauth2

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

vorgangsNummer
required
Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.

String
null

finanzierungsvorschlagId
required
Die Id des Finanzierungsvorschlags.

String
null
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

Sicherheit
Typ Name Scopes

oauth2

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

vorgangsNummer
required

String
null
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

alle sichtbaren Vorgänge (getVorgaenge)

get /v3/vorgaenge
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

datenKontext
optional
Datenkontext

String
null

aenderungSeit
optional
Der 'aenderungSeit' Parameter hat das 'ISO 8601' Format. Beispiele: '2020-07-10', '2020-07-10T13:00Z'

String
null

aenderungBis
optional
Der 'aenderungBis' Parameter hat das 'ISO 8601' Format. Beispiele: '2020-07-10', '2020-07-10T14:00Z'

String
null

sort
optional
Sortierung der Vorgänge, aufsteigend oder absteigend

String
absteigend

page
optional

Integer
0

limit
optional

Integer
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

Sicherheit
Typ Name Scopes

oauth2

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

vorgangsNummer
required
Nummer des Vorgangs

String
null
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

Anträge zum Vorgang (getVorgangsAntraege)

get /v3/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

vorgangsNummer
required

String
null

antragsNummer
required

Integer
null
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

Sicherheit
Typ Name Scopes

oauth2

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

vorgangsNummer
required

String
null
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

(putVorgangsBearbeiterId)

put /v3/vorgaenge/{vorgangsNummer}/vorgangsBearbeiter
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

vorgangsNummer
required

String
null

PartnerDTO
required

PartnerDTO
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

Zum Setzen des Antragsstatus (setAntragsStatus)

post /v3/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}/{teilantragsNummer}/status
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

vorgangsNummer
required

String
null

antragsNummer
required

Integer
null

teilantragsNummer
required

Integer
null

StatusDTO
required

StatusDTO
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

Sicherheit
Typ Name Scopes

oauth2

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

vorgangsNummer
required

String
null

antragsNummer
required

Integer
null

teilantragsNummer
required

Integer
null

Entscheidungsreife
required

Entscheidungsreife
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

Den Kundenbetreuer ändern (updateKundenBetreuer)

put /v3/vorgaenge/{vorgangsNummer}/kundenBetreuer
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

vorgangsNummer
required

String
null

PartnerDTO
required

PartnerDTO
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

Sicherheit
Typ Name Scopes

oauth2

oauth2

Änderung von Metadaten an einem bestehenden Vorgang (updateVorgang)

patch /v3/vorgaenge/{vorgangsNummer}
Beschreibung

Parameter
Typ Name Beschreibung Typ Standard

vorgangsNummer
required

String
null

PatchOperation
required

PatchOperation
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

Sicherheit
Typ Name Scopes

oauth2

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
optional

gesamtPraemie
optional

praemienZahlungsweise
optional

tarifBezeichnung
optional

tarifKennung
optional

versichertePersonId
optional

versicherungsArt
optional

versicherungsNummer
optional

versicherungsZeitraum
optional

AbsicherungsAngaben

Name Beschreibung Typ

betraegtWoechentlicheArbeitsZeitMindestens15Stunden
optional

pruefungVorhandenerAbsicherungen
optional

Absicherungswunsch

Name Beschreibung Typ

id
optional

versicherungsWuensche
optional

Angebot

Name Beschreibung Typ

_links
optional

absicherungen
optional

bausparvertraege
optional

beleihungsRechnung
optional

bewertungDesAngebots
optional

darlehen
optional

erzeugtAm
optional

Erzeugungsdatum des Angebots

kennung
optional

machbarkeitsStatus
optional

meldungen
optional

nummerAmVorgang
optional

Nummer des gemerkten Angebotes eines Vorgangs.

pruefungsErgebnisse
optional

zahlungsplaene
optional

Link zu den Zahlungsplänen des Angebots.

AngebotsPruefungsErgebnis

Name Beschreibung Typ

produktAnbieter
optional

weitereAngaben
optional

Vom Produktanbieter bei der Angebotsprüfung ergänzte Daten. Das Format entspricht der Definition des Produktanbieters.

AnnuitaetenDarlehensWunsch

Name Beschreibung Typ

auszahlungsDatum
optional

Bitte 'auszahlungsZeitpunkt' verwenden

auszahlungsZeitpunkt
optional

bereitstellungsZinsFreieZeitInMonaten
optional

darlehensBetrag
optional

provision
optional

riesterFoerderung
optional

riesterGefoerdertePerson
optional

sondertilgungOptionalJaehrlich
optional

tilgungsWunsch
optional

zinsBindungInJahren
optional

Antraege

Name Beschreibung Typ

_links
optional

antraege
optional

Antrag

Diese Resource repräsentiert einen Antrag in Baufi Smart.

Name Beschreibung Typ

_links
optional

angebot
optional

Das angenommene Angebot, auf dem dieser Antrag basiert

ansprechpartner
optional

antragsNummer
optional

Nummer des Antrags auf der Europace Plattform

antragsReferenzen
optional

Referenzen am Antrag, die durch den Produktanbieter gesetzt wurden

beratung
optional

Informationen zum Geschäftsabschluss

datenKontext
optional

Gibt an, ob es sich um einen Antrag aus dem Testmodus oder Echtgeschäft handelt

dokumente
optional

Enthält alle Plattformdokumente, freigegebene Dokumente des Vertriebs, sowie die hochgeladenen Dokumente des Produktanbieters. Aktuell sind nur Selbstauskunft und Kreditentscheidungsinformation enthalten.

kreditSachbearbeiter
optional

produktAnbieter
optional

status
optional

Bearbeitungsfortschritt des Antrags

vermittler
optional

Partner auf Seite des Vertriebs

zeitpunktDerAnnahme
optional

Zeitpunkt, zu dem der Antrag im System erstellt wurde.

zugrundeliegendeDaten
optional

Basisdaten des Kunden, die für die Berechnung des Angebots relevant waren

AntragsStatus

Name Beschreibung Typ

antragsteller
optional

Willenserklärung des Antragstellers

antragstellerAblehnungsgrund
optional

Ablehnungsgrund des Antragstellers

bearbeitungsFortschritt
optional

Bearbeitungsfortschritt des Antrags nach beidseitiger Unterzeichnung

produktAnbieter
optional

Willenserklärung des Produktanbieters

produktanbieterAblehnungsgrund
optional

Ablehnungsgrund des Produktanbieters

Antragsteller

Name Beschreibung Typ

absicherungsAngaben
optional

anrede
optional

anschrift
optional

arbeitserlaubnis
optional

wenn keine deutsche Staatsangehörigkeit

arbeitserlaubnisBefristetBis
optional

wenn Arbeitserlaubnis befristet

aufenthaltsTitel
optional

wenn keine deutsche Staatsangehörigkeit

aufenthaltsTitelBefristetBis
optional

wenn Aufenthaltstitel befristet

beschaeftigung
optional

bruttoJahresEinkommenErwartet
optional

bruttoVorjahresEinkommen
optional

dritteStaatsangehoerigkeit
optional

email
optional

Eine valide Emailadresse

externeAntragstellerId
optional

familienstand
optional

geburtsdatum
optional

geburtsland
optional

geburtsort
optional

guetertrennungVereinbartWennVerheiratet
optional

nur wenn verheiratet

id
optional

inDeutschlandSeit
optional

wenn keine deutsche Staatsangehörigkeit

legitimationsDaten
optional

nachname
optional

privateKrankenversicherungMonatlicheAusgaben
optional

schufaErgebnis
optional

sozialversicherungsnummer
optional

staatsangehoerigkeit
optional

steuerId
optional

telefonnummer
optional

telefonnummerVorwahl
optional

titel
optional

titelDoktor
optional

titelProfessor
optional

vorAnschrift
optional

vorname
optional

weitereKontaktMoeglichkeiten
optional

wohnhaftSeit
optional

zweiteStaatsangehoerigkeit
optional

Archivierung

Name Beschreibung Typ

grund
optional

kommentar
optional

AusgabenMonatlich

Name Beschreibung Typ

ausgabenMonatlich
optional

berechnungsHilfeVermoegen
optional

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

Autostellplatz

Name Beschreibung Typ

mieteinnahmenMonatlich
optional

typ
optional

vermietet
optional

BankUndSparguthaben

Name Beschreibung Typ

aktuellerWert
optional

ertrag
optional

maximalAufzuloesenderWert
optional

vermoegensEinsatz
optional

vermoegensTyp
optional

Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

zinsertragJaehrlich
optional

zukuenftigeEinnahmen
optional

Bankverbindung

Name Beschreibung Typ

bic
optional

iban
optional

id
optional

kontoinhaberIds
optional

kontoinhaberName
optional

kreditinstitut
optional

BausparAngebot

Name Beschreibung Typ

abschlussGebuehr
optional

angebotsHinweisFuerAntragsteller
optional

nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten

bausparSumme
optional

einmalzahlung
optional

Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen.

guthabenZins
optional

id
optional

produktAnbieter
optional

sonderZahlungen
optional

sparBeginn
optional

Der berechnete Beginn des Besparens des Bausparvertrags.

sparPhase
optional

tarif
optional

tilgungsPhase
optional

typ
optional

vertragsBeginn
optional

vertragsNummer
optional

verwaltungsgebuehrenJaehrlich
optional

zuteilungsDatum
optional

BausparDarlehensWunsch

Name Beschreibung Typ

bausparGuthaben
optional

bausparSumme
optional

bausparTarif
optional

darlehensBetrag
optional

provision
optional

tilgungsBeitragMonatlich
optional

vertragsNummer
optional

vertragsPartnerIds
optional

zuteilungsAnnahme
optional

BausparTarif

Name Beschreibung Typ

id
optional

kurzName
optional

langName
optional

produktAnbieter
optional

riesterFoerderung
optional

status
optional

BausparWunsch

Von den Feldern bausparSummeAbsolut, bausparSummeRelativ, sparBeitragMonatlichAbsolut, sparBeitragMonatlichRelativ, tilgungsBeitragMonatlich, zuteilungsDatum und sparBeginn können maximal drei befüllt sein.

Name Beschreibung Typ

abschlussGebuehrenVerrechnung
optional

bausparSummeAbsolut
optional

bausparSummeRelativ
optional

bausparTarif
optional

bausparTarife
optional

Deprecated, Zukünftig sind die Informationen zum gewünschen Tarif unter bausparTarif zu finden.

id
optional

riesterFoerderung
optional

sonderZahlungEinmalig
optional

Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen.

sonderZahlungen
optional

sparBeginn
optional

Der Beginn des Besparens des Bausparvertrags ist frei festlegbar.

sparBeitragMonatlichAbsolut
optional

sparBeitragMonatlichRelativ
optional

tilgungsBeitragMonatlich
optional

vertragsPartnerIds
optional

verwendung
optional

verwendungZulagen
optional

zuteilungsDatum
optional

Bausparvertrag

Name Beschreibung Typ

abschlussGebuehr
optional

angebotsHinweisFuerAntragsteller
optional

nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten

bausparSumme
optional

einmalzahlung
optional

Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen.

gesamtLaufzeitInJahren
optional

guthabenZins
optional

id
optional

produktAnbieter
optional

sonderZahlungen
optional

sparBeginn
optional

Der berechnete Beginn des Besparens des Bausparvertrags.

sparPhase
optional

tarif
optional

tarifId
optional

Produktanbieter-spezifische Tarif-ID des Bauspartarifs

tilgungsPhase
optional

typ
optional

vertragsBeginn
optional

vertragsNummer
optional

verwaltungsgebuehrenJaehrlich
optional

zuteilungsDatum
optional

BeleihungsRechnung

Name Beschreibung Typ

beleihungsAuslauf
optional

Der Beleihungsauslauf aus Sicht des Produktanbieters. Berechnet sich aus dem Verhältnis anerkannter Darlehen zur Summe der anerkannten Beleihungswerte.

beleihungsWerte
optional

Enthält die vom Produktanbieter anerkannten Beleihungswerte

beleihungsWerteSumme
optional

Berechnungshilfe: Die Summe aller vom Produktanbieter anerkannten Beleihungswerte

produktAnbieter
optional

BeleihungsWert

Name Beschreibung Typ

adresse
optional

beleihungsWert
optional

immobilie
optional

produktAnbieter
optional

Beratung

Name Beschreibung Typ

art
optional

hinweisFuerProduktAnbieter
optional

istKundenBetreuerVerkaeuferOderMaklerDerImmobilie
optional

Mit diesem Wert wird ausgedrückt, ob der Kundenbetreuer auch der Immobilienmakler ist.

BerechnungsHilfeBetrag

Name Beschreibung Typ

betragNachFinanzierung
optional

betragVorFinanzierung
optional

Bereitstellung

Name Beschreibung Typ

bereitstellungsZins
optional

bereitstellungsZinsFreieZeitInMonaten
optional

Beschaeftigung

Name Beschreibung Typ

anzahlGehaelterProJahr
optional

nur bei art==ANGESTELLTER,ARBEITER,BEAMTER

arbeitgeber
optional

nur bei art==ANGESTELLTER,ARBEITER,BEAMTER

arbeitgeberInDeutschlandAnsaessig
optional

nur bei art==ANGESTELLTER,ARBEITER,BEAMTER

arbeitgeberLand
optional

nur bei arbeitgeberInDeutschlandAnsaessig==false

art
optional

befristungsStatus
optional

nur bei art==ANGESTELLTER,ARBEITER

beruf
optional

nur bei art!=RENTNER

beschaeftigtSeit
optional

nur bei art==ANGESTELLTER,ARBEITER,BEAMTER,FREIBERUFLER,SELBSTAENDIGER

branche
optional

Berufsgruppe des Antragstellers.

einkommenNettoJaehrlich
optional

nur bei art==FREIBERUFLER,SELBSTAENDIGER

einkommenNettoMonatlich
optional

nur bei art!=FREIBERUFLER,SELBSTAENDIGER

firma
optional

nur bei art==FREIBERUFLER,SELBSTAENDIGER

inProbezeit
optional

nur bei art==ANGESTELLTER,ARBEITER,BEAMTER

situationNachRenteneintritt
optional

nur bei art!=RENTNER

taetigkeit
optional

nur bei art==FREIBERUFLER,SELBSTAENDIGER

BestehendeImmobilie

Name Beschreibung Typ

adresse
optional

autostellplaetze
optional

bestehendeDarlehen
optional

bewirtschaftungsKostenJaehrlich
optional

bezeichnung
optional

bodenRichtwert
optional

bundesland
optional

effektivZinsErhoehendeKosten
optional

einzusetzenderBetragBeiEinsatzAlsZusatzsicherheit
optional

erbbaurecht
optional

gebaeude
optional

grundbuchAngabe
optional

grundstueck
optional

id
optional

immobilienEinsatz
optional

keinBaulandFlaecheInQm
optional

keineBestehendenDarlehenVorhanden
optional

marktueblicherKaufpreisProQm
optional

marktwert
optional

Nur relevant bei Finanzbedarf AnschlussFinanzierung, Modernisierung und Kapitalbeschaffung.

maximalEinzusetzenderBetragWennVerkauf
optional

objektArt
optional

vergleichsmieteFuerGewerbeflaecheProQm
optional

vergleichsmieteFuerWohnflaecheProQm
optional

verkehrswert
optional

Hat den selben Inhalt wie das Feld marktwert. (Wird in v3 nicht mehr enthalten sein)

vorlaeufigerVerkehrswert
optional

Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt.

wohnlage
optional

BestehenderBausparvertrag

Name Beschreibung Typ

abschlussGebuehr
optional

aktuellerWert
optional

bausparSumme
optional

einmalzahlung
optional

Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen.

ertrag
optional

guthabenZins
optional

id
optional

maximalAufzuloesenderBetrag
optional

produktAnbieter
optional

sonderZahlungen
optional

sparBeitragMonatlich
optional

tarif
optional

typ
optional

vermoegensEinsatz
optional

vermoegensTyp
optional

Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium

vertragsBeginn
optional

vertragsNummer
optional

verwaltungsgebuehrenJaehrlich
optional

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

zukuenftigeEinnahmen
optional

zuteilungsDatum
optional

BestehendesDarlehen

Name Beschreibung Typ

abzuloesendeRestschuld
optional

aktuelleRestschuldWennNichtAbzuloesen
optional

darlehensArt
optional

Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können.

darlehensBetrag
optional

darlehensGeber
optional

darlehensKontonummer
optional

eingetrageneGrundschuld
optional

grundschuldArt
optional

id
optional

laufzeitEnde
optional

rateMonatlich
optional

sollZins
optional

sondertilgungZumZinsBindungsEnde
optional

für Prolongation, d.h. technisch: Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG

zinsBindungEndetAm
optional

BestehendesDarlehenDesFinanzierungsObjekts

Name Beschreibung Typ

abzuloesendeRestschuld
optional

aktuelleRestschuldWennNichtAbzuloesen
optional

darlehensArt
optional

Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können.

darlehensBetrag
optional

darlehensGeber
optional

darlehensKontonummer
optional

eingetrageneGrundschuld
optional

grundschuldArt
optional

id
optional

laufzeitEnde
optional

rateMonatlich
optional

sollZins
optional

sondertilgungZumZinsBindungsEnde
optional

für Prolongation, d.h. technisch: Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG

verwendenAls
optional

Beschreibt wie das Darlehen im Zusammenhang mit dem Vorhaben, behandelt werden soll.

zinsBindungEndetAm
optional

Darlehen

Name Beschreibung Typ

auszahlungsBetrag
optional

auszahlungsDatum
optional

nur bei darlehensTyp IN [FORWARD_DARLEHEN, ANNUITAETEN_DARLEHEN]

auszahlungsKurs
optional

bausparTarif
optional

nur bei darlehensTyp==BAUSPAR_DARLEHEN

bereitstellung
optional

nicht bei darlehensTyp==PRIVAT_DARLEHEN

darlehensBetrag
optional

darlehensTyp
optional

detailsZurVerwendung
optional

nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG

effektivZins
optional

effektivZinsRelevanteKosten
optional

forwardPeriodeInMonaten
optional

nur bei darlehensTyp==FORWARD_DARLEHEN

gesamtlaufzeitInMonaten
optional

id
optional

kfwEnergieEffizienzGruppe
optional

nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261 (SANIERUNG).Es können auch weitere Werte zulässig werden.

kfwEnergieEffizienzStandard
optional

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
optional

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
optional

nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261 relevant.

konditionWurdeManuellAngepasst
optional

konditionsAnpassungsBegruendung
optional

Begründung, wenn die Kondition angepasst wurde

laufZeitInJahren
optional

laufzeitInMonaten
optional

nur bei darlehensTyp==PRIVAT_DARLEHEN. Deprecated. Aktuell ist die Information in gesamtlaufzeitInMonaten zu finden.

maximaleLaufzeitInMonaten
optional

nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG. Deprecated. Aktuell ist die Information in gesamtlaufzeitInMonaten zu finden.

produktAnbieter
optional

rateMonatlich
optional

Die monatliche Rate in Euro

rateMonatlichInDerTilgungsfreienAnlaufzeit
optional

nur bei darlehensTyp IN [KFW_DARLEHEN, REGIONAL_FOERDER_DARLEHEN]

regionalFoerderbankProgramm
optional

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
optional

sollZins
optional

Der Sollzinssatz in Prozent

tilgung
optional

nicht bei darlehensTyp==ZWISCHEN_FINANZIERUNG

tilgungsFreieAnlaufJahre
optional

nur bei darlehensTyp IN [KFW_DARLEHEN, REGIONAL_FOERDER_DARLEHEN]

vertragsPartnerIds
optional

nur bei darlehensTyp==BAUSPAR_DARLEHEN

verwendungszweck
optional

nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG

zinsBindung
optional

nicht bei darlehensTyp IN [VARIABLES_DARLEHEN,ZWISCHEN_FINANZIERUNG]

zinsZahlungsBeginnAm
optional

DarlehensWunsch

Name Beschreibung Typ

annuitaetenDarlehen
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

bausparDarlehen
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

forwardDarlehen
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

id
optional

kfwDarlehen
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

privatDarlehen
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

regionalFoerderDarlehen
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

variablesDarlehen
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

zwischenFinanzierung
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

Dokument

Name Beschreibung Typ

art
optional

ist nicht immer vorhanden

href
optional

name
optional

titel
optional

Name des Dokuments

type
optional

EffektivZinsErhoehendeKosten

Name Beschreibung Typ

anpassen
optional

grundbuchEintragungsKostenEinmalig
optional

sonstigeKostenBezeichnung
optional

sonstigeKostenEinmalig
optional

wohnGebaeudeVersicherungsKostenJaehrlich
optional

EffektivZinsKosten

Name Beschreibung Typ

beratungsHonorar
optional

grundbuchKosten
optional

sonstigeKosten
optional

tilgungsErsatzProduktKosten
optional

wohnGebaeudeVersicherungsKosten
optional

zinsabsicherungsKosten
optional

zusatzSicherheitsKosten
optional

EinkuenfteAusNebentaetigkeit

Name Beschreibung Typ

beginnDerNebentaetigkeit
optional

einnahmenMonatlich
optional

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

EinnahmenMonatlich

Name Beschreibung Typ

einnahmenMonatlich
optional

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

EnergieEffizienzAusweis

Name Beschreibung Typ

ausweisTyp
optional

co2Emissionen
optional

effizienzklasse
optional

class of energy efficiency

endEnergie
optional

primaerEnergieTraeger
optional

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
optional

erbbauzinsJaehrlich
optional

grundstuecksEigentuemer
optional

laufzeitBisJahr
optional

Error

Kommuniziert einen Fehler in der Antwort der API

Name Beschreibung Typ

message
optional

statusCode
optional

statusMessage
optional

timestamp
optional

traceId
optional

EuropaceBausparAngebot

Name Beschreibung Typ

abschlussGebuehr
optional

angebotsHinweisFuerAntragsteller
optional

nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten

bausparSumme
optional

einmalzahlung
optional

Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen.

gesamtLaufzeitInJahren
optional

guthabenZins
optional

id
optional

produktAnbieter
optional

sonderZahlungen
optional

sparBeginn
optional

Der berechnete Beginn des Besparens des Bausparvertrags.

sparPhase
optional

tarif
optional

tarifId
optional

Produktanbieter-spezifische Tarif-ID des Bauspartarifs

tilgungsPhase
optional

typ
optional

vertragsBeginn
optional

vertragsNummer
optional

verwaltungsgebuehrenJaehrlich
optional

zuteilungsDatum
optional

Finanzbedarf

Name Beschreibung Typ

anzahlTeilzahlungen
optional

Anzahl Teilzahlungen bei Neubau, Kauf vom Bauträger sowie Modernisierung

aussenAnlagen
optional

bauNebenkosten
optional

beratungsHonorar
optional

bereitsBeglichen
optional

erschliessung
optional

grunderwerbsteuer
optional

Nebenkosten

grundstueckBereitsBezahlt
optional

grundstuecksKaufpreis
optional

herstellung
optional

inklusive Eigenleistungen

kapitalBeschaffung
optional

kapitalWirdBeschafft
optional

kaufpreis
optional

inklusive Eigenleistungen

maklergebuehr
optional

Nebenkosten

mobiliar
optional

modernisieren
optional

modernisierung
optional

inklusive Eigenleistungen

notargebuehr
optional

Nebenkosten

renovierung
optional

sonstigeKosten
optional

zusaetzlichesKapital
optional

FinanzierungsObjekt

Name Beschreibung Typ

adresse
optional

autostellplaetze
optional

bestehendeDarlehen
optional

bewirtschaftungsKostenJaehrlich
optional

bodenRichtwert
optional

bundesland
optional

effektivZinsErhoehendeKosten
optional

erbbaurecht
optional

gebaeude
optional

grundbuchAngabe
optional

grundstueck
optional

id
optional

keinBaulandFlaecheInQm
optional

marktueblicherKaufpreisProQm
optional

marktwert
optional

Nur relevant bei Finanzbedarf AnschlussFinanzierung, Modernisierung und Kapitalbeschaffung.

objektArt
optional

vergleichsmieteFuerGewerbeflaecheProQm
optional

vergleichsmieteFuerWohnflaecheProQm
optional

verkehrswert
optional

Hat den selben Inhalt wie das Feld marktwert. (Wird in v3 nicht mehr enthalten sein)

vorlaeufigerVerkehrswert
optional

Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt.

wohnlage
optional

FinanzierungsvorschlaegeResource

Name Beschreibung Typ

_links
optional

finanzierungsvorschlaege
optional

Finanzierungsvorschlag

Ein in BaufiSmart ausgehändigter Finanzierungsvorschlag.

Name Beschreibung Typ

_links
optional

annahmeFrist
optional

Die Annahmefrist des Angebots.

bausparvertraege
optional

Liste von allen Bausparverträgen, die Bestandteil dieses Finanzierungsvorschlags sind.

beleihung
optional

darlehen
optional

Liste von allen Darlehen, die Bestandteil dieses Finanzierungsvorschlags sind.

darlehensSumme
optional

Die gesamte Darlehenssumme in Euro für alle im Finanzierungsvorschlag enthaltenen Darlehen.

effektivZins
optional

Aus allen Darlehens Effektivzinssätzen wird ein aggregierter Mischzins in Prozent ausgegeben.

historie
optional

Historie, in der für jedes Aushändigen, ein Eintrag mit Datum und Akteur ausgegeben wird.

id
optional

Id des Finanzierungsvorschlags

machbarkeitsStatus
optional

rateMonatlich
optional

Die gesamte monatliche Rate in Euro.

sollZins
optional

Aus allen Darlehens Sollzinssätzen wird ein aggregierter Sollzins in Prozent ausgegeben.

zinsBindung
optional

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
optional

erzeugtAm
optional

Finanzierungswunsch

Name Beschreibung Typ

bausparWuensche
optional

darlehensWuensche
optional

id
optional

Flurstueck

Name Beschreibung Typ

anteil
optional

flur
optional

flurstuecksNummer
optional

groesse
optional

ForwardDarlehensWunsch

Name Beschreibung Typ

auszahlungsDatum
optional

Bitte 'auszahlungsZeitpunkt' verwenden

auszahlungsZeitpunkt
optional

bereitstellungsZinsFreieZeitInMonaten
optional

darlehensBetrag
optional

provision
optional

sondertilgungOptionalJaehrlich
optional

tilgungsWunsch
optional

zinsBindungInJahren
optional

Gebaeude

Name Beschreibung Typ

anzahlDerGewerbeeinheiten
optional

anzahlDerWohneinheitenImGebaeude
optional

anzahlVollgeschosse
optional

aufbauFinanzierung
optional

aufzugVorhanden
optional

ausstattung
optional

baujahr
optional

Baujahr des Gebäudes. Bei Verwendungszweck != NEUBAU 2016

bauweise
optional

bezeichnungWohneinheit
optional

dachgeschossAusbau
optional

denkmalschutz
optional

einliegerwohnungVorhanden
optional

energieEffizienzAusweis
optional

geschossLage
optional

gewerbeflaeche
optional

hausAnordnung
optional

hausTyp
optional

istFertighaus
optional

kellerausbau
optional

kubatur
optional

miteigentumsAnteil
optional

modernisierungsAngaben
optional

unterkellerung
optional

wohnflaeche
optional

zustand
optional

GebaeudeFlaeche

Name Beschreibung Typ

gesamtGroesse
optional

vermietungsInformationen
optional

GirokontoPraeferenz

Name Beschreibung Typ

bestehendeKontoverbindungBei
optional

kontowechselWirdBeabsichtigt
optional

GrundbuchAngabe

Name Beschreibung Typ

amtsgericht
optional

Bezirk/Bezeichnung des zuständigen Amtsgerichts

anmerkungen
optional

bandUndBlatt
optional

Angabe von Band und Blatt

flurstuecke
optional

ort
optional

Ort des als Grundbuchamt zuständigen Amtsgerichts

rechteInAbteilung2
optional

Belastungen und Beschränkungen in der Nutzbarkeit des Grundstücks. Leitungsrechte, Verzichte auf Abstandsflächen, Wegerechte, Insolvenzvermerke.

Grundstueck

Name Beschreibung Typ

groesse
optional

grundstuecksArt
optional

Haushalt

Name Beschreibung Typ

antragsteller
optional

anzahlErwachseneImHaushalt
optional

anzahlKinderNichtImHaushalt
optional

bestehendeImmobilien
optional

erfahrungImmobilienFinanzierung
optional

id
optional

kfzAnzahl
optional

kfzKostenMonatlich
optional

kinder
optional

lebenshaltungsKostenMonatlich
optional

obligo
optional

Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt.

positionen
optional

HaushaltsPositionen

Name Beschreibung Typ

bankUndSparguthaben
optional

bausparvertraege
optional

ehegattenUnterhalt
optional

einkuenfteAusNebentaetigkeit
optional

kindergeld
optional

Read-Only-Feld. Wird dynamisch aus den Angaben zu den Kindern berechnet. Pro kindergelderhaltendem Kind ein Listenelement.

lebensUndRentenVersicherungen
optional

mietAusgaben
optional

privateDarlehen
optional

privateKrankenversicherung
optional

ratenkredite
optional

sonstigeAusgaben
optional

sonstigeEinnahmen
optional

sonstigeVerbindlichkeiten
optional

sonstigeVermoegen
optional

sparplaene
optional

unbefristeteZusatzRenten
optional

unterhaltsVerpflichtungen
optional

variableEinkuenfte
optional

versicherungsAusgaben
optional

wertpapiere
optional

ImmobilieVerknuepfung

Name Beschreibung Typ

id
optional

KfwDarlehensWunsch

Name Beschreibung Typ

darlehensBetrag
optional

kfwEndfaellig
optional

Für endfällige KfW-Darlehen wird die Quelle des Tilgungswunsches erfasst

kfwEnergieEffizienzGruppe
optional

Nur bei Programm 153, 261. Der Client muss mit unbekannten Werten umgehen können.

kfwEnergieEffizienzStandard
optional

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
optional

Bei neu aufgelegten KfW-Programmen können auch weitere Werte zulässig werden. Der Client muss daher mit unbekannten Werten umgehen können.

kfwSanierungsFahrplanLiegtVor
optional

Nur bei Programm 261.

laufzeitInJahren
optional

provision
optional

tilgungsWunsch
optional

Für endfällige KfW-Darlehen wird ein Tilgungswunsch erfasst

tilgungsfreieAnlaufjahre
optional

Erlaubt ist 1, 2, 3, 4, 5. Maximalwert abhängig von der Laufzeit. Wenn der Tilgungswunsch ausgesetzt ist, dann ist auch 10 erlaubt.

zinsBindungInJahren
optional

Programm 124: 5 oder 10, sonst: 10 oder 20

Kind

Name Beschreibung Typ

geburtsdatum
optional

id
optional

kindergeldWirdBezogen
optional

name
optional

unterhaltsEinnahmenBetragMonatlich
optional

LeadTracking

Name Beschreibung Typ

kampagne
optional

keyword
optional

kundenBetreuerBenachrichtigen
optional

trackingId
optional

LebensOderRentenversicherungVermoegen

Name Beschreibung Typ

id
optional

maximalAufzuloesenderBetrag
optional

praemieMonatlich
optional

rueckkaufsWertAktuell
optional

tarif
optional

typ
optional

vermoegensEinsatz
optional

vermoegensTyp
optional

Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium

versicherungsGesellschaft
optional

versicherungsSumme
optional

vertragsBeginn
optional

vertragsEnde
optional

vertragsNummer
optional

verwaltungsgebuehrenJaehrlich
optional

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

LegitimationsDaten

Name Beschreibung Typ

ausstellendeBehoerde
optional

ausstellungsdatum
optional

ausweisArt
optional

ausweisArtBeiAndererAusweis
optional

Nur wenn ausweisArt = ANDERE

ausweisNummer
optional

Link

Name Beschreibung Typ

deprecation
optional

href
optional

hreflang
optional

name
optional

profile
optional

templated
optional

title
optional

type
optional

Meldung

Name Beschreibung Typ

kategorie
optional

Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können.

kreditEntscheider
optional

produktAnbieter
optional

text
optional

MietAusgaben

Name Beschreibung Typ

ausgabenMonatlich
optional

berechnungsHilfeVermoegen
optional

entfallenMitFinanzierung
optional

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

MiteigentumsAnteil

Name Beschreibung Typ

anteil
optional

gesamt
optional

ModernisierungsAngaben

Name Beschreibung Typ

badWc
optional

bodenWandTreppe
optional

dach
optional

fenster
optional

heizungZentral
optional

modernisierungsGrad
optional

modernisierungsJahr
optional

raumaufteilung
optional

stromAbwasserHeizkoerper
optional

waermedaemmung
optional

wurdeModernisiert
optional

NachrangigesExternesDarlehen

Name Beschreibung Typ

darlehensBetrag
optional

darlehensGeber
optional

Der Name des externen Darlehensgebers (Firmierung). Es gibt keine entsprechende Beziehung zu einem Partner auf der Europace-Plattform.

id
optional

laufzeitEnde
optional

Wenn die Laufzeit bei einem externen Darlehen angegeben wurde, dann ist das Feld gesetzt.

rateMonatlich
optional

typ
optional

Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können.

zinsBindung
optional

Nachricht

Name Beschreibung Typ

text

Inhalt der Nachricht

PaginationLinks

Name Beschreibung Typ

next
optional

prev
optional

self
optional

Partner

Name Beschreibung Typ

anrede
optional

anschrift
optional

email
optional

externePartnerId
optional

externerKreditSachbearbeiterId
optional

fax
optional

firmenNameZusatz
optional

firmierung
optional

geburtsdatum
optional

id
optional

kreditsachbearbeiter
optional

mobilTelefon
optional

nachname
optional

partnerId
optional

telefonnummer
optional

vertriebsOrganisation
optional

vorname
optional

webseite
optional

PartnerDTO

Name Beschreibung Typ

partnerId

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
optional

op

executed operation

path

JSON-Path in Antrag. Valid Paths: /status, /antraege/{vorgangsnummer}/{antragnummer}/{teilantragnummer}/status, /externeVorgangsNummer,/kundenBetreuer/partnerId, /vorgangsBearbeiter/partnerId

value

Postadresse

Name Beschreibung Typ

hausnummer
optional

ort
optional

postleitzahl
optional

strasse
optional

Praeferenzen

Name Beschreibung Typ

girokonto
optional

tilgungssatzwechselPraeferenz
optional

PrivatDarlehensWunsch

Name Beschreibung Typ

darlehensBetrag
optional

laufzeitInMonaten
optional

provision
optional

ProduktAnbieter

Name Beschreibung Typ

anrede
optional

anschrift
optional

email
optional

externePartnerId
optional

externerKreditSachbearbeiterId
optional

fax
optional

firmenNameZusatz
optional

firmierung
optional

geburtsdatum
optional

id
optional

kreditsachbearbeiter
optional

mobilTelefon
optional

nachname
optional

partnerId
optional

produktAnbieterId
optional

telefonnummer
optional

vertriebsOrganisation
optional

vorname
optional

webseite
optional

PruefungVorhandenerAbsicherung

Name Beschreibung Typ

finanzierungsRisiko
optional

istAusreichendeAbsicherungVorhanden
optional

zusaetzlicheKommentare
optional

RechteAbteilung2

Name Beschreibung Typ

beschreibung
optional

betrag
optional

vorhanden
optional

RegionalFoerderDarlehensWunsch

Name Beschreibung Typ

darlehensBetrag
optional

laufzeitInJahren
optional

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
optional

regionalFoerderbankProgramm
optional

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
optional

Erlaubt sind 1, 2, 3, 4 oder 5 Jahre. Der Maximalwert ist abhängig von der Laufzeit.

zinsBindungInJahren
optional

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
optional

auszahlungsBetrag
optional

auszahlungsTurnus
optional

praemienAnteil
optional

RisikoAbsicherungsWunsch

Name Beschreibung Typ

abzusicherndesRisiko
optional

versicherteRate
optional

nur bei abzusicherndesRisiko==ARBEITSUNFAEHIGKEIT,ARBEITSLOSIGKEIT

versicherungsSumme
optional

nur bei abzusicherndesRisiko==TODESFALL

SchufaErgebnis

Name Beschreibung Typ

antragstellerUnbekannt
optional

Der Antragsteller ist bei der Schufa unbekannt.

inManuellerNachbehandlung
optional

Die Ermittlung des Schufa-Scores verzögert sich, wenn sich die Anfrage bei der Schufa in manueller Nachbehandlung befindet.

score
optional

SelfRelAndEreignisse

Name Beschreibung Typ

antraege
optional

ereignisse
optional

finanzierungsvorschlaege
optional

gemerkteAngebote
optional

self
optional

SituationNachRenteneintritt

Name Beschreibung Typ

gesetzlicheRenteMonatlich
optional

privateRenteMonatlich
optional

rentenBeginn
optional

sonstigesEinkommenMonatlich
optional

SonderZahlung

Name Beschreibung Typ

anzahl
optional

Gesamtanzahl der Zahlungen

betrag
optional

Betrag in EUR über die Höhe der einzelnen Zahlung

termin
optional

Termin der Einmalzahlung (optional) oder Beginn der regelmäßigen Zahlungen

zahlweise
optional

Festlegung von einmaligen oder regelmäßigen Zahlungen

SparPhase

Name Beschreibung Typ

guthabenBeiZuteilung
optional

sparBeitragMonatlich
optional

sparPhaseInJahren
optional

Sparplaene

Name Beschreibung Typ

aktuellerWert
optional

beitragMonatlich
optional

ertrag
optional

maximalAufzuloesenderWert
optional

vermoegensEinsatz
optional

vermoegensTyp
optional

Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

zukuenftigeEinnahmen
optional

Staat

Name Beschreibung Typ

isoCountryCode
optional

ISO 3166-1 alpha-2 code

name
optional

StatusDTO

Name Beschreibung Typ

antragsteller

antragstellerAblehnungsgrund
optional

kommentar
optional

produktAnbieter

produktanbieterAblehnungsgrund
optional

Tilgung

Name Beschreibung Typ

anfaenglicheTilgung
optional

wenn null oder 0: tilgungsausgesetzt

sonderTilgungJaehrlich
optional

nur wenn darlehensArt IN [ANNUITAETEN_DARLEHEN,FORWARD_DARLEHEN] und KEIN tilgungsErsatz

tilgungsBeginnAm
optional

nullable

tilgungsErsatz
optional

nicht bei PRIVAT_DARLEHEN

TilgungsErsatz

Name Beschreibung Typ

id
optional

Id des Tilgungsersatzproduktes, das in den Vermögenswerten des Haushalts oder in den Bausparangeboten des Angebotes zu finden ist.

typ
optional

Menschenlesbarer Hinweis auf den Typ, z.B. BAUSPARVERTRAG oder KAPITALBILDENDE_LEBENSVERSICHERUNG

TilgungsPhase

Name Beschreibung Typ

bausparDarlehenSumme
optional

sollZinsNachZuteilung
optional

tilgungsBeitragMonatlich
optional

tilgungsPhaseInJahren
optional

TilgungsWunsch

Name Beschreibung Typ

anfaenglicheTilgung
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

ausgesetztBerechnet
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

ausgesetztEigenesAngebot
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

bausparWunsch
optional

rate
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

tilgungsBeginn
optional

tilgungsErsatzProduktId
optional

volltilgerWennAnnuitaetenOderForward
optional

muss leer sein, wenn eines der anderen Attribute gefüllt ist

TilgungssatzwechselPraeferenz

Name Beschreibung Typ

mindestensBenoetigt
optional

tilgungsSatzwechselPraeferenz
optional

zusaetzlicherKommentar
optional

VariablesDarlehensWunsch

Name Beschreibung Typ

darlehensBetrag
optional

provision
optional

tilgungsWunsch
optional

Verbindlichkeit

Name Beschreibung Typ

glaeubiger
optional

laufzeitEnde
optional

rateMonatlich
optional

restschuld
optional

vermoegensTyp
optional

Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium

wirdAbgeloest
optional

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

VermietungsInformationen

Name Beschreibung Typ

mieteinnahmenNettoKaltMonatlich
optional

nutzungsArt
optional

vermieteteFlaeche
optional

Vermoegen

Name Beschreibung Typ

aktuellerWert
optional

ertrag
optional

maximalAufzuloesenderWert
optional

vermoegensEinsatz
optional

vermoegensTyp
optional

Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium

zukuenftigeEinnahmen
optional

VermoegenVerbindlichkeit

Name Beschreibung Typ

aktuellerWert
optional

anrechnungFuerBlankoAnteil
optional

bezeichner
optional

kontonummer
optional

vermoegensTyp
optional

VermoegenVerbindlichkeiten

Name Beschreibung Typ

vermoegenOderVerbindlichkeiten
optional

VersicherungsWunsch

Name Beschreibung Typ

finanzierungsWeise
optional

nur bei praemienZahlungsweise==EINMALIG

id
optional

praemienZahlungsweise
optional

risikoAbsicherungsWuensche
optional

versichertePersonId
optional

versicherungsArt
optional

versicherungsBeginn
optional

versicherungsDauerInMonaten
optional

VersicherungsZeitraum

Name Beschreibung Typ

beginn
optional

dauerInMonaten
optional

ende
optional

VertriebsOrganisation

Name Beschreibung Typ

firma
optional

name
optional

vertriebsOrganisationsId
optional

Vorgaenge

Name Beschreibung Typ

_links
optional

vorgaenge
optional

VorgaengeResourceListItem

Name Beschreibung Typ

_links
optional

datenKontext
optional

externeVorgangsNummer
optional

letzteAenderung
optional

letztesEreignis
optional

vorgangsNummer
optional

Vorgang

Name Beschreibung Typ

_links
optional

antraege
optional

archivierung
optional

aufbewahrungBis
optional

Datum, bis wann dieser Vorgang nach DSGVO aufbewahrt werden muss. Nach diesem Datum wird der Vorgang automatisch gelöscht.

bankverbindung
optional

datenKontext
optional

erstelltAm
optional

externeVorgangsNummer
optional

finanzierungsObjekt
optional

geschlossenAm
optional

haushalte
optional

importQuelle
optional

kundenBetreuer
optional

leadTracking
optional

letztesEreignis
optional

phase
optional

praeferenzen
optional

prioritaet
optional

Priorität des Vorgangs, Werte: [NIEDRIG,NEUTRAL,HOCH]

status
optional

Status des Vorgangs, Werte: [AKTIV,ARCHIVIERT]

tippGeber
optional

vorgangsBearbeiter
optional

vorgangsNummer
optional

vorhaben
optional

Vorhaben

Name Beschreibung Typ

absicherungswunsch
optional

eigenleistungWennNeubauOderModernisierungsmassnahmen
optional

energieEffizienzklasse
optional

class of energy efficiency

externeBausparAngebote
optional

finanzbedarf
optional

finanzierungswunsch
optional

geplanteEnergie
optional

geplanterCo2Wert
optional

id
optional

nachfinanzierung
optional

nachrangigeExterneDarlehen
optional

verwendungszweck
optional

Wertpapiere

Name Beschreibung Typ

aktuellerWert
optional

dividendenJaehrlich
optional

ertrag
optional

maximalAufzuloesenderWert
optional

vermoegensEinsatz
optional

vermoegensTyp
optional

Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium

zahlungsTyp
optional

Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium

zukuenftigeEinnahmen
optional

ZinsBindung

Name Beschreibung Typ

endetAm
optional

jahre
optional

monate
optional

restschuldNachZinsBindungsEnde
optional

ZugrundeliegendeDatenZumAntrag

Name Beschreibung Typ

_links
optional

bankverbindung
optional

finanzierungsObjekt
optional

haushalte
optional

vorhaben
optional

ZwischenFinanzierungsWunsch

Name Beschreibung Typ

darlehensBetrag
optional

detailsZurVerwendung
optional

maximaleLaufzeitInMonaten
optional

provision
optional

verwendungszweck
optional