--- swagger: "2.0" info: description: Mit dieser API können die Vorgänge aus der Europace Plattform ausgelesen werden. version: "2.37" title: Vorgänge API contact: name: Europace AG url: www.europace2.de email: helpdesk@europace2.de host: baufismart.api.europace.de basePath: / tags: - name: Vorgänge description: Dieser Endpunkt repräsentiert die Vertriebssicht. schemes: - https consumes: - application/json produces: - application/json;charset=UTF-8 paths: /v2/vorgaenge: get: tags: - Vorgänge summary: alle sichtbaren Vorgänge operationId: getVorgaenge produces: - application/json parameters: - name: aenderungBis in: query description: "Der 'aenderungBis' Parameter hat das 'ISO 8601' Format. Beispiele: '2020-07-10', '2020-07-10T14:00Z'" required: false type: string pattern: "^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" - name: aenderungSeit in: query description: "Der 'aenderungSeit' Parameter hat das 'ISO 8601' Format. Beispiele: '2020-07-10', '2020-07-10T13:00Z'" required: false type: string pattern: "^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" - name: datenKontext in: query description: Datenkontext required: false type: string default: ECHT_GESCHAEFT enum: - ECHT_GESCHAEFT - TEST_MODUS - name: limit in: query description: limit required: false type: integer default: 10 format: int32 - name: page in: query description: page required: false type: integer default: 0 format: int32 - name: sort in: query description: "Sortierung der Vorgänge, aufsteigend oder absteigend" required: false type: string default: absteigend responses: "200": description: OK schema: $ref: '#/definitions/Vorgaenge' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}: get: tags: - Vorgänge summary: einen Vorgang abrufen description: "Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde." operationId: getVorgang produces: - application/json parameters: - name: vorgangsNummer in: path description: Nummer des Vorgangs required: true type: string x-example: AB1234 responses: "200": description: OK schema: $ref: '#/definitions/Vorgang' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API patch: tags: - Vorgänge summary: Änderung von Metadaten an einem bestehenden Vorgang operationId: updateVorgang consumes: - application/json-patch+json produces: - application/json parameters: - in: body name: patchOperations description: patchOperations required: true schema: type: array items: $ref: '#/definitions/PatchOperation' example: "[{\"op\": \"replace\", \"path\": \"/kundenBetreuer/partnerId\",\"value\": \"OEJ16\"}]" - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/Vorgang' "204": description: No Content "401": description: Unauthorized "403": description: Forbidden security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/antraege: get: tags: - Vorgänge summary: Alle Anträge zum Vorgang operationId: getAllVorgangsAntraege produces: - application/json parameters: - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/Antraege' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}: get: tags: - Vorgänge summary: Anträge zum Vorgang operationId: getVorgangsAntraege produces: - application/json parameters: - name: antragsNummer in: path description: antragsNummer required: true type: integer format: int32 - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/Antraege' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}/{teilantragsNummer}: get: tags: - Vorgänge summary: Ein spezifischer Antrag des Vorgangs operationId: getAntrag produces: - application/json parameters: - name: antragsNummer in: path description: antragsNummer required: true type: integer format: int32 - name: teilantragsNummer in: path description: teilantragsNummer required: true type: integer format: int32 - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/Antrag' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}/{teilantragsNummer}/entscheidungsreife: post: tags: - Vorgänge summary: "Zum Senden eines Signals an den Produktanbieter, dass er mit der Kreditentscheidung beginnen kann" description: "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. " operationId: setEntscheidungsreife produces: - application/json parameters: - name: antragsNummer in: path description: antragsNummer required: true type: integer format: int32 - in: body name: entscheidungsreife description: entscheidungsreife required: true schema: $ref: '#/definitions/Entscheidungsreife' - name: teilantragsNummer in: path description: teilantragsNummer required: true type: integer format: int32 - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "202": description: Accepted "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/antraege/{antragsNummer}/{teilantragsNummer}/status: post: tags: - Vorgänge summary: Zum Setzen des Antragsstatus operationId: setAntragsStatus produces: - application/json parameters: - name: antragsNummer in: path description: antragsNummer required: true type: integer format: int32 - in: body name: statusDTO description: statusDTO required: true schema: $ref: '#/definitions/StatusDTO' - name: teilantragsNummer in: path description: teilantragsNummer required: true type: integer format: int32 - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "202": description: Accepted "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege: get: tags: - Finanzierungsvorschlag - Vorgänge summary: "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." operationId: getFinanzierungsvorschlaege produces: - application/json parameters: - name: apiVersion in: query description: apiVersion required: false type: string enum: - V2 - V3 - name: vorgangsNummer in: path description: Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden. required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/FinanzierungsvorschlaegeResource' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege/{finanzierungsvorschlagId}: get: tags: - Finanzierungsvorschlag - Vorgänge summary: "Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer und die Id des Finanzierungsvorschlags erwartet. Achtung: Bei dem ausgegebenen Finanzierungsvorschlag handelt es sich um Mockdaten." operationId: getFinanzierungsvorschlag produces: - application/json parameters: - name: finanzierungsvorschlagId in: path description: Die Id des Finanzierungsvorschlags. required: true type: string - name: vorgangsNummer in: path description: Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden. required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/Finanzierungsvorschlag' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote: get: tags: - Vorgänge summary: Die Liste der gemerkten Angebote des Vorgangs abrufen description: "Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer erwartet. Gemerkte Angebote sind: explizit gemerkte Angebote in BaufiSmart, ausgehändigte Finanzierungsvorschläge, Empfehlungen des Bearbeiters, Wünsche des Antragstellers, angefragte- und angenommene Angebote." operationId: retrieveGemerkteAngebote produces: - application/json parameters: - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/GemerkteAngeboteResource' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote/{nummerAmVorgang}: get: tags: - Vorgänge summary: Ein gemerktes Angebot eines Vorgangs abrufen description: "Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer und die Nummer des gemerkten Angebots erwartet. Gemerkte Angebote sind: explizit gemerkte Angebote in BaufiSmart, ausgehändigte Finanzierungsvorschläge, Empfehlungen des Bearbeiters, Wünsche des Antragstellers, angefragte- und angenommene Angebote." operationId: retrieveGemerktesAngebot produces: - application/json parameters: - name: apiVersion in: query description: apiVersion required: false type: string enum: - V2 - V3 - name: nummerAmVorgang in: path description: nummerAmVorgang required: true type: integer format: int32 - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/GemerkteAngeboteResource' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote/{nummerAmVorgang}/zahlungsPlaene: get: tags: - Vorgänge summary: Die Zahlungsplaene des gemerkten Angebots abrufen description: Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer und die Nummer des gemerkten Angebots erwartet. operationId: getZahlungsplaene produces: - application/json parameters: - name: nummerAmVorgang in: path description: nummerAmVorgang required: true type: integer format: int32 - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/Zahlungsplaene' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/kundenBetreuer: get: tags: - Vorgänge summary: Den Kundenbetreuer des Vorgangs abrufen description: "Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde." operationId: getKundenbetreuer produces: - application/json parameters: - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/Partner' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API put: tags: - Vorgänge summary: Den Kundenbetreuer ändern operationId: updateKundenBetreuerUsingPUT produces: - application/json parameters: - in: body name: partnerDTO description: partnerDTO required: true schema: $ref: '#/definitions/PartnerDTO' - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "201": description: Created "204": description: No Content "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/nachricht: post: tags: - Vorgänge summary: Schreibt eine Nachricht an den Vorgang in BaufiSmart operationId: addNachricht produces: - application/json parameters: - in: body name: nachricht description: nachricht required: true schema: $ref: '#/definitions/Nachricht' - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "201": description: Created "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API /v2/vorgaenge/{vorgangsNummer}/vorgangsBearbeiter: get: tags: - Vorgänge summary: Den Vorgangsbearbeiter des Vorgangs abrufen description: "Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde." operationId: getVorgangsBearbeiter produces: - application/json parameters: - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK schema: $ref: '#/definitions/Partner' "400": description: Bad Request schema: $ref: '#/definitions/Error' "401": description: Unauthorized schema: $ref: '#/definitions/Error' "403": description: Forbidden schema: $ref: '#/definitions/Error' "404": description: Not Found schema: $ref: '#/definitions/Error' "405": description: Method Not Allowed schema: $ref: '#/definitions/Error' "500": description: Internal Server Error schema: $ref: '#/definitions/Error' "502": description: Bad Gateway schema: $ref: '#/definitions/Error' "504": description: Gateway Timeout schema: $ref: '#/definitions/Error' security: - oauth2: - API put: tags: - Vorgänge summary: putVorgangsBearbeiterId operationId: putVorgangsBearbeiterIdUsingPUT consumes: - application/json produces: - application/json parameters: - in: body name: partnerDTO description: partnerDTO required: true schema: $ref: '#/definitions/PartnerDTO' - name: vorgangsNummer in: path description: vorgangsNummer required: true type: string responses: "200": description: OK "201": description: Created "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found security: - oauth2: - API securityDefinitions: oauth2: type: oauth2 tokenUrl: https://api.europace.de/login flow: password scopes: API: Authorisation Scope für die gesamte API. definitions: Absicherung: type: object properties: abgesicherteRisiken: type: array items: $ref: '#/definitions/RisikoAbsicherung' gesamtPraemie: type: number praemienZahlungsweise: type: string enum: - EINMALIG - HALBJAEHRLICH - JAEHRLICH - MONATLICH - VIERTELJAEHRLICH tarifBezeichnung: type: string tarifKennung: type: string versichertePersonId: type: string versicherungsArt: type: string versicherungsNummer: type: string versicherungsZeitraum: $ref: '#/definitions/VersicherungsZeitraum' title: Absicherung AbsicherungsAngaben: type: object properties: betraegtWoechentlicheArbeitsZeitMindestens15Stunden: type: boolean pruefungVorhandenerAbsicherungen: type: array items: $ref: '#/definitions/PruefungVorhandenerAbsicherung' title: AbsicherungsAngaben Absicherungswunsch: type: object properties: id: type: string versicherungsWuensche: type: array items: $ref: '#/definitions/VersicherungsWunsch' title: Absicherungswunsch Angebot: type: object properties: _links: $ref: '#/definitions/Links' absicherungen: type: array items: $ref: '#/definitions/Absicherung' bausparvertraege: type: array items: $ref: '#/definitions/Bausparvertrag' beleihungsRechnung: $ref: '#/definitions/BeleihungsRechnung' bewertungDesAngebots: type: string enum: - ANGEBOT_ENTSPRICHT_DEM_WUNSCH_DES_KUNDEN - ANGEBOT_ENTSPRICHT_DER_EMPFEHLUNG_DES_KUNDENBETREUERS darlehen: type: array items: $ref: '#/definitions/Darlehen' erzeugtAm: type: string format: date-time description: Erzeugungsdatum des Angebots kennung: type: string machbarkeitsStatus: type: string enum: - MACHBAR - NICHT_MACHBAR - UNTER_VORBEHALT_PRODUZENT meldungen: type: array items: $ref: '#/definitions/Meldung' nummerAmVorgang: type: integer format: int32 example: 1 description: Nummer des gemerkten Angebotes eines Vorgangs. pruefungsErgebnisse: type: array items: $ref: '#/definitions/AngebotsPruefungsErgebnis' zahlungsplaene: type: string description: Link zu den Zahlungsplänen des Angebots. title: Angebot AngebotsPruefungsErgebnis: type: object properties: produktAnbieter: $ref: '#/definitions/ProduktAnbieter' weitereAngaben: type: string description: Vom Produktanbieter bei der Angebotsprüfung ergänzte Daten. Das Format entspricht der Definition des Produktanbieters. title: AngebotsPruefungsErgebnis AnnuitaetenDarlehensWunsch: type: object properties: auszahlungsDatum: type: string format: date bereitstellungsZinsFreieZeitInMonaten: type: integer format: int32 darlehensBetrag: type: number provision: type: number riesterFoerderung: type: boolean riesterGefoerdertePerson: type: string sondertilgungOptionalJaehrlich: type: number tilgungsWunsch: $ref: '#/definitions/TilgungsWunsch' zinsBindungInJahren: type: integer format: int32 title: AnnuitaetenDarlehensWunsch Antraege: type: object properties: _links: $ref: '#/definitions/PaginationLinks' antraege: type: array items: $ref: '#/definitions/Antrag' title: Antraege Antrag: type: object properties: _links: $ref: '#/definitions/Links' angebot: description: "Das angenommene Angebot, auf dem dieser Antrag basiert" $ref: '#/definitions/Angebot' ansprechpartner: description: "Für Rückfragen auf Seite des Vertriebs, kann mit dem Vermittler identisch sein" $ref: '#/definitions/Partner' antragsNummer: type: string description: Nummer des Antrags auf der Europace Plattform antragsReferenzen: type: object description: "Referenzen am Antrag, die durch den Produktanbieter gesetzt wurden" additionalProperties: type: string beratung: description: Informationen zum Geschäftsabschluss $ref: '#/definitions/Beratung' datenKontext: type: string description: "Gibt an, ob es sich um einen Antrag aus dem Testmodus oder Echtgeschäft handelt" enum: - ECHT_GESCHAEFT - TEST_MODUS dokumente: type: array description: "Enthält alle Plattformdokumente, freigegebene Dokumente des Vertriebs, sowie die hochgeladenen Dokumente des Produktanbieters. **Aktuell sind nur Selbstauskunft und Kreditentscheidungsinformation enthalten.**" items: $ref: '#/definitions/Dokument' kreditSachbearbeiter: description: Gewählter Sachbearbeiter aus Seite des Kreditvertriebs $ref: '#/definitions/Partner' produktAnbieter: $ref: '#/definitions/ProduktAnbieter' status: description: Bearbeitungsfortschritt des Antrags $ref: '#/definitions/AntragsStatus' vermittler: description: Partner auf Seite des Vertriebs $ref: '#/definitions/Partner' zeitpunktDerAnnahme: type: string format: date-time description: "Zeitpunkt, zu dem der Antrag im System erstellt wurde." zugrundeliegendeDaten: description: "Basisdaten des Kunden, die für die Berechnung des Angebots relevant waren" $ref: '#/definitions/ZugrundeliegendeDatenZumAntrag' title: Antrag description: Diese Resource repräsentiert einen Antrag in Baufi Smart. AntragsStatus: type: object properties: antragsteller: type: string description: Willenserklärung des Antragstellers enum: - BEANTRAGT - NICHT_ANGENOMMEN - UNTERSCHRIEBEN - WIDERRUFEN antragstellerAblehnungsgrund: type: string description: Ablehnungsgrund des Antragstellers enum: - ANDERER_GRUND - ANDERES_ANGEBOT_ANGENOMMEN - ANGEBOT_WETTBEWERBER - BEARBEITUNGSZEIT - FINANZIERUNG_WIRD_ANGEPASST - KONDITIONEN_UNPASSEND - KUNDE_NICHT_ERREICHBAR - OBJEKT_NICHT_INTERESSANT - OBJEKT_NICHT_VERFUEGBAR bearbeitungsFortschritt: type: string description: Bearbeitungsfortschritt des Antrags nach beidseitiger Unterzeichnung enum: - FREIGEGEBEN_FUER_SAMMELFORDERUNG - NICHT_VON_PRODUKTANBIETER_BESTAETIGT - PROVISION_IN_BEARBEITUNG - PROVISON_AN_KUNDENBETREUER_VOLLSTAENDIG_AUSGEZAHLT - VON_PRODUKTANBIETER_BESTAETIGT produktAnbieter: type: string description: Willenserklärung des Produktanbieters enum: - ABGELEHNT - NICHT_BEARBEITET - UNTERSCHRIEBEN - ZURUECKGESTELLT produktanbieterAblehnungsgrund: type: string description: Ablehnungsgrund des Produktanbieters enum: - FINANZIELLE_SITUATION - GEGENANGEBOT - KEINE_ANGABE - KRITERIEN - NEGATIV_MERKMAL - UNTERLAGEN_UNVOLLSTAENDIG - WERTERMITTLUNG title: AntragsStatus Antragsteller: type: object properties: absicherungsAngaben: $ref: '#/definitions/AbsicherungsAngaben' anrede: type: string enum: - FRAU - HERR anschrift: $ref: '#/definitions/Postadresse' arbeitserlaubnis: type: boolean description: wenn keine deutsche Staatsangehörigkeit arbeitserlaubnisBefristetBis: type: string format: date description: wenn Arbeitserlaubnis befristet aufenthaltsTitel: type: string description: wenn keine deutsche Staatsangehörigkeit enum: - AUFENTHALTS_ERLAUBNIS - DAUERAUFENTHALT_EU - NIEDERLASSUNGS_ERLAUBNIS - VISUM aufenthaltsTitelBefristetBis: type: string format: date description: wenn Aufenthaltstitel befristet beschaeftigung: $ref: '#/definitions/Beschaeftigung' bruttoJahresEinkommenErwartet: type: number bruttoVorjahresEinkommen: type: number email: type: string example: max.mustermann@test.de description: Eine valide Emailadresse externeAntragstellerId: type: string familienstand: type: string enum: - GESCHIEDEN - GETRENNT_LEBEND - LEBENSPARTNERSCHAFT - LEDIG - VERHEIRATET - VERWITWET geburtsdatum: type: string format: date geburtsort: type: string guetertrennungVereinbartWennVerheiratet: type: boolean description: nur wenn verheiratet id: type: string inDeutschlandSeit: type: string format: date description: wenn keine deutsche Staatsangehörigkeit legitimationsDaten: $ref: '#/definitions/LegitimationsDaten' nachname: type: string schufaErgebnis: $ref: '#/definitions/SchufaErgebnis' sozialversicherungsnummer: type: string staatsangehoerigkeit: $ref: '#/definitions/Staat' steuerId: type: string telefonnummer: type: string telefonnummerVorwahl: type: string titel: type: array items: type: string enum: - DOKTOR - PROFESSOR titelDoktor: type: boolean titelProfessor: type: boolean vorAnschrift: $ref: '#/definitions/Postadresse' vorname: type: string weitereKontaktMoeglichkeiten: type: string wohnhaftSeit: type: string format: date title: Antragsteller Archivierung: type: object properties: grund: type: string enum: - DAS_OBJEKT_IST_WEG - FINANZIERUNG_IST_NICHT_MACHBAR - KUNDE_HAT_EIN_ANDERES_ANGEBOT - KUNDE_IST_NICHT_MEHR_INTERESSIERT - OBJEKT_IST_NICHT_MEHR_VERFUEGBAR - SCHLECHTER_LEAD_NICHT_ZU_ERREICHEN - VORGANG_ERFOLGREICH_ABGESCHLOSSEN kommentar: type: string title: Archivierung AusgabenMonatlich: type: object properties: ausgabenMonatlich: type: number berechnungsHilfeVermoegen: $ref: '#/definitions/BerechnungsHilfeBetrag' zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME title: AusgabenMonatlich Autostellplatz: type: object properties: mieteinnahmenMonatlich: type: number typ: type: string enum: - CARPORT - DOPPEL_GARAGE - GARAGE - KELLER_GARAGE - STELLPLATZ - TIEFGARAGEN_STELLPLATZ title: Autostellplatz BankUndSparguthaben: type: object properties: aktuellerWert: type: number ertrag: type: number maximalAufzuloesenderWert: type: number vermoegensEinsatz: type: string enum: - ABTRETEN - AUFLOESEN - KEIN_EINSATZ vermoegensTyp: type: string description: Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium enum: - VERBINDLICHKEIT - VERMOEGEN zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME zinsertragJaehrlich: type: number zukuenftigeEinnahmen: type: number title: BankUndSparguthaben Bankverbindung: type: object properties: bic: type: string iban: type: string id: type: string kontoinhaberIds: type: array items: type: string kontoinhaberName: type: string kreditinstitut: type: string title: Bankverbindung BausparAngebot: type: object properties: abschlussGebuehr: type: number angebotsHinweisFuerAntragsteller: type: string description: nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten bausparSumme: type: number einmalzahlung: type: number description: Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. id: type: string produktAnbieter: $ref: '#/definitions/ProduktAnbieter' sonderZahlungen: type: array items: $ref: '#/definitions/SonderZahlung' sparBeginn: type: string format: date description: Der berechnete Beginn des Besparens des Bausparvertrags. sparPhase: $ref: '#/definitions/SparPhase' tarif: type: string tilgungsPhase: $ref: '#/definitions/TilgungsPhase' typ: type: string vertragsBeginn: type: string format: date vertragsNummer: type: string verwaltungsgebuehrenJaehrlich: type: number zuteilungsDatum: type: string format: date title: BausparAngebot BausparDarlehensWunsch: type: object properties: bausparGuthaben: type: number bausparSumme: type: number bausparTarif: type: array description: siehe weitere Beschreibung unter Weitere Informationen -> Bezeichnung Bauspartarife items: $ref: '#/definitions/BausparTarif' darlehensBetrag: type: number provision: type: number tilgungsBeitragMonatlich: type: number vertragsNummer: type: string vertragsPartnerIds: type: array items: type: string zuteilungsAnnahme: type: string format: date title: BausparDarlehensWunsch BausparTarif: type: object properties: id: type: string kurzName: type: string langName: type: string produktAnbieter: type: string riesterFoerderung: type: boolean status: type: string enum: - AKTIV - DEAKTIVIERT - IN_ENTWICKLUNG title: BausparTarif BausparWunsch: type: object properties: abschlussGebuehrenVerrechnung: type: string enum: - SOFORTZAHLUNG - VERRECHNUNG bausparSummeAbsolut: type: number bausparSummeRelativ: type: number bausparTarif: type: array description: siehe weitere Beschreibung unter Weitere Informationen -> Bezeichnung Bauspartarife items: $ref: '#/definitions/BausparTarif' bausparTarife: type: array description: "Deprecated, Zukünftig sind die Informationen zum gewünschen Tarif unter bausparTarif zu finden." items: type: string id: type: string riesterFoerderung: type: boolean sonderZahlungEinmalig: type: number description: Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. sonderZahlungen: type: array items: $ref: '#/definitions/SonderZahlung' sparBeginn: type: string format: date description: Der Beginn des Besparens des Bausparvertrags ist frei festlegbar. sparBeitragMonatlichAbsolut: type: number sparBeitragMonatlichRelativ: type: number tilgungsBeitragMonatlich: type: number vertragsPartnerIds: type: array items: type: string verwendung: type: string enum: - TILGUNGS_AUSGESETZT - ZINS_ABSICHERUNG verwendungZulagen: type: string enum: - SONDERZAHLUNG - VERRECHNUNG zuteilungsDatum: type: string format: date title: BausparWunsch description: "Von den Feldern bausparSummeAbsolut, bausparSummeRelativ, sparBeitragMonatlichAbsolut, sparBeitragMonatlichRelativ, tilgungsBeitragMonatlich, zuteilungsDatum und sparBeginn können maximal drei befüllt sein." Bausparvertrag: type: object properties: abschlussGebuehr: type: number angebotsHinweisFuerAntragsteller: type: string description: nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten bausparSumme: type: number einmalzahlung: type: number description: Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. gesamtLaufzeitInJahren: type: integer format: int32 id: type: string produktAnbieter: $ref: '#/definitions/ProduktAnbieter' sonderZahlungen: type: array items: $ref: '#/definitions/SonderZahlung' sparBeginn: type: string format: date description: Der berechnete Beginn des Besparens des Bausparvertrags. sparPhase: $ref: '#/definitions/SparPhase' tarif: type: string tarifId: type: string description: Produktanbieter-spezifische Tarif-ID des Bauspartarifs tilgungsPhase: $ref: '#/definitions/TilgungsPhase' typ: type: string vertragsBeginn: type: string format: date vertragsNummer: type: string verwaltungsgebuehrenJaehrlich: type: number zuteilungsDatum: type: string format: date title: Bausparvertrag BeleihungsRechnung: type: object properties: beleihungsAuslauf: type: number description: Der Beleihungsauslauf aus Sicht des Produktanbieters. Berechnet sich aus dem Verhältnis anerkannter Darlehen zur Summe der anerkannten Beleihungswerte. beleihungsWerte: type: array description: Enthält die vom Produktanbieter anerkannten Beleihungswerte items: $ref: '#/definitions/BeleihungsWert' beleihungsWerteSumme: type: number description: "Berechnungshilfe: Die Summe aller vom Produktanbieter anerkannten Beleihungswerte" produktAnbieter: $ref: '#/definitions/ProduktAnbieter' title: BeleihungsRechnung BeleihungsWert: type: object properties: adresse: $ref: '#/definitions/Postadresse' beleihungsWert: type: number immobilie: $ref: '#/definitions/ImmobilieVerknuepfung' produktAnbieter: $ref: '#/definitions/ProduktAnbieter' title: BeleihungsWert Beratung: type: object properties: art: type: string enum: - AUSSER_GESCHAEFTSRAUM_VERTRAG - FERN_ABSATZ_GESCHAEFT - PRAESENZ_GESCHAEFT hinweisFuerProduktAnbieter: type: string istKundenBetreuerVerkaeuferOderMaklerDerImmobilie: type: boolean description: "Mit diesem Wert wird ausgedrückt, ob der Kundenbetreuer auch der Immobilienmakler ist." title: Beratung BerechnungsHilfeBetrag: type: object properties: betragNachFinanzierung: type: number betragVorFinanzierung: type: number title: BerechnungsHilfeBetrag Bereitstellung: type: object properties: bereitstellungsZins: type: number bereitstellungsZinsFreieZeitInMonaten: type: integer format: int32 title: Bereitstellung Beschaeftigung: type: object properties: anzahlGehaelterProJahr: type: number format: double description: "nur bei art==ANGESTELLTER,ARBEITER,BEAMTER" arbeitgeber: type: string description: "nur bei art==ANGESTELLTER,ARBEITER,BEAMTER" arbeitgeberInDeutschlandAnsaessig: type: boolean description: "nur bei art==ANGESTELLTER,ARBEITER,BEAMTER" arbeitgeberLand: description: nur bei arbeitgeberInDeutschlandAnsaessig==false $ref: '#/definitions/Staat' art: type: string enum: - ANGESTELLTER - ARBEITER - ARBEITSLOSER - BEAMTER - FREIBERUFLER - HAUSFRAU - RENTNER - SELBSTAENDIGER befristungsStatus: type: string description: "nur bei art==ANGESTELLTER,ARBEITER" enum: - BEFRISTET - UNBEFRISTET beruf: type: string description: nur bei art!=RENTNER beschaeftigtSeit: type: string format: date description: "nur bei art==ANGESTELLTER,ARBEITER,BEAMTER,FREIBERUFLER,SELBSTAENDIGER" branche: type: string description: Berufsgruppe des Antragstellers. enum: - BAUGEWERBE - BERGBAU_GEWINNUNG_VON_STEINEN_UND_ERDEN - ENERGIEVERSORGUNG - ERZIEHUNG_UNTERRICHT - FINANZ_UND_VERSICHERUNGSDIENSTLEISTUNGEN - FREIBERUFLICHE_WISSENSCHAFTLICHE_UND_TECHNISCHE_DIENSTLEISTUNGEN - GASTGEWERBE - GESUNDHEIT_UND_SOZIALWESEN - GRUNDSTÜCKS_UND_WOHNUNGSWESEN - HANDEL_INSTANDHALTUNG_VON_KRAFTFAHRZEUGEN - INFORMATION_KOMMUNIKATION - KUNST_UNTERHALTUNG_ERHOLUNG - LANDWIRTSCHAFT_FORSTWIRTSCHAFT_FISCHEREI - OEFFENTLICHE_VERWALTUNG_VERTEIDIGUNG_SOZIALVERSICHERUNG - PRIVATE_HAUSHALTE - SONSTIGE_DIENSTLEISTUNGEN - SONSTIGE_WIRTSCHAFTLICHE_DIENSTLEISTUNGEN - VERARBEITENDES_GEWERBE - VERKEHR_LOGISTIK - WASSERVERSORGUNG einkommenNettoJaehrlich: type: number description: "nur bei art==FREIBERUFLER,SELBSTAENDIGER" einkommenNettoMonatlich: type: number description: "nur bei art!=FREIBERUFLER,SELBSTAENDIGER" firma: type: string description: "nur bei art==FREIBERUFLER,SELBSTAENDIGER" inProbezeit: type: boolean description: "nur bei art==ANGESTELLTER,ARBEITER,BEAMTER" situationNachRenteneintritt: description: nur bei art!=RENTNER $ref: '#/definitions/SituationNachRenteneintritt' taetigkeit: type: string description: "nur bei art==FREIBERUFLER,SELBSTAENDIGER" enum: - ALTENPFLEGER - AMBULANTER_KRANKENPFLEGER - ANWALT - APOTHEKER - ARCHITEKT - ARZT - BESTATTER - DATENSCHUTZBEAUFTRAGTER - DEKORATEUR - DIAETASSISTENT - DOLMETSCHER - EDV_BERATER - ERGOTHERAPEUT - ERNAEHRUNGSBERATER - FOTOGRAF - GEOGRAF - GRAFIKDESIGNER - GRAFIKER - HEBAMME - HEILMASSEUR - HEILPRAKTIKER - HISTORIKER - INFORMATIKER - INGENIEUR - INSOLVENZVERWALTER - JOURNALIST - KLASSISCHER_KONZERTMUSIKER - KONSTRUKTEUR - KRANKENGYMNAST - KRANKENPFLEGER - KRANKENSCHWESTER - LOGOPAEDE - MEDIZINISCH_TECHN_ASSISTENT - NOTAR - OPERNSAENGER - PERSONALBERATER - PHYSIOTHERAPEUT - PSYCHOLOGE - RAUMAUSSTATTER - RUNDFUNKSPRECHER - SACHVERSTAENDIGER - SONSTIGES - STADTPLANER - STATIKER - STEUERBERATER - TIERARZT - UNTERNEHMENSBERATER - VERMITTLER - WIRTSCH_BUCHPRUEFER_REVISOR - ZAHNARZT - ZAHNTECHNIKER title: Beschaeftigung BestehendeImmobilie: type: object properties: adresse: $ref: '#/definitions/Postadresse' autostellplaetze: type: array items: $ref: '#/definitions/Autostellplatz' bestehendeDarlehen: type: array items: $ref: '#/definitions/BestehendesDarlehen' bewirtschaftungsKostenJaehrlich: type: number bodenRichtwert: type: number bundesland: type: string enum: - BADEN_WUERTTEMBERG - BAYERN - BERLIN - BRANDENBURG - BREMEN - HAMBURG - HESSEN - MECKLENBURG_VORPOMMERN - NIEDERSACHSEN - NORDRHEIN_WESTFALEN - RHEINLAND_PFALZ - SAARLAND - SACHSEN - SACHSEN_ANHALT - SCHLESWIG_HOLSTEIN - THUERINGEN effektivZinsErhoehendeKosten: $ref: '#/definitions/EffektivZinsErhoehendeKosten' erbbaurecht: $ref: '#/definitions/Erbbaurecht' gebaeude: $ref: '#/definitions/Gebaeude' grundbuchAngabe: $ref: '#/definitions/GrundbuchAngabe' grundstueck: $ref: '#/definitions/Grundstueck' id: type: string immobilienEinsatz: type: string enum: - ALS_ZUSATZSICHERHEIT - KEIN_EINSATZ - VERKAUFEN keinBaulandFlaecheInQm: type: number keineBestehendenDarlehenVorhanden: type: boolean marktueblicherKaufpreisProQm: type: number marktwert: type: number description: "Nur relevant bei Finanzbedarf AnschlussFinanzierung, Modernisierung und Kapitalbeschaffung." maximalEinzusetzenderBetragWennVerkauf: type: number objektArt: type: string enum: - EIGENTUMSWOHNUNG - GRUNDSTUECK - HAUS vergleichsmieteFuerGewerbeflaecheProQm: type: number vergleichsmieteFuerWohnflaecheProQm: type: number verkehrswert: type: number description: Hat den selben Inhalt wie das Feld marktwert. (Wird in v3 nicht mehr enthalten sein) vorlaeufigerVerkehrswert: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." wohnlage: type: string enum: - EINFACH - GEHOBEN - MITTEL title: BestehendeImmobilie BestehenderBausparvertrag: type: object properties: abschlussGebuehr: type: number aktuellerWert: type: number bausparSumme: type: number einmalzahlung: type: number description: Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. ertrag: type: number id: type: string maximalAufzuloesenderBetrag: type: number produktAnbieter: $ref: '#/definitions/ProduktAnbieter' sonderZahlungen: type: array items: $ref: '#/definitions/SonderZahlung' sparBeitragMonatlich: type: number tarif: type: string typ: type: string vermoegensEinsatz: type: string enum: - ABTRETEN - AUFLOESEN - KEIN_EINSATZ vermoegensTyp: type: string description: Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium enum: - VERBINDLICHKEIT - VERMOEGEN vertragsBeginn: type: string format: date vertragsNummer: type: string verwaltungsgebuehrenJaehrlich: type: number zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME zukuenftigeEinnahmen: type: number zuteilungsDatum: type: string format: date title: BestehenderBausparvertrag BestehendesDarlehen: type: object properties: abzuloesendeRestschuld: type: number aktuelleRestschuldWennNichtAbzuloesen: type: number darlehensArt: type: string description: Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können. enum: - BAUSPARDARLEHEN - FOERDERDARLEHEN - IMMOBILIENDARLEHEN - PRIVATDARLEHEN - SONSTIGES_DARLEHEN darlehensBetrag: type: number darlehensGeber: $ref: '#/definitions/ProduktAnbieter' darlehensKontonummer: type: string eingetrageneGrundschuld: type: number grundschuldArt: type: string enum: - BRIEF_GRUNDSCHULD - BUCH_GRUNDSCHULD id: type: string laufzeitEnde: type: string format: date rateMonatlich: type: number sollZins: type: number sondertilgungZumZinsBindungsEnde: type: number description: "für Prolongation, d.h. technisch: Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG" zinsBindungEndetAm: type: string format: date title: BestehendesDarlehen BestehendesDarlehenDesFinanzierungsObjekts: type: object properties: abzuloesendeRestschuld: type: number aktuelleRestschuldWennNichtAbzuloesen: type: number darlehensArt: type: string description: Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können. enum: - BAUSPARDARLEHEN - FOERDERDARLEHEN - IMMOBILIENDARLEHEN - PRIVATDARLEHEN - SONSTIGES_DARLEHEN darlehensBetrag: type: number darlehensGeber: $ref: '#/definitions/ProduktAnbieter' darlehensKontonummer: type: string eingetrageneGrundschuld: type: number grundschuldArt: type: string enum: - BRIEF_GRUNDSCHULD - BUCH_GRUNDSCHULD id: type: string laufzeitEnde: type: string format: date rateMonatlich: type: number sollZins: type: number sondertilgungZumZinsBindungsEnde: type: number description: "für Prolongation, d.h. technisch: Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG" verwendenAls: type: string description: "Beschreibt wie das Darlehen im Zusammenhang mit dem Vorhaben, behandelt werden soll." enum: - ABLOESEN - TRITT_IM_RANG_ZURUECK - TRITT_NICHT_IM_RANG_ZURUECK zinsBindungEndetAm: type: string format: date title: BestehendesDarlehenDesFinanzierungsObjekts Darlehen: type: object properties: auszahlungsBetrag: type: number auszahlungsDatum: type: string format: date description: "nur bei darlehensTyp IN [FORWARD_DARLEHEN, ANNUITAETEN_DARLEHEN]" auszahlungsKurs: type: number bausparTarif: type: string description: nur bei darlehensTyp==BAUSPAR_DARLEHEN bereitstellung: description: nicht bei darlehensTyp==PRIVAT_DARLEHEN $ref: '#/definitions/Bereitstellung' darlehensBetrag: type: number darlehensTyp: type: string enum: - ANNUITAETEN_DARLEHEN - BAUSPAR_DARLEHEN - FORWARD_DARLEHEN - KFW_DARLEHEN - PRIVAT_DARLEHEN - REGIONAL_FOERDER_DARLEHEN - VARIABLES_DARLEHEN - ZWISCHEN_FINANZIERUNG detailsZurVerwendung: type: string description: nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG effektivZins: type: number effektivZinsRelevanteKosten: $ref: '#/definitions/EffektivZinsKosten' forwardPeriodeInMonaten: type: integer format: int32 description: nur bei darlehensTyp==FORWARD_DARLEHEN id: type: string kfwEnergieEffizienzGruppe: type: string description: nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261 (SANIERUNG).Es können auch weitere Werte zulässig werden. enum: - NEUBAU - SANIERUNG - STANDARD kfwEnergieEffizienzStandard: type: string description: "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." enum: - KLIMAFREUNDLICH_QNG - KLIMAFREUNDLICH_STANDARD - STANDARD_100 - STANDARD_100_EEK - STANDARD_40 - STANDARD_40_EEK - STANDARD_40_NH - STANDARD_40_PLUS - STANDARD_55 - STANDARD_55_EEK - STANDARD_70 - STANDARD_70_EEK - STANDARD_85 - STANDARD_85_EEK - STANDARD_DENKMAL - STANDARD_DENKMAL_EEK kfwProgramm: type: string description: "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" enum: - PROGRAMM_124 - PROGRAMM_141 - PROGRAMM_151 - PROGRAMM_152 - PROGRAMM_153 - PROGRAMM_155 - PROGRAMM_159 - PROGRAMM_167 - PROGRAMM_261 - PROGRAMM_262 - PROGRAMM_297 - PROGRAMM_298 - PROGRAMM_300 kfwSanierungsFahrplanLiegtVor: type: boolean description: nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261 relevant. konditionWurdeManuellAngepasst: type: boolean konditionsAnpassungsBegruendung: type: string description: "Begründung, wenn die Kondition angepasst wurde" laufZeitInJahren: type: integer format: int32 laufzeitInMonaten: type: integer format: int32 description: nur bei darlehensTyp==PRIVAT_DARLEHEN maximaleLaufzeitInMonaten: type: integer format: int32 description: nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG produktAnbieter: $ref: '#/definitions/ProduktAnbieter' rateMonatlich: type: number example: 123.34 description: Die monatliche Rate in Euro rateMonatlichInDerTilgungsfreienAnlaufzeit: type: number description: "nur bei darlehensTyp IN [KFW_DARLEHEN, REGIONAL_FOERDER_DARLEHEN]" regionalFoerderbankProgramm: type: string description: 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. enum: - L_BANK_KOMBI_DARLEHEN_WOHNEN - L_BANK_WOHNEN_MIT_KIND - L_BANK_WOHNEN_MIT_ZUKUNFT - NRW_BANK_GEBAEUDESANIERUNG - NRW_BANK_NACHHALTIG_WOHNEN - NRW_BANK_WOHNEIGENTUM riesterGefoerdert: type: boolean sollZins: type: number example: 2.05 description: Der Sollzinssatz in Prozent tilgung: description: nicht bei darlehensTyp==ZWISCHEN_FINANZIERUNG $ref: '#/definitions/Tilgung' tilgungsFreieAnlaufJahre: type: integer format: int32 description: "nur bei darlehensTyp IN [KFW_DARLEHEN, REGIONAL_FOERDER_DARLEHEN]" vertragsPartnerIds: type: array description: nur bei darlehensTyp==BAUSPAR_DARLEHEN items: type: string verwendungszweck: type: string description: nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG enum: - SONSTIGE_VERWENDUNG - VERKAUF_EINES_ANDEREN_OBJEKTS - VORFINANZIERUNG_OEFFENTLICHER_MITTEL zinsBindung: description: "nicht bei darlehensTyp IN [VARIABLES_DARLEHEN,ZWISCHEN_FINANZIERUNG]" $ref: '#/definitions/ZinsBindung' zinsZahlungsBeginnAm: type: string format: date title: Darlehen Darlehen0: type: object properties: auszahlungsBetrag: type: number auszahlungsDatum: type: string format: date description: "nur bei darlehensTyp IN [FORWARD_DARLEHEN, ANNUITAETEN_DARLEHEN]" auszahlungsKurs: type: number bausparTarif: type: string description: nur bei darlehensTyp==BAUSPAR_DARLEHEN bereitstellung: description: nicht bei darlehensTyp==PRIVAT_DARLEHEN $ref: '#/definitions/Bereitstellung' darlehensBetrag: type: number darlehensTyp: type: string enum: - ANNUITAETEN_DARLEHEN - BAUSPAR_DARLEHEN - FORWARD_DARLEHEN - KFW_DARLEHEN - PRIVAT_DARLEHEN - REGIONAL_FOERDER_DARLEHEN - VARIABLES_DARLEHEN - ZWISCHEN_FINANZIERUNG detailsZurVerwendung: type: string description: nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG effektivZins: type: number effektivZinsRelevanteKosten: $ref: '#/definitions/EffektivZinsKosten' forwardPeriodeInMonaten: type: integer format: int32 description: nur bei darlehensTyp==FORWARD_DARLEHEN id: type: string kfwEnergieEffizienzGruppe: type: string description: nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261 (SANIERUNG).Es können auch weitere Werte zulässig werden. enum: - NEUBAU - SANIERUNG - STANDARD kfwEnergieEffizienzStandard: type: string description: "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." enum: - KLIMAFREUNDLICH_QNG - KLIMAFREUNDLICH_STANDARD - STANDARD_100 - STANDARD_100_EEK - STANDARD_40 - STANDARD_40_EEK - STANDARD_40_NH - STANDARD_40_PLUS - STANDARD_55 - STANDARD_55_EEK - STANDARD_70 - STANDARD_70_EEK - STANDARD_85 - STANDARD_85_EEK - STANDARD_DENKMAL - STANDARD_DENKMAL_EEK kfwProgramm: type: string description: "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" enum: - PROGRAMM_124 - PROGRAMM_141 - PROGRAMM_151 - PROGRAMM_152 - PROGRAMM_153 - PROGRAMM_155 - PROGRAMM_159 - PROGRAMM_167 - PROGRAMM_261 - PROGRAMM_262 - PROGRAMM_297 - PROGRAMM_298 - PROGRAMM_300 kfwSanierungsFahrplanLiegtVor: type: boolean description: nur bei darlehensTyp==KFW_DARLEHEN. Nur bei KfW-Programm 261 relevant. konditionWurdeManuellAngepasst: type: boolean konditionsAnpassungsBegruendung: type: string description: "Begründung, wenn die Kondition angepasst wurde" laufZeitInJahren: type: integer format: int32 laufzeitInMonaten: type: integer format: int32 description: nur bei darlehensTyp==PRIVAT_DARLEHEN maximaleLaufzeitInMonaten: type: integer format: int32 description: nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG produktAnbieter: $ref: '#/definitions/ProduktAnbieter' rateMonatlich: type: number example: 123.34 description: Die monatliche Rate in Euro rateMonatlichInDerTilgungsfreienAnlaufzeit: type: number description: "nur bei darlehensTyp IN [KFW_DARLEHEN, REGIONAL_FOERDER_DARLEHEN]" regionalFoerderbankProgramm: type: string description: 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. enum: - L_BANK_KOMBI_DARLEHEN_WOHNEN - L_BANK_WOHNEN_MIT_KIND - L_BANK_WOHNEN_MIT_ZUKUNFT - NRW_BANK_GEBAEUDESANIERUNG - NRW_BANK_NACHHALTIG_WOHNEN - NRW_BANK_WOHNEIGENTUM riesterGefoerdert: type: boolean sollZins: type: number example: 2.05 description: Der Sollzinssatz in Prozent tilgung: description: nicht bei darlehensTyp==ZWISCHEN_FINANZIERUNG $ref: '#/definitions/Tilgung' tilgungsFreieAnlaufJahre: type: integer format: int32 description: "nur bei darlehensTyp IN [KFW_DARLEHEN, REGIONAL_FOERDER_DARLEHEN]" vertragsPartnerIds: type: array description: nur bei darlehensTyp==BAUSPAR_DARLEHEN items: type: string verwendungszweck: type: string description: nur bei darlehensTyp==ZWISCHEN_FINANZIERUNG enum: - SONSTIGE_VERWENDUNG - VERKAUF_EINES_ANDEREN_OBJEKTS - VORFINANZIERUNG_OEFFENTLICHER_MITTEL zinsBindung: description: "nicht bei darlehensTyp IN [VARIABLES_DARLEHEN,ZWISCHEN_FINANZIERUNG]" $ref: '#/definitions/ZinsBindung' zinsZahlungsBeginnAm: type: string format: date title: Darlehen0 DarlehensWunsch: type: object properties: annuitaetenDarlehen: description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" $ref: '#/definitions/AnnuitaetenDarlehensWunsch' bausparDarlehen: description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" $ref: '#/definitions/BausparDarlehensWunsch' forwardDarlehen: description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" $ref: '#/definitions/ForwardDarlehensWunsch' id: type: string kfwDarlehen: description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" $ref: '#/definitions/KfwDarlehensWunsch' privatDarlehen: description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" $ref: '#/definitions/PrivatDarlehensWunsch' regionalFoerderDarlehen: description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" $ref: '#/definitions/RegionalFoerderDarlehensWunsch' variablesDarlehen: description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" $ref: '#/definitions/VariablesDarlehensWunsch' zwischenFinanzierung: description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" $ref: '#/definitions/ZwischenFinanzierungsWunsch' title: DarlehensWunsch Dokument: type: object properties: art: type: string description: ist nicht immer vorhanden href: type: string name: type: string titel: type: string description: Name des Dokuments type: type: string title: Dokument EffektivZinsErhoehendeKosten: type: object properties: anpassen: type: boolean grundbuchEintragungsKostenEinmalig: type: number sonstigeKostenBezeichnung: type: string sonstigeKostenEinmalig: type: number wohnGebaeudeVersicherungsKostenJaehrlich: type: number title: EffektivZinsErhoehendeKosten EffektivZinsKosten: type: object properties: beratungsHonorar: type: number grundbuchKosten: type: number sonstigeKosten: type: number tilgungsErsatzProduktKosten: type: number wohnGebaeudeVersicherungsKosten: type: number zinsabsicherungsKosten: type: number zusatzSicherheitsKosten: type: number title: EffektivZinsKosten EinkuenfteAusNebentaetigkeit: type: object properties: beginnDerNebentaetigkeit: type: string format: date einnahmenMonatlich: type: number zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME title: EinkuenfteAusNebentaetigkeit EinnahmenMonatlich: type: object properties: einnahmenMonatlich: type: number zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME title: EinnahmenMonatlich Eintrag: type: object properties: datum: type: string format: date kontofuehrungsGebuehr: type: number laufendeGebuehr: type: number saldo: type: number tilgung: type: number zahlung: type: number zinsen: type: number title: Eintrag description: Eine Einzahlung oder Auszahlung im Zahlungsplan EnergieEffizienzAusweis: type: object properties: ausweisTyp: type: string enum: - ENDENERGIEBEDARF - ENDENERGIEVERBRAUCH endEnergie: type: number format: double primaerEnergieTraeger: type: string enum: - ABFAELLE - BRAUNKOHLE - HOLZ - NETZSTROM - OEL_GAS - PHOTOVOLTAIK_WINDKRAFT - SONSTIGES - STEINKOHLE - VERDRAENGUNGSSTROM - WAERME_KAELTE title: EnergieEffizienzAusweis Entscheidungsreife: type: object required: - entscheidungsreifeVomVertriebSignalisiert properties: entscheidungsreifeVomVertriebSignalisiert: type: boolean example: true description: Es wird nur 'true' zugelassen. Die API berücksichtigt Weiterentwicklungen ohne einen BreakingChange zu forcieren. title: Entscheidungsreife Erbbaurecht: type: object properties: erbbaurecht: type: boolean erbbauzinsJaehrlich: type: number grundstuecksEigentuemer: type: string enum: - ANDERE - OEFFENTLICH_KIRCHLICH laufzeitBisJahr: type: string title: Erbbaurecht Error: type: object properties: message: type: string statusCode: type: integer format: int32 statusMessage: type: string timestamp: type: string traceId: type: string title: Error EuropaceBausparAngebot: type: object properties: abschlussGebuehr: type: number angebotsHinweisFuerAntragsteller: type: string description: nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten bausparSumme: type: number einmalzahlung: type: number description: Deprecated. Einmalzahlungen sind Teil der Sonderzahlungen. gesamtLaufzeitInJahren: type: integer format: int32 id: type: string produktAnbieter: $ref: '#/definitions/ProduktAnbieter' sonderZahlungen: type: array items: $ref: '#/definitions/SonderZahlung' sparBeginn: type: string format: date description: Der berechnete Beginn des Besparens des Bausparvertrags. sparPhase: $ref: '#/definitions/SparPhase' tarif: type: string tarifId: type: string description: Produktanbieter-spezifische Tarif-ID des Bauspartarifs tilgungsPhase: $ref: '#/definitions/TilgungsPhase' typ: type: string vertragsBeginn: type: string format: date vertragsNummer: type: string verwaltungsgebuehrenJaehrlich: type: number zuteilungsDatum: type: string format: date title: EuropaceBausparAngebot Finanzbedarf: type: object properties: anzahlTeilzahlungen: type: integer format: int32 description: "Anzahl Teilzahlungen bei Neubau, Kauf vom Bauträger sowie Modernisierung" aussenAnlagen: type: number bauNebenkosten: type: number beratungsHonorar: type: number bereitsBeglichen: type: number erschliessung: type: number grunderwerbsteuer: type: number description: Nebenkosten grundstueckBereitsBezahlt: type: boolean grundstuecksKaufpreis: type: number herstellung: type: number description: inklusive Eigenleistungen kapitalBeschaffung: type: number kapitalWirdBeschafft: type: boolean kaufpreis: type: number description: inklusive Eigenleistungen maklergebuehr: type: number description: Nebenkosten mobiliar: type: number modernisieren: type: boolean modernisierung: type: number description: inklusive Eigenleistungen notargebuehr: type: number description: Nebenkosten renovierung: type: number sonstigeKosten: type: number zusaetzlichesKapital: type: number title: Finanzbedarf FinanzierungsObjekt: type: object properties: adresse: $ref: '#/definitions/Postadresse' autostellplaetze: type: array items: $ref: '#/definitions/Autostellplatz' bestehendeDarlehen: type: array items: $ref: '#/definitions/BestehendesDarlehenDesFinanzierungsObjekts' bewirtschaftungsKostenJaehrlich: type: number bodenRichtwert: type: number bundesland: type: string enum: - BADEN_WUERTTEMBERG - BAYERN - BERLIN - BRANDENBURG - BREMEN - HAMBURG - HESSEN - MECKLENBURG_VORPOMMERN - NIEDERSACHSEN - NORDRHEIN_WESTFALEN - RHEINLAND_PFALZ - SAARLAND - SACHSEN - SACHSEN_ANHALT - SCHLESWIG_HOLSTEIN - THUERINGEN effektivZinsErhoehendeKosten: $ref: '#/definitions/EffektivZinsErhoehendeKosten' erbbaurecht: $ref: '#/definitions/Erbbaurecht' gebaeude: $ref: '#/definitions/Gebaeude' grundbuchAngabe: $ref: '#/definitions/GrundbuchAngabe' grundstueck: $ref: '#/definitions/Grundstueck' id: type: string keinBaulandFlaecheInQm: type: number marktueblicherKaufpreisProQm: type: number marktwert: type: number description: "Nur relevant bei Finanzbedarf AnschlussFinanzierung, Modernisierung und Kapitalbeschaffung." objektArt: type: string enum: - EIGENTUMSWOHNUNG - GRUNDSTUECK - HAUS vergleichsmieteFuerGewerbeflaecheProQm: type: number vergleichsmieteFuerWohnflaecheProQm: type: number verkehrswert: type: number description: Hat den selben Inhalt wie das Feld marktwert. (Wird in v3 nicht mehr enthalten sein) vorlaeufigerVerkehrswert: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." wohnlage: type: string enum: - EINFACH - GEHOBEN - MITTEL title: FinanzierungsObjekt FinanzierungsvorschlaegeResource: type: object properties: _links: $ref: '#/definitions/Links' finanzierungsvorschlaege: type: array items: $ref: '#/definitions/Finanzierungsvorschlag' title: FinanzierungsvorschlaegeResource Finanzierungsvorschlag: type: object properties: _links: $ref: '#/definitions/Links' annahmeFrist: type: string format: date-time description: Die Annahmefrist des Angebots. bausparvertraege: type: array description: "Liste von allen Bausparverträgen, die Bestandteil dieses Finanzierungsvorschlags sind." items: $ref: '#/definitions/EuropaceBausparAngebot' beleihung: $ref: '#/definitions/BeleihungsRechnung' darlehen: type: array description: "Liste von allen Darlehen, die Bestandteil dieses Finanzierungsvorschlags sind." items: $ref: '#/definitions/Darlehen0' darlehensSumme: type: number example: 123.34 description: Die gesamte Darlehenssumme in Euro für alle im Finanzierungsvorschlag enthaltenen Darlehen. effektivZins: type: number example: 2.04 description: Aus allen Darlehens Effektivzinssätzen wird ein aggregierter Mischzins in Prozent ausgegeben. historie: type: array description: "Historie, in der für jedes Aushändigen, ein Eintrag mit Datum und Akteur ausgegeben wird." items: $ref: '#/definitions/FinanzierungsvorschlagHistorienEintrag' id: type: string description: Id des Finanzierungsvorschlags machbarkeitsStatus: type: string example: MACHBAR enum: - MACHBAR - NICHT_MACHBAR - UNTER_VORBEHALT_PRODUZENT rateMonatlich: type: number example: 123.34 description: Die gesamte monatliche Rate in Euro. sollZins: type: number example: 2.05 description: Aus allen Darlehens Sollzinssätzen wird ein aggregierter Sollzins in Prozent ausgegeben. zinsBindung: type: string example: 5 - 10 Jahre description: Die Zinsbindung wird über alle Darlehen als Intervall in Jahren angegeben. title: Finanzierungsvorschlag description: Ein in BaufiSmart ausgehändigter Finanzierungsvorschlag. FinanzierungsvorschlagHistorienEintrag: type: object properties: akteur: type: string erzeugtAm: type: string format: date-time title: FinanzierungsvorschlagHistorienEintrag description: "Wird ein Angebot als Finanzierungsvorschlag ausgehändigt, wird ein Eintrag in die Historie geschrieben." Finanzierungswunsch: type: object properties: bausparWuensche: type: array items: $ref: '#/definitions/BausparWunsch' darlehensWuensche: type: array items: $ref: '#/definitions/DarlehensWunsch' id: type: string title: Finanzierungswunsch Flurstueck: type: object properties: anteil: $ref: '#/definitions/MiteigentumsAnteil' flur: type: string flurstuecksNummer: type: string groesse: type: number title: Flurstueck ForwardDarlehensWunsch: type: object properties: auszahlungsDatum: type: string format: date bereitstellungsZinsFreieZeitInMonaten: type: integer format: int32 darlehensBetrag: type: number provision: type: number sondertilgungOptionalJaehrlich: type: number tilgungsWunsch: $ref: '#/definitions/TilgungsWunsch' zinsBindungInJahren: type: integer format: int32 title: ForwardDarlehensWunsch Gebaeude: type: object properties: anzahlDerGewerbeeinheiten: type: integer format: int32 anzahlDerWohneinheitenImGebaeude: type: integer format: int32 anzahlVollgeschosse: type: integer format: int32 aufbauFinanzierung: type: boolean aufzugVorhanden: type: boolean ausstattung: type: string enum: - EINFACH - GEHOBEN - MITTEL - STARK_GEHOBEN baujahr: type: string example: "2016" description: Baujahr des Gebäudes. Bei Verwendungszweck != NEUBAU 2016 bauweise: type: string enum: - FACHWERK_MIT_STROH_LEHM - FACHWERK_MIT_ZIEGELN - GLAS_STAHL - HOLZ - MASSIV bezeichnungWohneinheit: type: string dachgeschossAusbau: type: string enum: - FLACHDACH - NICHT_AUSGEBAUT - TEILWEISE_AUSGEBAUT - VOLL_AUSGEBAUT einliegerwohnungVorhanden: type: boolean energieEffizienzAusweis: $ref: '#/definitions/EnergieEffizienzAusweis' geschossLage: type: string enum: - AB_SECHSTES_OBERGESCHOSS - DRITTES_BIS_FUENFTES_OBERGESCHOSS - ERDGESCHOSS - ERSTES_OBERGESCHOSS - UNBEKANNT - UNTERGESCHOSS - ZWEITES_OBERGESCHOSS gewerbeflaeche: $ref: '#/definitions/GebaeudeFlaeche' hausAnordnung: type: string enum: - FREISTEHEND - KOPFHAUS - MITTELHAUS hausTyp: type: string enum: - DOPPELHAUSHAELFTE - EINFAMILIENHAUS - MEHRFAMILIENHAUS - REIHENHAUS - ZWEIFAMILIENHAUS istFertighaus: type: boolean kellerausbau: type: string enum: - AUSGEBAUT - TEILWEISE_AUSGEBAUT - VORHANDEN kubatur: type: number miteigentumsAnteil: $ref: '#/definitions/MiteigentumsAnteil' modernisierungsAngaben: $ref: '#/definitions/ModernisierungsAngaben' unterkellerung: type: string enum: - NICHT_UNTERKELLERT - TEILWEISE_UNTERKELLERT - UNTERKELLERT wohnflaeche: $ref: '#/definitions/GebaeudeFlaeche' zustand: type: string enum: - GUT - MAESSIG - MITTEL - SCHLECHT - SEHR_GUT title: Gebaeude GebaeudeFlaeche: type: object properties: gesamtGroesse: type: number vermietungsInformationen: $ref: '#/definitions/VermietungsInformationen' title: GebaeudeFlaeche GemerkteAngeboteResource: type: object properties: _links: $ref: '#/definitions/Links' gemerkteAngeboteExperimentell: type: array items: $ref: '#/definitions/Angebot' title: GemerkteAngeboteResource GrundbuchAngabe: type: object properties: amtsgericht: type: string description: Bezirk/Bezeichnung des zuständigen Amtsgerichts anmerkungen: type: string bandUndBlatt: type: string description: Angabe von Band und Blatt flurstuecke: type: array items: $ref: '#/definitions/Flurstueck' ort: type: string description: Ort des als Grundbuchamt zuständigen Amtsgerichts rechteInAbteilung2: description: "Belastungen und Beschränkungen in der Nutzbarkeit des Grundstücks. Leitungsrechte, Verzichte auf Abstandsflächen, Wegerechte, Insolvenzvermerke." $ref: '#/definitions/RechteAbteilung2' title: GrundbuchAngabe Grundstueck: type: object properties: groesse: type: number grundstuecksArt: type: string enum: - LANDWIRTSCHAFTLICHES_GRUNDSTUECK - SONSTIGES_GRUNDSTUECK - UNBEBAUTES_GEWERBEGRUNDSTUECK - UNBEBAUTES_MISCHGRUNDSTUECK - UNBEBAUTES_WOHNGRUNDSTUECK title: Grundstueck Haushalt: type: object properties: antragsteller: type: array items: $ref: '#/definitions/Antragsteller' anzahlErwachseneImHaushalt: type: integer format: int32 anzahlKinderNichtImHaushalt: type: integer format: int32 bestehendeImmobilien: type: array items: $ref: '#/definitions/BestehendeImmobilie' id: type: string kfzAnzahl: type: integer format: int32 kinder: type: array items: $ref: '#/definitions/Kind' lebenshaltungsKostenMonatlich: type: number obligo: description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." $ref: '#/definitions/VermoegenVerbindlichkeiten' positionen: $ref: '#/definitions/HaushaltsPositionen' title: Haushalt HaushaltsPositionen: type: object properties: bankUndSparguthaben: type: array items: $ref: '#/definitions/BankUndSparguthaben' bausparvertraege: type: array items: $ref: '#/definitions/BestehenderBausparvertrag' ehegattenUnterhalt: type: array items: $ref: '#/definitions/EinnahmenMonatlich' einkuenfteAusNebentaetigkeit: type: array items: $ref: '#/definitions/EinkuenfteAusNebentaetigkeit' kindergeld: type: array description: Read-Only-Feld. Wird dynamisch aus den Angaben zu den Kindern berechnet. Pro kindergelderhaltendem Kind ein Listenelement. items: $ref: '#/definitions/EinnahmenMonatlich' lebensUndRentenVersicherungen: type: array items: $ref: '#/definitions/LebensOderRentenversicherungVermoegen' mietAusgaben: type: array items: $ref: '#/definitions/MietAusgaben' privateDarlehen: type: array items: $ref: '#/definitions/Verbindlichkeit' privateKrankenversicherung: type: array items: $ref: '#/definitions/AusgabenMonatlich' ratenkredite: type: array items: $ref: '#/definitions/Verbindlichkeit' sonstigeAusgaben: type: array items: $ref: '#/definitions/AusgabenMonatlich' sonstigeEinnahmen: type: array items: $ref: '#/definitions/EinnahmenMonatlich' sonstigeVerbindlichkeiten: type: array items: $ref: '#/definitions/Verbindlichkeit' sonstigeVermoegen: type: array items: $ref: '#/definitions/Vermoegen' sparplaene: type: array items: $ref: '#/definitions/Sparplaene' unbefristeteZusatzRenten: type: array items: $ref: '#/definitions/EinnahmenMonatlich' unterhaltsVerpflichtungen: type: array items: $ref: '#/definitions/AusgabenMonatlich' variableEinkuenfte: type: array items: $ref: '#/definitions/EinnahmenMonatlich' versicherungsAusgaben: type: array items: $ref: '#/definitions/AusgabenMonatlich' wertpapiere: type: array items: $ref: '#/definitions/Wertpapiere' title: HaushaltsPositionen ImmobilieVerknuepfung: type: object properties: id: type: string title: ImmobilieVerknuepfung KfwDarlehensWunsch: type: object properties: darlehensBetrag: type: number kfwEndfaellig: type: string description: Für endfällige KfW-Darlehen wird die Quelle des Tilgungswunsches erfasst enum: - ENDFAELLIG_BERECHNET - ENDFAELLIG_EIGENES_ANGEBOT - NEIN kfwEnergieEffizienzGruppe: type: string description: "Nur bei Programm 153, 261. Der Client muss mit unbekannten Werten umgehen können." enum: - NEUBAU - SANIERUNG - STANDARD kfwEnergieEffizienzStandard: type: string description: "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." enum: - KLIMAFREUNDLICH_QNG - KLIMAFREUNDLICH_STANDARD - STANDARD_100 - STANDARD_100_EEK - STANDARD_40 - STANDARD_40_EEK - STANDARD_40_NH - STANDARD_40_PLUS - STANDARD_55 - STANDARD_55_EEK - STANDARD_70 - STANDARD_70_EEK - STANDARD_85 - STANDARD_85_EEK - STANDARD_DENKMAL - STANDARD_DENKMAL_EEK kfwProgramm: type: string description: Bei neu aufgelegten KfW-Programmen können auch weitere Werte zulässig werden. Der Client muss daher mit unbekannten Werten umgehen können. enum: - PROGRAMM_124 - PROGRAMM_141 - PROGRAMM_151 - PROGRAMM_152 - PROGRAMM_153 - PROGRAMM_155 - PROGRAMM_159 - PROGRAMM_167 - PROGRAMM_261 - PROGRAMM_262 - PROGRAMM_297 - PROGRAMM_298 - PROGRAMM_300 kfwSanierungsFahrplanLiegtVor: type: boolean description: Nur bei Programm 261. laufzeitInJahren: type: integer format: int32 provision: type: number tilgungsWunsch: description: Für endfällige KfW-Darlehen wird ein Tilgungswunsch erfasst $ref: '#/definitions/TilgungsWunsch' tilgungsfreieAnlaufjahre: type: integer format: int32 description: "Erlaubt ist 1, 2, 3, 4, 5. Maximalwert abhängig von der Laufzeit. Wenn der Tilgungswunsch ausgesetzt ist, dann ist auch 10 erlaubt." zinsBindungInJahren: type: integer format: int32 description: "Programm 124: 5 oder 10, sonst: 10 oder 20" title: KfwDarlehensWunsch Kind: type: object properties: geburtsdatum: type: string format: date id: type: string kindergeldWirdBezogen: type: boolean name: type: string unterhaltsEinnahmenBetragMonatlich: type: number title: Kind LeadTracking: type: object properties: kampagne: type: string keyword: type: string kundenBetreuerBenachrichtigen: type: boolean trackingId: type: string title: LeadTracking LebensOderRentenversicherungVermoegen: type: object properties: id: type: string maximalAufzuloesenderBetrag: type: number praemieMonatlich: type: number rueckkaufsWertAktuell: type: number tarif: type: string typ: type: string enum: - FONDSGEBUNDENE_LEBENSVERSICHERUNG - FONDSGEBUNDENE_RENTENVERSICHERUNG - KAPITALBILDENDE_LEBENSVERSICHERUNG - KAPITALBILDENDE_RENTENVERSICHERUNG - RISIKO_LEBENSVERSICHERUNG vermoegensEinsatz: type: string enum: - ABTRETEN - AUFLOESEN - KEIN_EINSATZ vermoegensTyp: type: string description: Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium enum: - VERBINDLICHKEIT - VERMOEGEN versicherungsGesellschaft: type: string versicherungsSumme: type: number vertragsBeginn: type: string format: date vertragsEnde: type: string format: date vertragsNummer: type: string verwaltungsgebuehrenJaehrlich: type: number zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME title: LebensOderRentenversicherungVermoegen LegitimationsDaten: type: object properties: ausstellendeBehoerde: type: string ausstellungsdatum: type: string format: date ausweisArt: type: string enum: - ANDERE - PERSONALAUSWEIS - REISEPASS ausweisArtBeiAndererAusweis: type: string description: Nur wenn ausweisArt = ANDERE ausweisNummer: type: string title: LegitimationsDaten Link: type: object properties: href: type: string type: type: string title: Link Links: type: object properties: self: $ref: '#/definitions/Link' title: Links Meldung: type: object properties: kategorie: type: string description: Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können. enum: - ANPASSUNG_KUNDENWUNSCH - ANPASSUNG_VERTRIEBSWUNSCH - AUSZAHLUNGS_VORAUSSETZUNG - KONDITIONEN_UNTER_VORBEHALT_EXTERNER_SCHNITTSTELLEN - KONDITIONEN_UNTER_VORBEHALT_VOLLSTAENDIGER_DATEN - MACHBAR - MACHBARKEITS_HINWEIS - MACHBARKEIT_UNTER_VORBEHALT_EXTERNER_SCHNITTSTELLEN - MACHBARKEIT_UNTER_VORBEHALT_VOLLSTAENDIGER_DATEN - MACHBAR_UNTER_VORBEHALT_PRODUZENT - NICHT_ANBIETBAR - NICHT_MACHBAR - UNBERUECKSICHTIGTE_ANGABE kreditEntscheider: $ref: '#/definitions/ProduktAnbieter' produktAnbieter: $ref: '#/definitions/ProduktAnbieter' text: type: string title: Meldung MietAusgaben: type: object properties: ausgabenMonatlich: type: number berechnungsHilfeVermoegen: $ref: '#/definitions/BerechnungsHilfeBetrag' entfallenMitFinanzierung: type: boolean zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME title: MietAusgaben MiteigentumsAnteil: type: object properties: anteil: type: number format: double gesamt: type: integer format: int32 title: MiteigentumsAnteil ModernisierungsAngaben: type: object properties: badWc: type: boolean bodenWandTreppe: type: boolean dach: type: boolean fenster: type: boolean heizungZentral: type: boolean modernisierungsGrad: type: string enum: - GERING - HOCH - MITTEL modernisierungsJahr: type: string raumaufteilung: type: boolean stromAbwasserHeizkoerper: type: boolean waermedaemmung: type: boolean wurdeModernisiert: type: boolean title: ModernisierungsAngaben NachrangigesExternesDarlehen: type: object properties: darlehensBetrag: type: number darlehensGeber: type: string description: Der Name des externen Darlehensgebers (Firmierung). Es gibt keine entsprechende Beziehung zu einem Partner auf der Europace-Plattform. id: type: string laufzeitEnde: type: string format: date description: "Wenn die Laufzeit bei einem externen Darlehen angegeben wurde, dann ist das Feld gesetzt." rateMonatlich: type: number typ: type: string description: Neue Ausprägungen können kurzfristig hinzukommen. Der Client muss daher mit unbekannten Werten umgehen können. enum: - ARBEITGEBERDARLEHEN - BAUSPARDARLEHEN - OEFFENTLICHES_DARLEHEN - RATENKREDIT zinsBindung: $ref: '#/definitions/ZinsBindung' title: NachrangigesExternesDarlehen Nachricht: type: object required: - text properties: text: type: string description: Inhalt der Nachricht minLength: 1 maxLength: 500 title: Nachricht PaginationLinks: type: object properties: next: $ref: '#/definitions/Link' prev: $ref: '#/definitions/Link' self: $ref: '#/definitions/Link' title: PaginationLinks Partner: type: object properties: _links: $ref: '#/definitions/Links' anrede: type: string enum: - FRAU - HERR anschrift: $ref: '#/definitions/Postadresse' email: type: string externePartnerId: type: string externerKreditSachbearbeiterId: type: string fax: type: string firmenNameZusatz: type: string firmierung: type: string geburtsdatum: type: string format: date id: type: string kreditsachbearbeiter: type: boolean mobilTelefon: type: string nachname: type: string partnerId: type: string telefonnummer: type: string vertriebsOrganisation: $ref: '#/definitions/VertriebsOrganisation' vorname: type: string webseite: type: string title: Partner description: "Minimale Informationen zum Partner der EP2 Plattform, weitere Informationen können über die HAL-Relation abgerufen werden." Partner0: type: object properties: anrede: type: string enum: - FRAU - HERR anschrift: $ref: '#/definitions/Postadresse' email: type: string externePartnerId: type: string externerKreditSachbearbeiterId: type: string fax: type: string firmenNameZusatz: type: string firmierung: type: string geburtsdatum: type: string format: date id: type: string kreditsachbearbeiter: type: boolean mobilTelefon: type: string nachname: type: string partnerId: type: string telefonnummer: type: string vertriebsOrganisation: $ref: '#/definitions/VertriebsOrganisation' vorname: type: string webseite: type: string title: Partner0 PartnerDTO: type: object properties: partnerId: type: string title: PartnerDTO PatchOperation: type: object required: - op - path - value properties: from: type: string op: type: string description: executed operation enum: - add - copy - move - remove - replace - test path: type: string description: "JSON-Path in Antrag. Valid Paths: /status, /antraege/{vorgangsnummer}/{antragnummer}/{teilantragnummer}/status, /externeVorgangsNummer,/kundenBetreuer/partnerId, /vorgangsBearbeiter/partnerId" value: type: object example: "\"ABC123\", 1234, {\"antragsteller\": \"BEANTRAGT\", \"produktAnbieter\":\"UNTERSCHRIEBEN\"}" description: "Value to be set or replaced. Allows: string, number or JSON object" properties: { } title: PatchOperation description: "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\"}}" Postadresse: type: object properties: hausnummer: type: string ort: type: string postleitzahl: type: string strasse: type: string title: Postadresse PrivatDarlehensWunsch: type: object properties: darlehensBetrag: type: number laufzeitInMonaten: type: integer format: int32 provision: type: number title: PrivatDarlehensWunsch ProduktAnbieter: type: object properties: anrede: type: string enum: - FRAU - HERR anschrift: $ref: '#/definitions/Postadresse' email: type: string externePartnerId: type: string externerKreditSachbearbeiterId: type: string fax: type: string firmenNameZusatz: type: string firmierung: type: string geburtsdatum: type: string format: date id: type: string kreditsachbearbeiter: type: boolean mobilTelefon: type: string nachname: type: string partnerId: type: string produktAnbieterId: type: string telefonnummer: type: string vertriebsOrganisation: $ref: '#/definitions/VertriebsOrganisation' vorname: type: string webseite: type: string title: ProduktAnbieter PruefungVorhandenerAbsicherung: type: object properties: finanzierungsRisiko: type: string enum: - ARBEITSLOSIGKEIT - ARBEITSUNFAEHIGKEIT - TODESFALL istAusreichendeAbsicherungVorhanden: type: boolean zusaetzlicheKommentare: type: string title: PruefungVorhandenerAbsicherung RechteAbteilung2: type: object properties: beschreibung: type: string betrag: type: number vorhanden: type: boolean title: RechteAbteilung2 RegionalFoerderDarlehensWunsch: type: object properties: darlehensBetrag: type: number laufzeitInJahren: type: integer format: int32 description: "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: type: number regionalFoerderbankProgramm: type: string description: 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. enum: - L_BANK_KOMBI_DARLEHEN_WOHNEN - L_BANK_WOHNEN_MIT_KIND - L_BANK_WOHNEN_MIT_ZUKUNFT - NRW_BANK_GEBAEUDESANIERUNG - NRW_BANK_NACHHALTIG_WOHNEN - NRW_BANK_WOHNEIGENTUM tilgungsfreieAnlaufjahre: type: integer format: int32 description: "Erlaubt sind 1, 2, 3, 4 oder 5 Jahre. Der Maximalwert ist abhängig von der Laufzeit." zinsBindungInJahren: type: integer format: int32 description: "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." title: RegionalFoerderDarlehensWunsch RisikoAbsicherung: type: object properties: abgesichertesRisiko: type: string enum: - ARBEITSLOSIGKEIT - ARBEITSUNFAEHIGKEIT - ASSISTANCE_ARBEITSLOSIGKEIT - ASSISTANCE_ARBEITSUNFAEHIGKEIT - INVALIDITAET - SCHWERE_KRANKHEIT - TODESFALL auszahlungsBetrag: type: number auszahlungsTurnus: type: string enum: - EINMALIG - HALBJAEHRLICH - JAEHRLICH - MONATLICH - VIERTELJAEHRLICH praemienAnteil: type: number title: RisikoAbsicherung RisikoAbsicherungsWunsch: type: object properties: abzusicherndesRisiko: type: string enum: - ARBEITSLOSIGKEIT - ARBEITSUNFAEHIGKEIT - TODESFALL versicherteRate: type: number description: "nur bei abzusicherndesRisiko==ARBEITSUNFAEHIGKEIT,ARBEITSLOSIGKEIT" versicherungsSumme: type: number description: nur bei abzusicherndesRisiko==TODESFALL title: RisikoAbsicherungsWunsch SchufaErgebnis: type: object properties: antragstellerUnbekannt: type: boolean description: Der Antragsteller ist bei der Schufa unbekannt. inManuellerNachbehandlung: type: boolean description: "Die Ermittlung des Schufa-Scores verzögert sich, wenn sich die Anfrage bei der Schufa in manueller Nachbehandlung befindet." score: type: string title: SchufaErgebnis SelfRelAndEreignisse: type: object properties: antraege: $ref: '#/definitions/Link' ereignisse: $ref: '#/definitions/Link' finanzierungsvorschlaege: $ref: '#/definitions/Link' gemerkteAngebote: $ref: '#/definitions/Link' self: $ref: '#/definitions/Link' title: SelfRelAndEreignisse SituationNachRenteneintritt: type: object properties: gesetzlicheRenteMonatlich: type: number privateRenteMonatlich: type: number rentenBeginn: type: string format: date sonstigesEinkommenMonatlich: type: number title: SituationNachRenteneintritt SonderZahlung: type: object properties: anzahl: type: integer format: int32 description: Gesamtanzahl der Zahlungen betrag: type: number description: Betrag in EUR über die Höhe der einzelnen Zahlung termin: type: string format: date description: Termin der Einmalzahlung (optional) oder Beginn der regelmäßigen Zahlungen zahlweise: type: string description: Festlegung von einmaligen oder regelmäßigen Zahlungen enum: - EINMALIG - HALBJAEHRLICH - JAEHRLICH - MONATLICH - VIERTELJAEHRLICH title: SonderZahlung SparPhase: type: object properties: guthabenBeiZuteilung: type: number sparBeitragMonatlich: type: number sparPhaseInJahren: type: integer format: int32 title: SparPhase Sparplaene: type: object properties: aktuellerWert: type: number beitragMonatlich: type: number ertrag: type: number maximalAufzuloesenderWert: type: number vermoegensEinsatz: type: string enum: - ABTRETEN - AUFLOESEN - KEIN_EINSATZ vermoegensTyp: type: string description: Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium enum: - VERBINDLICHKEIT - VERMOEGEN zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME zukuenftigeEinnahmen: type: number title: Sparplaene Staat: type: object properties: isoCountryCode: type: string description: ISO 3166-1 alpha-2 code name: type: string title: Staat StatusDTO: type: object required: - antragsteller - produktAnbieter properties: antragsteller: type: string enum: - BEANTRAGT - NICHT_ANGENOMMEN - UNTERSCHRIEBEN - WIDERRUFEN antragstellerAblehnungsgrund: type: string enum: - ANDERER_GRUND - ANDERES_ANGEBOT_ANGENOMMEN - ANGEBOT_WETTBEWERBER - BEARBEITUNGSZEIT - FINANZIERUNG_WIRD_ANGEPASST - KONDITIONEN_UNPASSEND - KUNDE_NICHT_ERREICHBAR - OBJEKT_NICHT_INTERESSANT - OBJEKT_NICHT_VERFUEGBAR kommentar: type: string produktAnbieter: type: string enum: - ABGELEHNT - NICHT_BEARBEITET - UNTERSCHRIEBEN - ZURUECKGESTELLT produktanbieterAblehnungsgrund: type: string enum: - FINANZIELLE_SITUATION - GEGENANGEBOT - KEINE_ANGABE - KRITERIEN - NEGATIV_MERKMAL - UNTERLAGEN_UNVOLLSTAENDIG - WERTERMITTLUNG title: StatusDTO Tilgung: type: object properties: anfaenglicheTilgung: type: number description: "wenn null oder 0: tilgungsausgesetzt" sonderTilgungJaehrlich: type: number description: "nur wenn darlehensArt IN [ANNUITAETEN_DARLEHEN,FORWARD_DARLEHEN] und KEIN tilgungsErsatz" tilgungsBeginnAm: type: string format: date description: nullable tilgungsErsatz: description: nicht bei PRIVAT_DARLEHEN $ref: '#/definitions/TilgungsErsatz' title: Tilgung TilgungsErsatz: type: object properties: id: type: string description: "Id des Tilgungsersatzproduktes, das in den Vermögenswerten des Haushalts oder in den Bausparangeboten des Angebotes zu finden ist." typ: type: string description: "Menschenlesbarer Hinweis auf den Typ, z.B. BAUSPARVERTRAG oder KAPITALBILDENDE_LEBENSVERSICHERUNG" title: TilgungsErsatz TilgungsPhase: type: object properties: bausparDarlehenSumme: type: number sollZinsNachZuteilung: type: number tilgungsBeitragMonatlich: type: number tilgungsPhaseInJahren: type: integer format: int32 title: TilgungsPhase TilgungsWunsch: type: object properties: anfaenglicheTilgung: type: number description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" ausgesetztBerechnet: type: boolean description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" ausgesetztEigenesAngebot: type: boolean description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" bausparWunsch: $ref: '#/definitions/BausparWunsch' rate: type: number description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" tilgungsBeginn: type: string format: date tilgungsErsatzProduktId: type: string volltilgerWennAnnuitaetenOderForward: type: boolean description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" title: TilgungsWunsch VariablesDarlehensWunsch: type: object properties: darlehensBetrag: type: number provision: type: number tilgungsWunsch: $ref: '#/definitions/TilgungsWunsch' title: VariablesDarlehensWunsch Verbindlichkeit: type: object properties: glaeubiger: type: string laufzeitEnde: type: string format: date rateMonatlich: type: number restschuld: type: number vermoegensTyp: type: string description: Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium enum: - VERBINDLICHKEIT - VERMOEGEN wirdAbgeloest: type: boolean zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME title: Verbindlichkeit VermietungsInformationen: type: object properties: mieteinnahmenNettoKaltMonatlich: type: number nutzungsArt: type: string enum: - EIGENGENUTZT - TEIL_VERMIETET - VERMIETET vermieteteFlaeche: type: number title: VermietungsInformationen Vermoegen: type: object properties: aktuellerWert: type: number ertrag: type: number maximalAufzuloesenderWert: type: number vermoegensEinsatz: type: string enum: - ABTRETEN - AUFLOESEN - KEIN_EINSATZ vermoegensTyp: type: string description: Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium enum: - VERBINDLICHKEIT - VERMOEGEN zukuenftigeEinnahmen: type: number title: Vermoegen VermoegenVerbindlichkeit: type: object properties: aktuellerWert: type: number anrechnungFuerBlankoAnteil: type: number bezeichner: type: string kontonummer: type: string vermoegensTyp: type: string enum: - VERBINDLICHKEIT - VERMOEGEN title: VermoegenVerbindlichkeit VermoegenVerbindlichkeiten: type: object properties: vermoegenOderVerbindlichkeiten: type: array items: $ref: '#/definitions/VermoegenVerbindlichkeit' title: VermoegenVerbindlichkeiten VersicherungsWunsch: type: object properties: finanzierungsWeise: type: string description: nur bei praemienZahlungsweise==EINMALIG enum: - DURCH_HAUPTDARLEHEN - INDIVIDUELL id: type: string praemienZahlungsweise: type: string enum: - EINMALIG - HALBJAEHRLICH - JAEHRLICH - MONATLICH - VIERTELJAEHRLICH risikoAbsicherungsWuensche: type: array items: $ref: '#/definitions/RisikoAbsicherungsWunsch' versichertePersonId: type: string versicherungsArt: type: string enum: - RATENSCHUTZVERSICHERUNG versicherungsBeginn: type: string format: date versicherungsDauerInMonaten: type: integer format: int32 title: VersicherungsWunsch VersicherungsZeitraum: type: object properties: beginn: type: string format: date dauerInMonaten: type: integer format: int32 ende: type: string format: date title: VersicherungsZeitraum VertriebsOrganisation: type: object properties: firma: type: string name: type: string vertriebsOrganisationsId: type: string title: VertriebsOrganisation Vorgaenge: type: object properties: _links: $ref: '#/definitions/PaginationLinks' vorgaenge: type: array items: $ref: '#/definitions/VorgaengeResourceListItem' title: Vorgaenge VorgaengeResourceListItem: type: object properties: _links: $ref: '#/definitions/Links' datenKontext: type: string enum: - ECHT_GESCHAEFT - TEST_MODUS externeVorgangsNummer: type: string letzteAenderung: type: string format: date-time letztesEreignis: type: string format: date-time vorgangsNummer: type: string title: VorgaengeResourceListItem Vorgang: type: object properties: _links: $ref: '#/definitions/SelfRelAndEreignisse' antraege: type: array items: $ref: '#/definitions/Links' archivierung: $ref: '#/definitions/Archivierung' aufbewahrungBis: type: string format: date description: "Datum, bis wann dieser Vorgang nach DSGVO aufbewahrt werden muss. Nach diesem Datum wird der Vorgang automatisch gelöscht." bankverbindung: $ref: '#/definitions/Bankverbindung' datenKontext: type: string enum: - ECHT_GESCHAEFT - TEST_MODUS erstelltAm: type: string format: date externeVorgangsNummer: type: string finanzierungsObjekt: $ref: '#/definitions/FinanzierungsObjekt' geschlossenAm: type: string format: date haushalte: type: array items: $ref: '#/definitions/Haushalt' importQuelle: type: string kundenBetreuer: $ref: '#/definitions/Partner' leadTracking: $ref: '#/definitions/LeadTracking' letztesEreignis: type: string format: date-time phase: type: string prioritaet: type: string description: "Priorität des Vorgangs, Werte: [NIEDRIG,NEUTRAL,HOCH]" enum: - HOCH - NEUTRAL - NIEDRIG status: type: string description: "Status des Vorgangs, Werte: [AKTIV,ARCHIVIERT]" tippGeber: $ref: '#/definitions/Partner0' vorgangsBearbeiter: $ref: '#/definitions/Partner' vorgangsNummer: type: string vorhaben: $ref: '#/definitions/Vorhaben' title: Vorgang Vorhaben: type: object properties: absicherungswunsch: $ref: '#/definitions/Absicherungswunsch' eigenleistungWennNeubauOderModernisierungsmassnahmen: type: number externeBausparAngebote: type: array items: $ref: '#/definitions/BausparAngebot' finanzbedarf: $ref: '#/definitions/Finanzbedarf' finanzierungswunsch: $ref: '#/definitions/Finanzierungswunsch' id: type: string nachfinanzierung: type: boolean nachrangigeExterneDarlehen: type: array items: $ref: '#/definitions/NachrangigesExternesDarlehen' verwendungszweck: type: string enum: - ANSCHLUSSFINANZIERUNG - KAPITALBESCHAFFUNG - KAUF - KAUF_NEUBAU_VOM_BAUTRAEGER - MODERNISIERUNG_UMBAU_ANBAU - NEUBAU title: Vorhaben Wertpapiere: type: object properties: aktuellerWert: type: number dividendenJaehrlich: type: number ertrag: type: number maximalAufzuloesenderWert: type: number vermoegensEinsatz: type: string enum: - ABTRETEN - AUFLOESEN - KEIN_EINSATZ vermoegensTyp: type: string description: Redundante Angabe des Vermögenstyp dient als zusätzliches Filterkriterium enum: - VERBINDLICHKEIT - VERMOEGEN zahlungsTyp: type: string description: Redundante Angabe des Zahlungstyps dient als zusätzliches Filterkriterium enum: - AUSGABE - EINNAHME zukuenftigeEinnahmen: type: number title: Wertpapiere Zahlungsplaene: type: object properties: _links: $ref: '#/definitions/Links' zahlungsplaene: type: array items: $ref: '#/definitions/Zahlungsplan' title: Zahlungsplaene description: Diese Resource repräsentiert die Zahlungsplaene eines Angebots. Zahlungsplan: type: object properties: gesamtSumme: $ref: '#/definitions/Eintrag' identifier: type: string zahlungen: type: array items: $ref: '#/definitions/Eintrag' title: Zahlungsplan description: "Ein Zahlungsplan, welcher die Monatlichen Zahlungen zu einem Darlehen oder Bausparvertrag enthält." ZinsBindung: type: object properties: endetAm: type: string format: date jahre: type: integer format: int32 monate: type: integer format: int32 restschuldNachZinsBindungsEnde: type: number title: ZinsBindung ZugrundeliegendeDatenZumAntrag: type: object properties: _links: $ref: '#/definitions/Links' bankverbindung: $ref: '#/definitions/Bankverbindung' finanzierungsObjekt: $ref: '#/definitions/FinanzierungsObjekt' haushalte: type: array items: $ref: '#/definitions/Haushalt' vorhaben: $ref: '#/definitions/Vorhaben' title: ZugrundeliegendeDatenZumAntrag ZwischenFinanzierungsWunsch: type: object properties: darlehensBetrag: type: number detailsZurVerwendung: type: string maximaleLaufzeitInMonaten: type: integer format: int32 provision: type: number verwendungszweck: type: string enum: - SONSTIGE_VERWENDUNG - VERKAUF_EINES_ANDEREN_OBJEKTS - VORFINANZIERUNG_OEFFENTLICHER_MITTEL title: ZwischenFinanzierungsWunsch