openapi: 3.0.1 info: contact: email: devsupport@europace2.de name: Europace AG url: https://developer.europace.de description: Ein Service um eine Ergebnisliste mit Finanzierungsvorschlägen zu ermitteln termsOfService: https://docs.api.europace.de/nutzungsbedingungen/ title: Angebote API version: 3.0.18 externalDocs: url: https://docs.api.europace.de/baufinanzierung/angebote/angebote-api/ servers: - description: Produktionsserver url: https://baufinanzierung.api.europace.de tags: - description: "Eine Liste mit Finanzierungsvorschlägen abrufen, API-Version 3" name: Version 3 - description: Liefert die Version der BaufiSmart-API name: VersionController - description: "Eine Liste mit Finanzierungsvorschlägen abrufen, API-Version 1" name: Version 1 - description: "Eine Liste mit Finanzierungsvorschlägen abrufen, API-Version 2" name: Version 2 paths: /v1/finanzierungsvorschlaege: post: description: Als Parameter wird der Vorgang als JSON im Body benötigt operationId: getFinanzierungsVorschlaege parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: query name: alternativen required: false schema: type: boolean default: false - in: query name: produktAnbieter required: false schema: type: array items: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ErfassteDaten" required: true responses: "200": content: application/json: schema: type: string description: OK "400": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Request "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ermittle Ergebnisse tags: - Version 1 /v1/finanzierungsvorschlaege/{vorgangsNummer}: get: description: Als Parameter wird eine Vorgangsnummer benötigt operationId: getFinanzierungsVorschlaege_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsNummer required: true schema: type: string - in: query name: produktAnbieter required: false schema: type: array items: type: string - in: query name: alternativen required: false schema: type: boolean default: false responses: "200": content: application/json: schema: type: string description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ermittle Ergebnisse tags: - Version 1 /v2/ergebnisliste/ermittlung: post: description: Als Parameter wird eine Vorgangsnummer oder der Vorgang als JSON im Body benötigt operationId: ermittleErgebnisse_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: query name: vorgangsNummer required: false schema: type: string - in: query name: alternativen required: false schema: type: boolean default: false - in: query name: produktAnbieter required: false schema: type: array items: type: string - in: query name: excludierteProduktAnbieter required: false schema: type: array items: type: string - in: query name: provisionsAusgabe required: false schema: type: boolean requestBody: content: application/json: schema: $ref: "#/components/schemas/ErfassteDaten" responses: "302": description: Die Ermittlung wurde erzeugt und ist maximal eine Stunde unter der Url im 'location' Header abrufbar. "400": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Request "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ermittlung erzeugen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}: get: description: Die Ermittlung abrufen. Als Parameter wird die Ermittlungs-Id benötigt. operationId: getErmittlung parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Ermittlung" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ermittlung abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ergebnisse: get: description: Als Parameter wird die Ermittlungs-Id benötigt. operationId: getErgebnisListe_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ErgebnisListe" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ergebnisse abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ergebnisse/{ergebnisNummer}: get: description: Das Ergebnis einer Ermittlung abrufen. Als Parameter wird die Ermittlungs-Id und der Ergebnisnummer benötigt. operationId: getErgebnis_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisNummer required: true schema: type: integer format: int32 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Ergebnis" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ergebnis abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ergebnisse/{ergebnisNummer}/meldungen: get: description: Die Meldungen eines Finanzierungsvorschlags abrufen. Als Parameter wird die Ermittlungs-Id und die Ergebnisnummer benötigt. operationId: getMeldungen_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisNummer required: true schema: type: integer format: int32 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Meldungen" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Meldungen abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ergebnisse/{ergebnisNummer}/provision: get: description: Abruf der Provision des Darlehens. Als Parameter wird die Ermittlungs-Id und die Ergebnisnummer benötigt. operationId: getProvision_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisNummer required: true schema: type: integer format: int32 - in: query name: repeat required: false schema: type: integer format: int32 default: 0 responses: "200": content: application/json: schema: $ref: "#/components/schemas/ProvisionsInfo" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Provision abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ergebnisse/{ergebnisNummer}/unterlagen: get: description: Abrufen der benötigten Unterlagen des Finanzierungsvorschlags. Als Parameter wird die Ermittlungs-Id und die Ergebnisnummer benötigt. operationId: getUnterlagen_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisNummer required: true schema: type: integer format: int32 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Unterlagen" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Unterlagen abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ergebnisse/{ergebnisNummer}/zahlungsplaene: get: description: Die Zahlungspläne eines Finanzierungsvorschlags abrufen. Als Parameter wird die Ermittlungs-Id und die Ergebnisnummer benötigt. operationId: getZahlungsplaene_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisNummer required: true schema: type: integer format: int32 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Zahlungsplaene" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Zahlungspläne abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ergebnisse/{ergebnisNummer}/zahlungsplaene/{zahlungsplanIndex}: get: description: "Den Zahlungsplan eines Finanzierungsvorschlags anhand einer Id\ \ abrufen. Als Parameter wird die Ermittlungs-Id, die Ergebnisnummer sowie\ \ der Index des Zahlungsplans benötigt." operationId: getZahlungsplan_1 parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisNummer required: true schema: type: integer format: int32 - in: path name: zahlungsplanIndex required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/Zahlungsplan" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Zahlungsplan abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ermittlungsAnfrage: get: description: Die Ermittlungsanfrage einer Ermittlung abrufen. Als Parameter wird die Ermittlungs-Id benötigt. operationId: getErmittlungsAnfrage parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ErmittlungsAnfrage" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ermittlungsanfrage abrufen tags: - Version 2 /v2/ergebnisliste/ermittlung/{ermittlungsId}/ermittlungsAnfrage/erfassteDaten: get: description: Die Ermittlungsanfrage abrufen. Als Parameter wird die Ermittlungs-Id benötigt. operationId: getErfassteDaten parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: ermittlungsId required: true schema: type: string pattern: "^[A-Z0-9]{6}" responses: "200": content: application/json: schema: $ref: "#/components/schemas/ErfassteDaten" description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ermittlungsdaten abrufen tags: - Version 2 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste: post: description: Als Parameter wird eine Vorgangsnummer benötigt operationId: ermittleErgebnisse parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" requestBody: content: application/json: schema: $ref: "#/components/schemas/ErmittleErgebnisseRequestBody" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Ergebnisliste" description: Die Ermittlung wurde erzeugt und ist maximal eine Stunde unter der Url im 'location' Header abrufbar. "204": description: Basierend auf dem Parameter gibt es keinen zurückzugebenden Inhalt. "400": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Request "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ermittlung erzeugen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}: get: description: Als Parameter werden die Vorgangsnummer sowie die ErgebnislisteId benötigt. operationId: getErgebnisListe parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Ergebnisliste" description: Die Ergebnisliste wurde gefunden. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ergebnisse abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}/{angebotsnummer}/merken: post: description: "Das Angebot kann gemerkt und gespeichert werden. Als Parameter\ \ werden die vorgangsnummer, die ErgebnislisteId sowie Angebotsnummer benö\ tigt." operationId: merkeAngebot parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: angebotsnummer required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/AngebotMerkenAntwort" description: Angebot gespeichert "400": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Request "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Angebot merken tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}/{ergebnisnummer}: get: description: "Das Ergebnis einer Ermittlung abrufen. Als Parameter werden die\ \ Vorgangsnummer, die ErgebnislisteId sowie der Ergebnisnummer benötigt." operationId: getErgebnis parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisnummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/V3Ergebnis" description: Die Ergebnis wurde gefunden. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Ergebnis abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}/{ergebnisnummer}/berechnungsuebersichten: get: description: "Die Berechnungsübersichten abrufen. Als Parameter werden die Vorgangsnummer,\ \ die ErgebnislisteId sowie der Ergebnisnummer benötigt." operationId: getBerechnungsuebersichten parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisnummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/BerechnungsUebersichten" description: Die berechnungsübersichten wurde gefunden. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Berechnungsübersichten abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}/{ergebnisnummer}/meldungen: get: description: "Die Meldungen eines Finanzierungsvorschlags abrufen. Als Parameter\ \ werden die Vorgangsnummer, die ErgebnislisteId sowie der Ergebnisnummer\ \ benötigt." operationId: getMeldungen parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisnummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Meldungen" description: Die Meldungen eines Finanzierungsvorschlags wurden gefunden. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Meldungen abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}/{ergebnisnummer}/provision: get: description: "Abruf der Provision des Darlehens. Als Parameter werden die Vorgangsnummer,\ \ die ErgebnislisteId sowie die Ergebnisnummer benötigt." operationId: getProvision parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisnummer required: true schema: type: integer format: int32 minimum: 1 - in: query name: repeat required: false schema: type: integer format: int32 default: 0 minimum: 0 responses: "200": content: application/json: schema: $ref: "#/components/schemas/ProvisionsInfo" description: Die Provision des Darlehens wurde gefunden. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Provision abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}/{ergebnisnummer}/unterlagen: get: description: "Abrufen der benötigten Unterlagen des Finanzierungsvorschlags.\ \ Als Parameter werden die Vorgangsnummer, die ErgebnislisteId sowie die Ergebnisnummer\ \ benötigt." operationId: getUnterlagen parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisnummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Unterlagen" description: Die Unterlagen des Finanzierungsvorschlags wurden gefunden. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Unterlagen abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}/{ergebnisnummer}/zahlungsplaene: get: description: "Die Zahlungspläne eines Finanzierungsvorschlags abrufen. Als Parameter\ \ werden die Vorgangsnummer, die ErgebnislisteId sowie der Ergebnisnummer\ \ benötigt." operationId: getZahlungsplaene parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisnummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Zahlungsplaene" description: Die Zahlungspläne wurden gefunden. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Zahlungspläne abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/ergebnisliste/{ergebnislisteId}/{ergebnisnummer}/zahlungsplaene/{zahlungsplanIndex}: get: description: "Den Zahlungsplan eines Finanzierungsvorschlags anhand einer Id\ \ abrufen. Als Parameter werden die vorgangsnummer, die ErgebnislisteId, die\ \ Ergebnisnummer sowie der Index des Zahlungsplans benötigt." operationId: getZahlungsplan parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnislisteId required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: ergebnisnummer required: true schema: type: integer format: int32 minimum: 1 - in: path name: zahlungsplanIndex required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/Zahlungsplan" description: Der Zahlungsplan wurde gefunden. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Zahlungsplan abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/gemerkteangebote: get: description: Gemerkte Angebote abrufen. Als Parameter wird eine Vorgangsnummer benötigt operationId: getGemerkteAngebote parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" responses: "200": content: application/json: schema: type: array items: $ref: "#/components/schemas/V3GemerktesAngebot" description: Die Gemerkte Angebote wurde abrufen. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Gemerkte Angebote abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/gemerkteangebote/{laufendeNummer}: get: description: Abrufen das Gemerkte Angebot. Als Parameter werden die Vorgangsnummer sowie die laufendeNummer benötigt. operationId: getGemerktesAngebot parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: laufendeNummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/V3GemerktesAngebot" description: Das Gemerkte Angebot wurde abrufen. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Gemerktes Angebot abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/gemerkteangebote/{laufendeNummer}/berechnungsuebersichten: get: description: Die Berechnungsuebersichten für gemerkte Angebote abrufen. Als Parameter werden die Vorgangsnummer sowie laufende Nummer des gemerkten Angebots benötigt. operationId: getBerechnungsuebersichtenFuerGemerktesAngebot parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: laufendeNummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/BerechnungsUebersichten" description: Die Berechnungsuebersichten für das gemerkte Angebot wurden abrufen. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Berechnungsuebersichten für gemerkte Angebote abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/gemerkteangebote/{laufendeNummer}/entmerken: post: description: Das Angebot kann entmerkt werden. Als Parameter werden die vorgangsnummer sowie die laufende Nummer des gemerkten Angebots benötigt. operationId: entmerkeAngebot parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: laufendeNummer required: true schema: type: integer format: int32 minimum: 1 responses: "204": description: Angebot erfolgreich entmerkt "400": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Request "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: entmerken tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/gemerkteangebote/{laufendeNummer}/meldungen: get: description: Die Meldungen für gemerkte Angebote abrufen. Als Parameter werden die Vorgangsnummer sowie laufende Nummer des gemerkten Angebots benötigt. operationId: getMeldungenFuerGemerktesAngebot parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: laufendeNummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Meldungen" description: Die Meldungen für das gemerkte Angebot wurden abrufen. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Meldungen für gemerkte Angebote abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/gemerkteangebote/{laufendeNummer}/unterlagen: get: description: Die Unterlagen für gemerkte Angebote abrufen. Als Parameter werden die Vorgangsnummer sowie laufende Nummer des gemerkten Angebots benötigt. operationId: getUnterlagenFuerGemerktesAngebot parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: laufendeNummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Unterlagen" description: Die Unterlagen für das gemerkte Angebot wurden abrufen. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Die Unterlagen für gemerkte Angebote abrufen tags: - Version 3 /v3/vorgaenge/{vorgangsnummer}/gemerkteangebote/{laufendeNummer}/zahlungsplaene: get: description: Die Zahlungspläne für gemerkte Angebote abrufen. Als Parameter werden die Vorgangsnummer sowie laufende Nummer des gemerkten Angebots benötigt. operationId: getZahlungsplaeneFuerGemerktesAngebot parameters: - description: Authorization Bearer Token in: header name: Authorization required: true schema: type: string - in: header name: X-TraceId schema: type: string - in: path name: vorgangsnummer required: true schema: type: string pattern: "^[A-Z0-9]{6}" - in: path name: laufendeNummer required: true schema: type: integer format: int32 minimum: 1 responses: "200": content: application/json: schema: $ref: "#/components/schemas/Zahlungsplaene" description: Die Zahlungspläne für das gemerkte Angebot wurden abrufen. "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout security: - oAuth2: - baufinanzierung:angebot:ermitteln summary: Die Zahlungspläne für gemerkte Angebote abrufen tags: - Version 3 /version/baufiSmartApi: get: operationId: getBaufiSmartApiVersion responses: "200": content: text/plain: schema: type: string description: OK "401": content: application/json: schema: $ref: "#/components/schemas/Error" description: Unauthorized "403": content: application/json: schema: $ref: "#/components/schemas/Error" description: Forbidden "404": content: application/json: schema: $ref: "#/components/schemas/Error" description: Not Found "405": content: application/json: schema: $ref: "#/components/schemas/Error" description: Method Not Allowed "429": content: application/json: schema: $ref: "#/components/schemas/Error" description: Too Many Requests "500": content: application/json: schema: $ref: "#/components/schemas/Error" description: Internal Server Error "502": content: application/json: schema: $ref: "#/components/schemas/Error" description: Bad Gateway "504": content: application/json: schema: $ref: "#/components/schemas/Error" description: Gateway Timeout tags: - VersionController components: headers: tracingIdHeader: description: Eine eindeutige technische Id zur Identifikation des Requests schema: type: string parameters: tracingIdParam: description: Eine eindeutige technische Id zur Identifikation des Requests in: header name: X-TraceId schema: type: string schemas: Absicherung: type: object properties: antragsEntscheider: $ref: "#/components/schemas/ProduktAnbieter" externeAngebotsNummer: type: string gesamtPraemie: type: number praemienZahlungsweise: type: string enum: - MONATLICH - EINMALIG produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" risiken: type: array items: $ref: "#/components/schemas/AbsicherungsRisiko" tarifBezeichnung: type: string tarifKennung: type: string versichertePersonId: type: string versicherungsArt: type: string enum: - RATENSCHUTZVERSICHERUNG versicherungsNummer: type: string versicherungsZeitraum: $ref: "#/components/schemas/AbsicherungsZeitraum" AbsicherungsRisiko: type: object properties: anteilAnPraemie: type: number risikoTyp: type: string enum: - TODESFALL - ARBEITSLOSIGKEIT - ARBEITSUNFAEHIGKEIT - INVALIDITAET - SCHWERE_KRANKHEIT - ASSISTANCE_ARBEITSUNFAEHIGKEIT - ASSISTANCE_ARBEITSLOSIGKEIT versicherungsSumme: type: number AbsicherungsZeitraum: type: object properties: beginn: type: string format: date ende: type: string format: date versicherungsDauerInMonaten: type: integer format: int32 AngebotMerkenAntwort: type: object properties: laufendeNummerAmVorgang: type: integer format: int32 AnnuitaetenDarlehensWunsch: type: object description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" properties: auszahlungsZeitpunkt: type: string format: date bereitstellungsZinsFreieZeitInMonaten: type: integer format: int32 bestehendesDarlehenDerImmobilieIdsBeiAbloesung: type: array description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG items: type: string description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG darlehensBetrag: type: number description: Der Darlehensbetrag muss ein positiver Wert zwischen 1000 und 10 Milliarden sein. provision: type: number riesterGefoerdert: type: boolean riesterGefoerdertePerson: type: string sondertilgungOptionalJaehrlich: type: number tilgungsWunsch: $ref: "#/components/schemas/TilgungsWunsch" zinsBindungInJahren: type: integer format: int32 description: Wert muss größer 0 sein. required: - darlehensBetrag - tilgungsWunsch Antragsteller: type: object properties: anrede: type: string enum: - FRAU - HERR anschrift: $ref: "#/components/schemas/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: - VISUM - AUFENTHALTS_ERLAUBNIS - NIEDERLASSUNGS_ERLAUBNIS - DAUERAUFENTHALT_EU - BLAUE_KARTE_EU aufenthaltsTitelBefristetBis: type: string format: date description: wenn Aufenthaltstitel befristet beschaeftigung: $ref: "#/components/schemas/Beschaeftigung" bruttoJahresEinkommenErwartet: type: number bruttoVorjahresEinkommen: type: number email: type: string example: max.mustermann@test.de familienstand: type: string enum: - GESCHIEDEN - GETRENNT_LEBEND - LEBENSPARTNERSCHAFT - LEDIG - VERHEIRATET - VERWITWET geburtsdatum: type: string format: date geburtsland: $ref: "#/components/schemas/Staat" geburtsort: type: string guetertrennungVereinbartWennVerheiratet: type: boolean description: nur wenn verheiratet id: type: string description: Dient der Referenzierung um beispielsweise Unterlagenanforderungen dem richtigen Antragssteller zuzuordnen. Der Wert kann frei definiert werden. inDeutschlandSeit: type: string format: date legitimationsDaten: $ref: "#/components/schemas/LegitimationsDaten" nachname: type: string privateKrankenversicherungMonatlicheAusgaben: type: number sozialVersicherungsNummer: type: string staatsangehoerigkeit: $ref: "#/components/schemas/Staat" steuerId: type: string telefonnummer: type: string telefonnummerVorwahl: type: string titelDoktor: type: boolean titelProfessor: type: boolean vorAnschrift: $ref: "#/components/schemas/Postadresse" vorname: type: string weitereKontaktMoeglichkeiten: type: string wohnhaftSeit: type: string format: date AusgabenMonatlich: type: object properties: ausgabenMonatlich: type: number Autostellplatz: type: object properties: mieteinnahmenMonatlich: type: number typ: type: string enum: - STELLPLATZ - CARPORT - GARAGE - DOPPEL_GARAGE - KELLER_GARAGE - TIEFGARAGEN_STELLPLATZ vermietet: type: boolean BankUndSparguthaben: type: object properties: aktuellerWert: type: number description: Betrag des aktuellen Bank- und Sparguthaben ertrag: type: number deprecated: true description: 'Das Feld ist Deprecated und wird bis zur Löschung als Fallback für ''maximalAufzuloesenderWert'' benutzt. Zur Angabe des einzusetzenden Vermögens dient das Feld ''maximalAufzuloesenderWert''. ' maximalAufzuloesenderWert: type: number description: Maximal einzusetzender Betrag des Bank- und Sparguthabens vermoegensEinsatz: type: string enum: - KEIN_EINSATZ - ABTRETEN - AUFLOESEN zinsertragJaehrlich: type: number zukuenftigeEinnahmen: type: number 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 BausparAngebot: type: object properties: abschlussGebuehr: type: number abschlussGebuehrenVerrechnung: type: string antragEntscheider: $ref: "#/components/schemas/ProduktAnbieter" bausparDarlehenSumme: type: number bausparSumme: type: number bausparkasse: $ref: "#/components/schemas/ProduktAnbieter" effektivZinsNachZuteilungProzent: type: number europaceMargeAbsolut: type: number gesamtLaufzeitInJahren: type: integer format: int32 guthabenBeiZuteilung: type: number id: type: string provisionAbsolut: type: number sollZinsNachZuteilung: type: number sonderZahlungen: type: array items: $ref: "#/components/schemas/SonderZahlung" sparBeginn: type: string format: date sparBeitragMonatlich: type: number sparPhaseInJahren: type: integer format: int32 tarif: type: string teilBausparSumme: type: number tilgungsBeitragMonatlich: type: number tilgungsPhaseInJahren: type: integer format: int32 vertragsBeginn: type: string format: date vertragsNummer: type: string vertragsPartnerIds: type: array items: type: string verwaltungsgebuehrenJaehrlich: type: number zuteilungsDatum: type: string format: date zuteilungsDatum2: type: string format: date BausparAngebotExtern: type: object properties: abschlussGebuehr: type: number angebotsHinweisFuerAntragsteller: type: string bausparSumme: type: number id: type: string produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" sonderZahlungen: type: array items: $ref: "#/components/schemas/SonderZahlung" sparBeginn: type: string format: date sparPhase: $ref: "#/components/schemas/SparPhase" tarif: type: string tilgungsPhase: $ref: "#/components/schemas/TilgungsPhase" typ: type: string vertragsBeginn: type: string format: date vertragsNummer: type: string verwaltungsgebuehrenJaehrlich: type: number zuteilungsDatum: type: string format: date BausparWunsch: type: object description: "Von den Feldern bausparSummeAbsolut, bausparSummeRelativ, sparBeitragMonatlichAbsolut,\ \ sparBeitragMonatlichRelativ, tilgungsBeitragMonatlich, zuteilungsDatum und\ \ sparBeginn können maximal drei befüllt werden." properties: abschlussGebuehrenVerrechnung: type: string enum: - SOFORTZAHLUNG - VERRECHNUNG bausparSummeAbsolut: type: number bausparSummeRelativ: type: number bausparTarife: type: array description: siehe weitere Beschreibung unter Weitere Informationen -> Bezeichnung Bauspartarife items: type: string description: siehe weitere Beschreibung unter Weitere Informationen -> Bezeichnung Bauspartarife enum: - BKM_MAX_PREMIUM_OPTIMAL - BKM_MAX_PREMIUM_NIEDRIGE_SPARRATE - BKM_MAX_PREMIUM_NIEDRIGE_TILGUNG - BKM_MAX_PREMIUM_BESTER_ZINS - BKM_HAUS_PLUS_OPTIMAL - BKM_HAUS_PLUS_NIEDRIGE_SPARRATE - BKM_HAUS_PLUS_NIEDRIGE_TILGUNG - BKM_HAUS_PLUS_BESTER_ZINS - BKM_ZINS_PLUS_2_BONUS - BKM_ZINS_PLUS_3_BONUS - BKM_HAUS_PLUS_WAHLZUTEILUNG - BKM_HAUS_PLUS_KOMBI - FUCHS_IMMO_1 - FUCHS_IMMO_1_PLUS - FUCHS_IMMO_2 - FUCHS_IMMO_3 - FUCHS_IMMO_4 - FUCHS_IMMO_5 - FUCHS_IMMO_6 - FUCHS_IMMO_7 - FUCHS_ECO_XE - FUCHS_ECO_XT - FUCHS_IMMO_WP - FUCHS_IMMO_WS - FUCHS_IMMO_XL - FUCHS_IMMO_XP - FUCHS_IMMO_XS - FUCHS_START_XX - FUCHS_START_XY - FUCHS_ECO_XE_06 - FUCHS_IMMO_XL_06 - FUCHS_IMMO_XP_06 - FUCHS_IMMO_XS_06 - FUCHS_START_XX_06 - FUCHS_START_XR_06 - FUCHS_IMMO_WP_06 - FUCHS_IMMO_WS_06 - FUCHS_IMMO_WL_06 - LBS_BAYERN_F6_PLUS - LBS_BAYERN_F9 - LBS_BAYERN_FU4 - LBS_BAYERN_FU4_RIESTER - LBS_BAYERN_FU5 - LBS_BAYERN_FU5_RIESTER - LBS_BAYERN_FU6 - LBS_BAYERN_FU6_RIESTER - LBS_BAYERN_FU6_PLUS_RIESTER - LBS_BAYERN_FU9_RIESTER - LBS_BAYERN_N4_PLUS - LBS_BAYERN_N4_PLUS_RIESTER - LBS_BAYERN_N5 - LBS_BAYERN_N5_RIESTER - LBS_BAYERN_N5_PLUS - LBS_BAYERN_N5_PLUS_RIESTER - LBS_BAYERN_N6_PLUS - LBS_BAYERN_N6_PLUS_RIESTER - LBS_BAYERN_N8 - LBS_BAYERN_N8_RIESTER - LBS_BAYERN_T4_PLUS - LBS_BAYERN_T4_PLUS_RIESTER - LBS_BAYERN_T5_PLUS - LBS_BAYERN_T5_PLUS_RIESTER - LBS_BAYERN_T6_PLUS - LBS_BAYERN_T6_PLUS_RIESTER - LBS_BAYERN_T8 - LBS_BAYERN_T8_RIESTER - LBS_BAYERN_T5 - LBS_BAYERN_T5_RIESTER - LBS_BAYERN_U4_PLUS - LBS_BAYERN_U4_PLUS_RIESTER - LBS_BAYERN_U5_PLUS - LBS_BAYERN_U5_PLUS_RIESTER - LBS_BAYERN_U6_PLUS - LBS_BAYERN_U6_PLUS_RIESTER - LBS_BAYERN_U8 - LBS_BAYERN_U8_RIESTER - LBS_BAYERN_U9 - LBS_BAYERN_U9_RIESTER - LBS_BAYERN_U5 - LBS_BAYERN_U5_RIESTER - LBS_BAYERN_V18 - LBS_BAYERN_V25 - LBS_BAYERN_V30 - LBS_BAYERN_W4 - LBS_BAYERN_W4_RIESTER - LBS_BAYERN_W6 - LBS_BAYERN_W6_RIESTER - LBS_BAYERN_W9 - LBS_BAYERN_W4_X30 - LBS_BAYERN_W4_X35 - LBS_BAYERN_W4_X40 - LBS_BAYERN_WF - LBS_BAYERN_WU - LBS_BAYERN_Z35 - LBS_BAYERN_Z35_RIESTER - LBS_BAYERN_Z5 - LBS_BAYERN_Z5_RIESTER - LBS_BAYERN_Z8 - LBS_BAYERN_ZF - LBS_BAYERN_ZF_X45 - LBS_BAYERN_ZF_X45_RIESTER - LBS_BAYERN_ZF_X40 - LBS_BAYERN_ZF_X40_RIESTER - LBS_BAYERN_ZF_X35 - LBS_BAYERN_ZF_X35_RIESTER - LBS_SUED_ANKOMMER_3_5 - LBS_SUED_ANKOMMER_5 - LBS_SUED_ANKOMMER_6 - LBS_SUED_BONUSBRINGER - LBS_SUED_SPRINTER - LBS_SUED_SPRINTER_E - LBS_SUED_ZINSSPARER - LBS_SUED_SPRINTER_RIESTER - LBS_SUED_SPRINTER_E_RIESTER - LBS_SUED_VORSORGER_RIESTER - LBS_HT_CLASSIC_S_2015 - LBS_HT_CLASSIC_F_2015 - LBS_HT_CLASSIC_L_2015 - LBS_HT_CLASSIC_N_2015 - LBS_HT_HOME_M - LBS_HT_HOME_L - LBS_HT_HOME_XL - LBS_HT_COMFORT_S - LBS_HT_COMFORT_N - LBS_HT_FLEX - LBS_NORDWEST_TRAUMSTART_YOUNG - LBS_NORDWEST_WT_FIN_10_V1_2024 - LBS_NORDWEST_WT_FIN_10_V2_2024 - LBS_NORDWEST_WT_FIN_12_2024 - LBS_NORDWEST_WT_FIN_15_V1_2024 - LBS_NORDWEST_WT_FIN_15_V2_2024 - LBS_NORDWEST_WT_FIN_SPEZIAL_2024 - LBS_NORDWEST_WT_MINI_2024 - LBS_NORDWEST_WT_MOD_ECOFLEX_2024 - LBS_NORDWEST_WT_MOD_FLEX_2024 - LBS_NORDWEST_WT_MOD_ECOSPRINT_2024 - LBS_NORDWEST_WT_MOD_SPRINT_2024 - LBS_NORDWEST_WT_PLUS - LBS_NORDWEST_WT_FIN_10_V1_2024_R - LBS_NORDWEST_WT_FIN_10_V2_2024_R - LBS_NORDWEST_WT_FIN_15_V1_2024_R - LBS_NORDWEST_WT_FIN_15_V2_2024_R - LBS_NORDWEST_WT_SPEZIAL_2024_R - LBS_NORDWEST_WT_MOD_ECOFLEX_2024_R - LBS_NORDWEST_WT_MOD_FLEX_2024_R - LBS_NORDWEST_BESTAND_CLASSIC_06_L - LBS_NORDWEST_BESTAND_CLASSIC_06_N - LBS_NORDWEST_BESTAND_CLASSIC_06_S - LBS_NORDWEST_BESTAND_CLASSIC_11_F - LBS_NORDWEST_BESTAND_CLASSIC_11_F_MAXI - LBS_NORDWEST_BESTAND_CLASSIC_11_L - LBS_NORDWEST_BESTAND_CLASSIC_11_N - LBS_NORDWEST_BESTAND_CLASSIC_11_S - LBS_NORDWEST_BESTAND_ZUHAUSE_13_FLEX_4_L - LBS_NORDWEST_BESTAND_ZUHAUSE_13_FLEX_4_S - LBS_NORDWEST_BESTAND_ZUHAUSE_13_FLEX_5_L - LBS_NORDWEST_BESTAND_ZUHAUSE_13_FLEX_5_S - LBS_NORDWEST_BESTAND_ZUHAUSE_13_FLEX_6_L - LBS_NORDWEST_BESTAND_ZUHAUSE_13_FLEX_6_S - LBS_NORDWEST_BESTAND_ZUHAUSE_13_FLEX_8_L - LBS_NORDWEST_BESTAND_ZUHAUSE_13_FLEX_8_S - LBS_NORDWEST_BESTAND_ZUHAUSE_13_PLUS - LBS_NORDWEST_BESTAND_ZUHAUSE_15_DIREKT_10 - LBS_NORDWEST_BESTAND_ZUHAUSE_15_DIREKT_15 - LBS_NORDWEST_BESTAND_ZUHAUSE_15_FLEX_4_L - LBS_NORDWEST_BESTAND_ZUHAUSE_15_FLEX_4_S - LBS_NORDWEST_BESTAND_ZUHAUSE_15_FLEX_5_L - LBS_NORDWEST_BESTAND_ZUHAUSE_15_FLEX_5_S - LBS_NORDWEST_BESTAND_ZUHAUSE_15_FLEX_6_L - LBS_NORDWEST_BESTAND_ZUHAUSE_15_FLEX_6_S - LBS_NORDWEST_BESTAND_ZUHAUSE_15_FLEX_8_L - LBS_NORDWEST_BESTAND_ZUHAUSE_15_FLEX_8_S - LBS_NORDWEST_BESTAND_ZUHAUSE_15_PLUS - LBS_NORDWEST_BESTAND_ZUHAUSE_17_PRIMA - LBS_NORDWEST_BESTAND_ZUHAUSE_17_PRIMA_10 - LBS_NORD_CLASSIC_GU - LBS_NORD_CLASSIC_GV - LBS_NORD_CLASSIC_MINI_GM - LBS_NORD_CLASSIC_TF_GF - LBS_NORD_CLASSIC_JC - LBS_NORD_CLASSIC_JV - LBS_NORD_CLASSIC_MINI - LBS_NORD_CLASSIC_TF_JF - LBS_NORD_PLUS - LBS_NORD_FINANZIERER_F3_2016 - LBS_NORD_FINANZIERER_F4_2016 - LBS_NORD_FINANZIERER_F5_2016 - LBS_NORD_FINANZIERER_F6_2016 - LBS_NORD_FINANZIERER_F7_2016 - LBS_NORD_MODERNISIERER_M8_2016 - LBS_NORD_MODERNISIERER_M10_2016 - LBS_NORD_MODERNISIERER_MINIZINS_2016 - LBS_NORD_STARTER_S4_2016 - LBS_NORD_STARTER_S5_2016 - LBS_NORD_STARTER_S6_2016 - LBS_NORD_N_STARTER_S4 - LBS_NORD_N_STARTER_S5 - LBS_NORD_N_STARTER_S6 - LBS_NORD_N_FINANZIERER_F3 - LBS_NORD_N_FINANZIERER_F4 - LBS_NORD_N_FINANZIERER_F5 - LBS_NORD_N_FINANZIERER_F6 - LBS_NORD_N_FINANZIERER_F7 - LBS_NORD_N_FINANZIERER_MEINZUHAUSE - LBS_NORD_N_MODERNISIERER_MINIZINS - LBS_NORD_N_MODERNISIERER_M8 - LBS_NORD_N_MODERNISIERER_MX - LBS_NORD_N_STARTER_Q5 - LBS_WEST_BESTAND_ZUHAUSE_DIREKT_10 - LBS_WEST_BESTAND_ZUHAUSE_DIREKT_15 - LBS_WEST_BESTAND_ZUHAUSE_PRIMA - LBS_WEST_BESTAND_ZUHAUSE_FLEX_4 - LBS_WEST_BESTAND_ZUHAUSE_FLEX_5 - LBS_WEST_BESTAND_ZUHAUSE_FLEX_8 - LBS_WEST_BESTAND_ZUHAUSE_SPEZIAL - LBS_WEST_BESTAND_RIESTER_ZUHAUSE_DIREKT_10 - LBS_WEST_BESTAND_RIESTER_ZUHAUSE_DIREKT_15 - LBS_WEST_BESTAND_RIESTER_ZUHAUSE_FLEX_4 - LBS_WEST_BESTAND_RIESTER_ZUHAUSE_SPEZIAL - LBS_OST_CLASSIC_F15_F5 - LBS_OST_CLASSIC_F_H4 - LBS_OST_CLASSIC_F_H5 - LBS_OST_CLASSIC_12_C4 - LBS_OST_CLASSIC_12_C9 - LBS_OST_VARIO_FLEX - LBS_OST_CLASSIC20_F3 - LBS_OST_CLASSIC20_F8 - LBS_OST_CLASSIC20_PLUS_F - LBS_OST_FLEX_22 - LBS_OST_KOMFORT_22 - LBS_OST_SPRINT_22 - LBS_OST_KONSTANT30_V095 - LBS_OST_KONSTANT30_V110 - LBS_OST_KONSTANT30_V130 - LBS_OST_KONSTANT30_V150 - LBS_OST_KONSTANT30_V170 - LBS_OST_KONSTANT30_V190 - LBS_OST_KONSTANT30_V210 - LBS_OST_KONSTANT30_V230 - LBS_OST_KONSTANT30_V250 - LBS_OST_KONSTANT30_V270 - LBS_OST_KONSTANT30_V290 - LBS_OST_KONSTANT30_V310 - LBS_OST_KONSTANT30_V330 - LBS_OST_KONSTANT30_V350 - LBS_OST_KONSTANT30_V370 - LBS_OST_KONSTANT30_V390 - LBS_OST_KONSTANT30_V410 - LBS_OST_KONSTANT30_V430 - LBS_OST_KONSTANT30_V450 - LBS_OST_KONSTANT30_V470 - LBS_OST_KONSTANT30_V490 - LBS_OST_KONSTANT30_V510 - LBS_OST_KONSTANT30_V530 - LBS_OST_KONSTANT30_V550 - LBS_OST_CLASSIC15_F3 - LBS_OST_CLASSIC15_F4 - LBS_OST_CLASSIC15_F5 - LBS_OST_CLASSIC15_F6 - LBS_OST_CLASSIC15_F8 - LBS_OST_CLASSIC15_PLUS_F - LBS_OST_CLASSIC15_PLUS_S - LBS_OST_BESTAND_CLASSIC_F4 - LBS_OST_BESTAND_CLASSIC_F5 - LBS_OST_BESTAND_CLASSIC_F6 - LBS_NORDOST_BESTAND_SHH_PRIMUS_SC - LBS_NORDOST_BESTAND_SHH_PRIMUS_SD - LBS_NORDOST_BESTAND_SHH_PRIMUS_SH - LBS_NORDOST_BESTAND_SHH_PRIMUS_SI - LBS_NORDOST_BESTAND_SHH_PRIMUS_SJ - LBS_NORDOST_BESTAND_SHH_TREND_SD - LBS_NORDOST_BESTAND_SHH_CLASSIC_AUSBAU_TD - LBS_NORDOST_BESTAND_SHH_CLASSIC_FORMAT - LBS_NORDOST_BESTAND_SHH_CLASSIC_FORMAT_MB - LBS_NORDOST_BESTAND_SHH_CLASSIC_HAUSBAU_TC - LBS_NORDOST_BESTAND_SHH_CLASSIC_HAUSBAU_TH - LBS_NORDOST_BESTAND_SHH_CLASSIC_HAUSBAU_TI - LBS_NORDOST_BESTAND_SHH_CLASSIC_HAUSBAU_TJ - LBS_NORDOST_BESTAND_SHH_CLASSIC_HAUSBAU_TK - LBS_NORDOST_BESTAND_SHH_CLASSIC_HAUSBAU_TL - LBS_NORDOST_BESTAND_SHH_CLASSIC_HAUSBAU_TM - LBS_NORDOST_BESTAND_SHH_CLASSIC_HAUSBAU_TN - LBS_NORDOST_BESTAND_SHH_CLASSIC_PERSPEKTIVE - LBS_NORDOST_BESTAND_SHH_CLASSIC_PERSPEKTIVE_MA - LBS_NORDOST_BESTAND_SHH_CLASSIC_PRIMUS - LBS_NORDOST_BESTAND_SHH_CLASSIC_PRIMUS_MC - LBS_NORDOST_BESTAND_SHH_CLASSIC_PRIMUS_SK - LBS_NORDOST_BESTAND_SHH_CLASSIC_PRIMUS_SL - LBS_NORDOST_BESTAND_SHH_CLASSIC_PRIMUS_SM - LBS_NORDOST_BESTAND_SHH_CLASSIC_PRIMUS_SN - LBS_NORDOST_BESTAND_SHH_CLASSIC_TRAUMHAUS_TB - LBS_NORDOST_BESTAND_SHH_CLASSIC_TREND - LBS_NORDOST_BESTAND_SHH_CLASSIC_TREND_MD - LBS_NORDOST_BESTAND_SHH_CLASSIC_VITA_SE - LBS_NORDOST_BESTAND_SHH_VITA_ME - LBS_NORDOST_BESTAND_SHH_VITA_OE - LBS_NORDOST_BESTAND_SHH_VITA_PE - LBS_NORDOST_BESTAND_SHH_VITA_SE - LBS_NORDOST_BESTAND_SHH_PRIMUS_TC - LBS_NORDOST_BESTAND_SHH_PRIMUS_TH - LBS_NORDOST_BESTAND_SHH_PRIMUS_TI - LBS_NORDOST_BESTAND_SHH_PRIMUS_TJ - LBS_NORDOST_BESTAND_SHH_PRIMUS_TD - LBS_NORDOST_BESTAND_SHH_TREND_TD - LBS_NORDOST_BESTAND_SHH_CLASSIC_TRAUMHAUS - LBS_SHH_PRIMUS_SC - LBS_SHH_PRIMUS_SD - LBS_SHH_PRIMUS_SH - LBS_SHH_PRIMUS_SI - LBS_SHH_PRIMUS_SJ - LBS_SHH_TREND_SD - LBS_SHH_PRIMUS_TC - LBS_SHH_PRIMUS_TH - LBS_SHH_PRIMUS_TI - LBS_SHH_PRIMUS_TJ - LBS_SHH_PRIMUS_TD - LBS_SHH_TREND_TD - LBS_SHH_CLASSIC_TRAUMHAUS - LBS_SHH_CLASSIC_AUSBAU_TD - LBS_SHH_CLASSIC_FORMAT - LBS_SHH_CLASSIC_FORMAT_MB - LBS_SHH_CLASSIC_HAUSBAU_TC - LBS_SHH_CLASSIC_HAUSBAU_TH - LBS_SHH_CLASSIC_HAUSBAU_TI - LBS_SHH_CLASSIC_HAUSBAU_TJ - LBS_SHH_CLASSIC_HAUSBAU_TK - LBS_SHH_CLASSIC_HAUSBAU_TL - LBS_SHH_CLASSIC_HAUSBAU_TM - LBS_SHH_CLASSIC_HAUSBAU_TN - LBS_SHH_CLASSIC_PERSPEKTIVE - LBS_SHH_CLASSIC_PERSPEKTIVE_MA - LBS_SHH_CLASSIC_PRIMUS - LBS_SHH_CLASSIC_PRIMUS_MC - LBS_SHH_CLASSIC_PRIMUS_SK - LBS_SHH_CLASSIC_PRIMUS_SL - LBS_SHH_CLASSIC_PRIMUS_SM - LBS_SHH_CLASSIC_PRIMUS_SN - LBS_SHH_CLASSIC_TRAUMHAUS_TB - LBS_SHH_CLASSIC_TREND - LBS_SHH_CLASSIC_TREND_MD - LBS_SHH_CLASSIC_VITA_SE - LBS_SHH_VITA_ME - LBS_SHH_VITA_OE - LBS_SHH_VITA_PE - LBS_SHH_VITA_SE - LBS_WEST_ZUHAUSE_DIREKT_10 - LBS_WEST_ZUHAUSE_DIREKT_15 - LBS_WEST_ZUHAUSE_PLUS - LBS_WEST_ZUHAUSE_FLEX_4_S - LBS_WEST_ZUHAUSE_FLEX_4_L - LBS_WEST_ZUHAUSE_FLEX_5_S - LBS_WEST_ZUHAUSE_FLEX_5_L - LBS_WEST_ZUHAUSE_FLEX_6_S - LBS_WEST_ZUHAUSE_FLEX_6_L - LBS_WEST_ZUHAUSE_FLEX_8_S - LBS_WEST_ZUHAUSE_FLEX_8_L - LBS_WEST_ZUHAUSE_PRIMA - LBS_WEST_ZUHAUSE_PRIMA_10 - LBS_WEST_ZUHAUSE_FLEX_4 - LBS_WEST_ZUHAUSE_FLEX_5 - LBS_WEST_ZUHAUSE_FLEX_6 - LBS_WEST_ZUHAUSE_FLEX_8 - LBS_WEST_ZUHAUSE_YOUNG - LBS_WEST_ZUHAUSE_SPEZIAL - LBS_WEST_RIESTER_ZUHAUSE_DIREKT_10 - LBS_WEST_RIESTER_ZUHAUSE_DIREKT_15 - LBS_WEST_RIESTER_ZUHAUSE_DIREKT_PLUS - LBS_WEST_RIESTER_ZUHAUSE_FLEX_4 - LBS_WEST_RIESTER_ZUHAUSE_FLEX_5 - LBS_WEST_RIESTER_ZUHAUSE_FLEX_6 - LBS_WEST_RIESTER_ZUHAUSE_FLEX_8 - LBS_WEST_RIESTER_ZUHAUSE_FLEX_4_S - LBS_WEST_RIESTER_ZUHAUSE_FLEX_5_S - LBS_WEST_RIESTER_ZUHAUSE_FLEX_6_S - LBS_WEST_RIESTER_ZUHAUSE_FLEX_8_S - LBS_WEST_RIESTER_ZUHAUSE_FLEX_4_L - LBS_WEST_RIESTER_ZUHAUSE_FLEX_5_L - LBS_WEST_RIESTER_ZUHAUSE_FLEX_6_L - LBS_WEST_RIESTER_ZUHAUSE_FLEX_8_L - LBS_WEST_RIESTER_ZUHAUSE_SPEZIAL - LBS_WEST_RIESTER_KONSTANT_35 - LBS_WEST_RIESTER_KONSTANT_40 - LBS_WEST_RIESTER_KONSTANT_50 - LBS_WEST_KONSTANT_35 - LBS_WEST_KONSTANT_40 - LBS_WEST_KONSTANT_50 - LBS_WEST_RIESTER_KONSTANT_35_ANGEBOT - LBS_WEST_RIESTER_KONSTANT_40_ANGEBOT - LBS_WEST_RIESTER_KONSTANT_50_ANGEBOT - LBS_WEST_KONSTANT_35_ANGEBOT - LBS_WEST_KONSTANT_40_ANGEBOT - LBS_WEST_KONSTANT_50_ANGEBOT - LBS_SUEDWEST_KLASSIK_PLUS_2018 - LBS_SUEDWEST_LANGZEIT_PLUS_2019 - LBS_SUEDWEST_KLASSIK_PLUS_2020 - LBS_SUEDWEST_STANDARD_PLUS_2018 - LBS_SUEDWEST_LANGZEIT_PLUS_SPEZIAL - LBS_SUEDWEST_NIEDRIGZINS - LBS_SUEDWEST_ZUKUNFT_PLUS - LBS_SUEDWEST_ANKOMMER_3_5 - LBS_SUEDWEST_ANKOMMER_5 - LBS_SUEDWEST_ANKOMMER_6 - LBS_SUEDWEST_BONUSBRINGER - LBS_SUEDWEST_SPRINTER - LBS_SUEDWEST_SPRINTER_E - LBS_SUEDWEST_ZINSSPARER - LBS_SUEDWEST_SPRINTER_RIESTER - LBS_SUEDWEST_SPRINTER_E_RIESTER - LBS_SUEDWEST_VORSORGER_RIESTER - LBS_SAAR_PREMIUM_FLEX_18 - LBS_SAAR_PREMIUM_SICHER_18 - LBS_SAAR_PREMIUM_TOP_18 - LBS_SAAR_EXTRA_GUENSTIG_18 - LBS_SAAR_EXTRA_SICHER_18 - LBS_SAAR_EXTRA_SPEZIAL_18 - LBS_SAAR_CLASSIC_21_ZUHAUSE - LBS_SAAR_FINANZIERER_20_ZUHAUSE - LBS_SAAR_FINANZIERER_25_ZUHAUSE - LBS_SAAR_FINANZIERER_30_ZUHAUSE - LBS_SAAR_FINANZIERER_KONSTANT_ZUHAUSE - LBS_SAAR_MODERNISIERER_ZUHAUSE - LBS_SAAR_KLIMAFIT_ZUHAUSE - LBS_SAAR_EINSTEIGER - LBS_SAAR_FINANZIERER_MAX - LBS_SAAR_KLASSIK - LBS_SAAR_KLIMAFIT - LBS_SAAR_TOP_RATE - LBS_SAAR_TOP_ZINS - LBS_SAAR_WOHNFIT - SIGNAL_IDUNA_FREIRAUM_F_35 - SIGNAL_IDUNA_FREIRAUM_F_35_16 - SIGNAL_IDUNA_FREIRAUM_F_45 - SIGNAL_IDUNA_FREIRAUM_F_45_16 - SIGNAL_IDUNA_FREIRAUM_F_60 - SIGNAL_IDUNA_FREIRAUM_F_30_MZ - SIGNAL_IDUNA_FREIRAUM_F_30_MZ_16 - SIGNAL_IDUNA_FREIRAUM_F_35_MZ - SIGNAL_IDUNA_FREIRAUM_F_35_MZ_16 - SIGNAL_IDUNA_FREIRAUM_F_40_MZ - SIGNAL_IDUNA_FREIRAUM_F_40_MZ_16 - SIGNAL_IDUNA_FREIRAUM_F_45_MZ - SIGNAL_IDUNA_FREIRAUM_F_45_MZ_16 - SIGNAL_IDUNA_FREIRAUM_F_50_MZ - SIGNAL_IDUNA_FREIRAUM_F_60_MZ - SIGNAL_IDUNA_FREIRAUM_F_30 - SIGNAL_IDUNA_FREIRAUM_F_30_16 - SIGNAL_IDUNA_FREIRAUM_F_40 - SIGNAL_IDUNA_FREIRAUM_F_40_16 - SIGNAL_IDUNA_FREIRAUM_F_50 - SIGNAL_IDUNA_FREIRAUM_F_50_16 - BHW_TARIF_FI1 - BHW_TARIF_DB_FI1 - BHW_TARIF_FI2 - BHW_TARIF_DB_FI2 - BHW_TARIF_FI3 - BHW_TARIF_DB_FI3 - BHW_TARIF_FI3N - BHW_TARIF_FI4 - BHW_TARIF_DB_FI4 - BHW_TARIF_FI4N - BHW_TARIF_DB_FI5 - BHW_TARIF_DB_FI6 - BHW_TARIF_FX1 - BHW_TARIF_DB_FX1 - BHW_TARIF_FX2 - BHW_TARIF_DB_FX2 - BHW_TARIF_DB_FX5 - BHW_TARIF_DB_FX6 - BHW_TARIF_REN - BHW_TARIF_DB_REN - BHW_TARIF_DISPOPLUS - BHW_TARIF_DX3 - BHW_TARIF_DX4 - BHW_TARIF_DX5 - BHW_TARIF_DM3 - BHW_TARIF_DM3N - BHW_TARIF_DM4 - BHW_TARIF_DM4N - BHW_TARIF_DM4_75N - BHW_TARIF_DM5 - BHW_TARIF_DN2 - BHW_TARIF_DN3 - BHW_TARIF_DN4 - BHW_TARIF_DV1 - BHW_TARIF_DV1N - BHW_TARIF_DV2 - BHW_TARIF_DV2N - BHW_TARIF_DV3 - BHW_TARIF_DV3N - BHW_TARIF_WM - BHW_TARIF_DB_WR1 - BHW_TARIF_DB_WR2 - BHW_TARIF_DB_WU1 - BHW_TARIF_DB_WU2 - BHW_TARIF_FI1N - BHW_TARIF_FI2N - BHW_TARIF_FX1N - BHW_TARIF_FX2N - DT_RING_TARIF_FT - DT_RING_TARIF_FT_0 - DT_RING_TARIF_FT_1 - DT_RING_TARIF_FT_2 - DT_RING_TARIF_XT_1 - DT_RING_TARIF_XT_0 - DT_RING_TARIF_F_1 - DT_RING_TARIF_F_5 - DT_RING_TARIF_F_7 - ALTE_LEIPZIGER_1502 - ALTE_LEIPZIGER_1602 - ALTE_LEIPZIGER_1702 - ALTE_LEIPZIGER_1802 - ALTE_LEIPZIGER_1902 - ALTE_LEIPZIGER_2002 - ALTE_LEIPZIGER_1502_MZ - ALTE_LEIPZIGER_1602_MZ - ALTE_LEIPZIGER_1702_MZ - ALTE_LEIPZIGER_1802_MZ - ALTE_LEIPZIGER_1902_MZ - ALTE_LEIPZIGER_2002_MZ - ALTE_LEIPZIGER_1503 - ALTE_LEIPZIGER_1603 - ALTE_LEIPZIGER_1703 - ALTE_LEIPZIGER_1803 - ALTE_LEIPZIGER_1903 - ALTE_LEIPZIGER_2003 - ALTE_LEIPZIGER_1503_MZ - ALTE_LEIPZIGER_1603_MZ - ALTE_LEIPZIGER_1703_MZ - ALTE_LEIPZIGER_1803_MZ - ALTE_LEIPZIGER_1903_MZ - ALTE_LEIPZIGER_2003_MZ - ALTE_LEIPZIGER_150X - ALTE_LEIPZIGER_160X - ALTE_LEIPZIGER_170X - ALTE_LEIPZIGER_180X - ALTE_LEIPZIGER_190X - ALTE_LEIPZIGER_200X - ALTE_LEIPZIGER_150X_MZ - ALTE_LEIPZIGER_160X_MZ - ALTE_LEIPZIGER_170X_MZ - ALTE_LEIPZIGER_180X_MZ - ALTE_LEIPZIGER_190X_MZ - ALTE_LEIPZIGER_200X_MZ - ALTE_LEIPZIGER_ZG_21XX_20 - ALTE_LEIPZIGER_ZG_21XX_30 - ALTE_LEIPZIGER_ZG_25XX_49 - ALTE_LEIPZIGER_21XX - ALTE_LEIPZIGER_21XX_27 - ALTE_LEIPZIGER_22XX - ALTE_LEIPZIGER_22XX_27 - ALTE_LEIPZIGER_21XX_33 - ALTE_LEIPZIGER_22XX_33 - ALTE_LEIPZIGER_21XX_20 - ALTE_LEIPZIGER_22XX_20 - ALTE_LEIPZIGER_25XX_45 - ALTE_LEIPZIGER_26XX_45 - ALTE_LEIPZIGER_25XX_30 - ALTE_LEIPZIGER_26XX_30 - ALTE_LEIPZIGER_BS_22XX_33 - WUESTENROT_01063_4 - WUESTENROT_01063_5 - WUESTENROT_01063_6 - WUESTENROT_01063_7 - WUESTENROT_01063_8 - WUESTENROT_01063_9 - WUESTENROT_01063_10 - WUESTENROT_01063_12 - WUESTENROT_01064_4 - WUESTENROT_01064_6 - WUESTENROT_01064_8 - WUESTENROT_01064_10 - WUESTENROT_01064_12 - WUESTENROT_01061_10 - WUESTENROT_01062_4 - WUESTENROT_01061_10_0000 - WUESTENROT_01062_04_0000 - WUESTENROT_01063_05_3585 - WUESTENROT_01063_07_5110 - WUESTENROT_01063_09_0000 - WUESTENROT_01064_10_0000 - WUESTENROT_01064_04_0000 - WUESTENROT_01064_04_5000 - WUESTENROT_01064_05_4121 - WUESTENROT_01064_06_0000 - WUESTENROT_01064_07_5161 - WUESTENROT_01064_09_0000 - WUESTENROT_01073_08_0000 - WUESTENROT_01074_10_0000 - WUESTENROT_01075_03_5000 - WUESTENROT_01076_08_0000 - WUESTENROT_01077_04_0000 - WUESTENROT_01077_07_5000 - WUESTENROT_01077_08_0000 - WUESTENROT_01078_04_0000 - WUESTENROT_01079_04_0000 - WUESTENROT_01079_04_5000 - WUESTENROT_01073_04_5000 - WUESTENROT_01073_05_9000 - WUESTENROT_01094_04_5000 - WUESTENROT_01094_08_0000 - WUESTENROT_01094_05_9000 - WUESTENROT_01076_07_9872 - WUESTENROT_01076_05_8633 - WUESTENROT_01087_08_0000 - WUESTENROT_01087_07_9872 - WUESTENROT_01087_05_8633 - WUESTENROT_01088_04_0000 - WUESTENROT_01077_06_3000 - WUESTENROT_01077_04_7000 - WUESTENROT_01088_07_5000 - WUESTENROT_01088_06_3000 - WUESTENROT_01088_04_7000 - WUESTENROT_01077_07_9648 - WUESTENROT_01077_06_2500 - WUESTENROT_01088_08_0000 - WUESTENROT_01088_07_9648 - WUESTENROT_01088_06_2500 - WUESTENROT_01085_10_0000 - WUESTENROT_01086_03_5000 - WUESTENROT_01090_04_0000 - WUESTENROT_01090_04_5000 - WUESTENROT_01089_04_0000 - WUESTENROT_01093_05_0000 - DEUTSCHE_BANK_BAUSPAR_TARIF_FI1 - DEUTSCHE_BANK_BAUSPAR_TARIF_FI2 - DEUTSCHE_BANK_BAUSPAR_TARIF_FI3 - DEUTSCHE_BANK_BAUSPAR_TARIF_FI4 - DEUTSCHE_BANK_BAUSPAR_TARIF_FX1 - DEUTSCHE_BANK_BAUSPAR_TARIF_FX2 id: type: string description: "Zur Referenzierung an anderer Stelle notwendig. Wenn nicht\ \ angegeben, dann wird dieses Feld automatisch befüllt." riesterFoerderung: type: boolean sonderZahlungen: type: array items: $ref: "#/components/schemas/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: - ZINS_ABSICHERUNG - TILGUNGS_AUSGESETZT zulagenVerwendung: type: string enum: - SONDERZAHLUNG - VERRECHNUNG zuteilungsDatum: type: string format: date Bearbeitungszeit: type: object properties: bemerkung: type: string max: type: integer format: int32 min: type: integer format: int32 standVon: type: string format: date Beleihung: type: object properties: auslauf: type: number primary: type: boolean produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" summe: type: number BerechnungsUebersicht: type: object properties: exzerpt: type: string html: type: string produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" BerechnungsUebersichten: type: object properties: _links: $ref: "#/components/schemas/Links" beleihungsauslauf: type: array items: $ref: "#/components/schemas/BerechnungsUebersicht" haushaltsrechnung: type: array items: $ref: "#/components/schemas/BerechnungsUebersicht" kondition: type: array items: $ref: "#/components/schemas/KonditionsUebersicht" lebensphasenplanung: type: array items: $ref: "#/components/schemas/BerechnungsUebersicht" Bereitstellung: type: object properties: bereitstellungsZins: type: number bereitstellungsZinsfreieZeitInMonaten: type: integer format: int32 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: $ref: "#/components/schemas/Staat" art: type: string enum: - ANGESTELLTER - ARBEITER - BEAMTER - FREIBERUFLER - SELBSTAENDIGER - RENTNER - HAUSFRAU - ARBEITSLOSER 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: Allgemeine Branche des Antragstellers. Wird verwendet um für die verschiedenen Banken die Zusatzangabe Branche zu bilden. enum: - LANDWIRTSCHAFT_FORSTWIRTSCHAFT_FISCHEREI - BERGBAU_GEWINNUNG_VON_STEINEN_UND_ERDEN - VERARBEITENDES_GEWERBE - WASSERVERSORGUNG - ENERGIEVERSORGUNG - BAUGEWERBE - HANDEL_INSTANDHALTUNG_VON_KRAFTFAHRZEUGEN - VERKEHR_LOGISTIK - GASTGEWERBE - INFORMATION_KOMMUNIKATION - FINANZ_UND_VERSICHERUNGSDIENSTLEISTUNGEN - GRUNDSTÜCKS_UND_WOHNUNGSWESEN - FREIBERUFLICHE_WISSENSCHAFTLICHE_UND_TECHNISCHE_DIENSTLEISTUNGEN - SONSTIGE_WIRTSCHAFTLICHE_DIENSTLEISTUNGEN - OEFFENTLICHE_VERWALTUNG_VERTEIDIGUNG_SOZIALVERSICHERUNG - ERZIEHUNG_UNTERRICHT - GESUNDHEIT_UND_SOZIALWESEN - KUNST_UNTERHALTUNG_ERHOLUNG - SONSTIGE_DIENSTLEISTUNGEN - PRIVATE_HAUSHALTE einkommenNettoJaehrlich: type: number description: "nur bei art == FREIBERUFLER, SELBSTAENDIGER" einkommenNettoMonatlich: type: number description: "nur bei art != FREIBERUFLER, SELBSTAENDIGER" inProbezeit: type: boolean description: "nur bei art == ANGESTELLTER, ARBEITER, BEAMTER" situationNachRenteneintritt: $ref: "#/components/schemas/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 - STADTPLANER - STATIKER - STEUERBERATER - TIERARZT - UNTERNEHMENSBERATER - VERMITTLER - WIRTSCH_BUCHPRUEFER_REVISOR - ZAHNARZT - ZAHNTECHNIKER - SONSTIGES BestehendeImmobilie: type: object properties: adresse: $ref: "#/components/schemas/Postadresse" autostellplaetze: type: array items: $ref: "#/components/schemas/Autostellplatz" bestehendeDarlehen: type: array items: $ref: "#/components/schemas/BestehendesDarlehen" bewirtschaftungsKostenJaehrlich: type: number bodenRichtwert: type: number effektivZinsErhoehendeKosten: $ref: "#/components/schemas/EffektivZinsErhoehendeKosten" einzusetzenderBetragBeiEinsatzAlsZusatzsicherheit: type: number erbbaurecht: $ref: "#/components/schemas/Erbbaurecht" gebaeude: $ref: "#/components/schemas/Gebaeude" grundbuchAngabe: $ref: "#/components/schemas/GrundbuchAngabe" grundstueck: $ref: "#/components/schemas/Grundstueck" id: type: string immobilienEinsatz: type: string enum: - KEIN_EINSATZ - VERKAUFEN - ALS_ZUSATZSICHERHEIT keinBaulandFlaecheInQm: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." keineBestehendenDarlehenVorhanden: type: boolean marktueblicherKaufpreisProQm: type: number maximalEinzusetzenderBetragWennVerkauf: type: number objektArt: type: string enum: - GRUNDSTUECK - EIGENTUMSWOHNUNG - HAUS vergleichsmieteFuerGewerbeflaecheProQm: type: number vergleichsmieteFuerWohnflaecheProQm: type: number verkehrswert: type: number description: "Verkehrswert, nur relevant bei Finanzbedarf AnschlussFinanzierung,\ \ Modernisierung und Kapitalbeschaffung" vorlaeufigerVerkehrswert: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." wohnlage: type: string enum: - GEHOBEN - MITTEL - EINFACH BestehenderBausparvertrag: type: object properties: abschlussGebuehr: type: number aktuellerWert: type: number bausparSumme: type: number ertrag: type: number id: type: string maximalAufzuloesenderBetrag: type: number produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" sparBeitragMonatlich: type: number tarif: type: string typ: type: string vermoegensEinsatz: type: string enum: - KEIN_EINSATZ - ABTRETEN - AUFLOESEN vertragsBeginn: type: string format: date vertragsNummer: type: string verwaltungsgebuehrenJaehrlich: type: number zukuenftigeEinnahmen: type: number zuteilungsDatum: type: string format: date BestehendesDarlehen: type: object properties: abzuloesendeRestschuld: type: number aktuelleRestschuldWennNichtAbzuloesen: type: number description: nur wenn wirdAbgeloest == false darlehensArt: type: string enum: - BAUSPARDARLEHEN - FOERDERDARLEHEN - IMMOBILIENDARLEHEN - SONSTIGES_DARLEHEN - PRIVATDARLEHEN darlehensBetrag: type: number description: "für Prolongation, d.h. technisch: Vorhaben verwendungszweck\ \ == ANSCHLUSSFINANZIERUNG" darlehensGeber: $ref: "#/components/schemas/ProduktAnbieter" darlehensKontonummer: type: string description: "für Prolongation, d.h. technisch: Vorhaben verwendungszweck\ \ == ANSCHLUSSFINANZIERUNG" eingetrageneGrundschuld: type: number grundschuldArt: type: string enum: - BRIEF_GRUNDSCHULD - BUCH_GRUNDSCHULD id: type: string laufzeitEnde: type: string format: date description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." rateMonatlich: type: number sollZins: type: number sondertilgungZumZinsBindungsEnde: type: number description: "für Prolongation, d.h. technisch: Vorhaben verwendungszweck\ \ == ANSCHLUSSFINANZIERUNG" zinsBindungEndetAm: type: string format: date BestehendesDarlehenDesFinanzierungsObjekts: type: object properties: abzuloesendeRestschuld: type: number aktuelleRestschuldWennNichtAbzuloesen: type: number description: nur wenn wirdAbgeloest == false darlehensArt: type: string enum: - BAUSPARDARLEHEN - FOERDERDARLEHEN - IMMOBILIENDARLEHEN - SONSTIGES_DARLEHEN - PRIVATDARLEHEN darlehensBetrag: type: number description: "für Prolongation, d.h. technisch: Vorhaben verwendungszweck\ \ == ANSCHLUSSFINANZIERUNG" darlehensGeber: $ref: "#/components/schemas/ProduktAnbieter" darlehensKontonummer: type: string description: "für Prolongation, d.h. technisch: Vorhaben verwendungszweck\ \ == ANSCHLUSSFINANZIERUNG" eingetrageneGrundschuld: type: number grundschuldArt: type: string enum: - BRIEF_GRUNDSCHULD - BUCH_GRUNDSCHULD id: type: string laufzeitEnde: type: string format: date description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." 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. Wenn es sich um eine Anschlussfinanzierung handelt,\ \ und ein bestehendes Darlehen vorhanden ist, dann muss dieses den Wert\ \ 'verwendenAls'='ABLOESEN' beinhalten" enum: - ABLOESEN - TRITT_IM_RANG_ZURUECK - TRITT_NICHT_IM_RANG_ZURUECK zinsBindungEndetAm: type: string format: date Darlehen: type: object properties: auszahlungsBetrag: type: number description: Der Auszahlungsbetrag ist der Nettodarlehensbetrag auszahlungsDatum: type: string format: date bearbeitungszeit: $ref: "#/components/schemas/Bearbeitungszeit" bereitstellung: $ref: "#/components/schemas/Bereitstellung" darlehensBetrag: type: number effektivZins: type: number effektivZinsRelevanteKosten: $ref: "#/components/schemas/EffektivZinsRelevanteKosten" finanzierenderProduktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" forwardperiodeInMonaten: type: integer format: int32 gesamtkosten: type: number gesamtlaufzeitInMonaten: type: integer format: int32 id: type: string kalkulatorischesLaufzeitEnde: type: string format: date kennung: type: string kfwProgramm: type: string 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 - PROGRAMM_308 - PROGRAMM_358 - PROGRAMM_359 kontoCheck: type: boolean description: Zeig an ob das Darlehen Kontocheck-fähig ist kontoCheckVerpflichtend: type: boolean description: "Zeigt an, ob ein Angebot mit diesem Darlehen nur nach abgeschlossenem\ \ Kontocheck angenommen werden kann" kontocheckAnreizeText: type: string description: Freitext für Information über Vorteile die durch Kontocheck entstehen laufzeitInJahren: type: integer format: int32 laufzeitInMonaten: type: integer format: int32 produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" produktFeatures: type: array items: type: string provisionKundenbetreuerAbsolut: type: number provisionKundenbetreuerRelativ: type: number rateMonatlich: type: number rateMonatlichInDerTilgungsfreienAnlaufzeit: type: number regionalFoerderbankProgramm: type: string enum: - L_BANK_KOMBI_DARLEHEN_WOHNEN - L_BANK_WOHNEN_MIT_KIND - L_BANK_WOHNEN_MIT_ZUKUNFT - NRW_BANK_WOHNEIGENTUM - NRW_BANK_GEBAEUDESANIERUNG - NRW_BANK_NACHHALTIG_WOHNEN sollZins: type: number summeGebuehrenUeberGesamtlaufzeit: type: number summeKontofuehrungsgebuehrenUeberGesamtlaufzeit: type: number summeZinsenUeberGesamtlaufzeit: type: number tilgung: $ref: "#/components/schemas/Tilgung" typ: type: string enum: - ANNUITAETEN_DARLEHEN - FORWARD_DARLEHEN - REGIONAL_FOERDER_DARLEHEN - KFW_DARLEHEN - PRIVAT_DARLEHEN - ZWISCHEN_FINANZIERUNG - VARIABLES_DARLEHEN - BAUSPARVERTRAG zinsBindung: $ref: "#/components/schemas/ZinsBindung" zinsZahlungsBeginnAm: type: string format: date zwischenfinanzierung: $ref: "#/components/schemas/Zwischenfinanzierung" required: - kontoCheck - kontoCheckVerpflichtend DarlehensWunsch: type: object properties: annuitaetenDarlehen: $ref: "#/components/schemas/AnnuitaetenDarlehensWunsch" forwardDarlehen: $ref: "#/components/schemas/ForwardDarlehensWunsch" id: type: string description: "Zur Referenzierung an anderer Stelle notwendig. Wenn nicht\ \ angegeben, dann wird dieses Feld automatisch befüllt." kfwDarlehen: $ref: "#/components/schemas/KfwDarlehensWunsch" privatDarlehen: $ref: "#/components/schemas/PrivatDarlehensWunsch" regionalFoerderDarlehen: $ref: "#/components/schemas/RegionalFoerderDarlehensWunsch" variablesDarlehen: $ref: "#/components/schemas/VariablesDarlehensWunsch" zwischenFinanzierung: $ref: "#/components/schemas/ZwischenFinanzierungsWunsch" EffektivZinsErhoehendeKosten: type: object description: Effektivzinsbeeinflussende Kosten - Anpassungen nach PAngV properties: anpassen: type: boolean description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." grundbuchEintragungsKostenEinmalig: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." sonstigeKostenBezeichnung: type: string description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." sonstigeKostenEinmalig: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." wohnGebaeudeVersicherungsKostenJaehrlich: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." EffektivZinsRelevanteKosten: type: object properties: beratungsHonorar: type: number grundbuchKosten: type: number sonstigeKosten: type: number tilgungsErsatzProduktKosten: type: number wohnGebaeudeVersicherungsKosten: type: number zusatzSicherheitsKosten: type: number EinkuenfteAusNebentaetigkeit: type: object properties: beginnDerNebentaetigkeit: type: string format: date einnahmenMonatlich: type: number EinnahmenMonatlich: type: object properties: einnahmenMonatlich: type: number Eintrag: type: object properties: abgeltungssteuer: type: number datum: type: string format: date kontofuehrungsGebuehr: type: number laufendeGebuehr: type: number marker: type: array items: type: string saldo: type: number tilgung: type: number zahlung: type: number zinsen: type: number EnergieEffizienzAusweis: type: object description: Nur bei ObjektArt != GRUNDSTUECK. properties: ausweisTyp: type: string enum: - ENDENERGIEBEDARF - ENDENERGIEVERBRAUCH co2Emissionen: type: number description: Co2Emissionen in Kilogramm p.a. je qm endEnergie: type: number description: Endenergie in Kilowattstunden p.a. je qm energieEffizienzAusweisTyp: type: string deprecated: true description: 'Das Feld ist Deprecated und wird bis zur Löschung als Fallback für ''ausweisTyp'' benutzt. Zur Angabe des Energieausweistyps dient das Feld ''ausweisTyp''. ' enum: - ENDENERGIEBEDARF - ENDENERGIEVERBRAUCH hauptEnergieTraeger: type: string enum: - OEL_GAS - PHOTOVOLTAIK_WINDKRAFT - WAERME_KAELTE - STEINKOHLE - BRAUNKOHLE - NETZSTROM - VERDRAENGUNGSSTROM - HOLZ - ABFAELLE - SONSTIGES Erbbaurecht: type: object properties: erbbaurecht: type: boolean description: Erbbaurecht vorhanden erbbauzinsJaehrlich: type: number grundstuecksEigentuemer: type: string enum: - ANDERE - OEFFENTLICH_KIRCHLICH laufzeitBisJahr: type: string description: Die Jahreszahl wird als vierstellig repräsentiert. example: "2037" ErfassteDaten: type: object properties: bankverbindung: $ref: "#/components/schemas/Bankverbindung" datenKontext: type: string enum: - TEST_MODUS - ECHT_GESCHAEFT erstelltAm: type: string format: date readOnly: true externeVorgangsNummer: type: string finanzierungsObjekt: $ref: "#/components/schemas/FinanzierungsObjekt" haushalte: type: array items: $ref: "#/components/schemas/Haushalt" kundenBetreuer: $ref: "#/components/schemas/Partner" leadTracking: $ref: "#/components/schemas/LeadTracking" praeferenzen: $ref: "#/components/schemas/Praeferenzen" tippGeber: $ref: "#/components/schemas/Partner" vorgangsBearbeiter: $ref: "#/components/schemas/Partner" vorgangsNummer: type: string vorhaben: $ref: "#/components/schemas/Vorhaben" required: - vorhaben Ergebnis: type: object properties: _links: $ref: "#/components/schemas/Links" annahmeFrist: type: string format: date-time anpassungsStatus: type: string enum: - NICHT_ANGEPASST - ANGEPASST - ALTERNATIV bausparAngebote: type: array items: $ref: "#/components/schemas/BausparAngebot" beleihung: type: array items: $ref: "#/components/schemas/Beleihung" darlehen: type: array items: $ref: "#/components/schemas/Darlehen" darlehensSumme: type: number effektivZins: type: number elektronischeUnterlagenEinreichung: type: boolean erzeugtAm: type: string format: date-time kennung: type: string machbarkeit: type: string enum: - MACHBAR - UNTER_VORBEHALT - NICHT_MACHBAR meldungen: type: array items: $ref: "#/components/schemas/Meldung" produktFeatures: type: array items: $ref: "#/components/schemas/ProduktFeature" provisionKundenbetreuerRelativ: type: number rateMonatlich: type: number sollZins: type: number vollstaendigkeitsStatus: type: string enum: - NICHT_VOLLSTAENDIG - VOLLSTAENDIG ErgebnisListe: type: object properties: _links: $ref: "#/components/schemas/Links" ergebnisse: type: array items: $ref: "#/components/schemas/Ergebnis" Ergebnisliste: type: object properties: _links: $ref: "#/components/schemas/Links" ergebnisliste: type: array items: $ref: "#/components/schemas/V3Ergebnis" ergebnislisteId: type: string ErmittleErgebnisseRequestBody: type: object description: Anfrage Body für die Ermittlung von Ergebnissen properties: aktualisieren: type: boolean alternativen: type: boolean ermitteln: type: boolean exkludierteProduktAnbieter: type: array items: type: string produktAnbieter: type: array items: type: string provisionsAusgabe: type: boolean Ermittlung: type: object properties: _links: $ref: "#/components/schemas/Links" ergebnisse: type: array items: $ref: "#/components/schemas/Ergebnis" ermittlungsId: type: string ErmittlungsAnfrage: type: object properties: _links: $ref: "#/components/schemas/Links" alternativen: type: boolean erfassteDaten: $ref: "#/components/schemas/ErfassteDaten" ermittlungsId: type: string erstelltAm: type: string format: date-time partnerId: type: string provisionsAusgabe: type: boolean Error: type: object properties: message: type: string statusCode: type: integer format: int32 statusMessage: type: string timestamp: type: string traceId: type: string Finanzbedarf: type: object properties: aussenAnlagen: type: number bauNebenkosten: type: number beratungsHonorar: type: number bereitsBeglichen: type: number co2EmissionenGeplant: type: number deprecated: true description: "Das Feld ist Deprecated, bitte den Wert in Vorhaben.geplanterCo2Wert\ \ erfassen; in Kilogramm p.a. je qm" endEnergieGeplant: type: number deprecated: true description: "Das Feld ist Deprecated, bitte den Wert in Vorhaben.geplanteEnergie\ \ erfassen; in Kilowattstunden p.a. je qm" 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 FinanzierungsObjekt: type: object properties: adresse: $ref: "#/components/schemas/Postadresse" autostellplaetze: type: array items: $ref: "#/components/schemas/Autostellplatz" bestehendeDarlehen: type: array items: $ref: "#/components/schemas/BestehendesDarlehenDesFinanzierungsObjekts" bewirtschaftungsKostenJaehrlich: type: number bodenRichtwert: type: number effektivZinsErhoehendeKosten: $ref: "#/components/schemas/EffektivZinsErhoehendeKosten" erbbaurecht: $ref: "#/components/schemas/Erbbaurecht" gebaeude: $ref: "#/components/schemas/Gebaeude" grundbuchAngabe: $ref: "#/components/schemas/GrundbuchAngabe" grundstueck: $ref: "#/components/schemas/Grundstueck" id: type: string keinBaulandFlaecheInQm: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." marktueblicherKaufpreisProQm: type: number objektArt: type: string enum: - GRUNDSTUECK - EIGENTUMSWOHNUNG - HAUS vergleichsmieteFuerGewerbeflaecheProQm: type: number vergleichsmieteFuerWohnflaecheProQm: type: number verkehrswert: type: number description: "Verkehrswert, nur relevant bei Finanzbedarf AnschlussFinanzierung,\ \ Modernisierung und Kapitalbeschaffung" vorlaeufigerVerkehrswert: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." wohnlage: type: string enum: - GEHOBEN - MITTEL - EINFACH Finanzierungswunsch: type: object properties: bausparWuensche: type: array items: $ref: "#/components/schemas/BausparWunsch" darlehensWuensche: type: array items: $ref: "#/components/schemas/DarlehensWunsch" minItems: 1 id: type: string required: - darlehensWuensche Flurstueck: type: object properties: anteil: $ref: "#/components/schemas/MiteigentumsAnteil" flur: type: string flurstuecksNummer: type: string groesse: type: number ForwardDarlehensWunsch: type: object description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" properties: auszahlungsDatum: type: string format: date deprecated: true bereitstellungsZinsFreieZeitInMonaten: type: integer format: int32 bestehendesDarlehenDerImmobilieIdsBeiAbloesung: type: array description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG items: type: string description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG darlehensBetrag: type: number description: Der Darlehensbetrag muss ein positiver Wert zwischen 1000 und 10 Milliarden sein. provision: type: number sondertilgungOptionalJaehrlich: type: number tilgungsWunsch: $ref: "#/components/schemas/TilgungsWunsch" zinsBindungInJahren: type: integer format: int32 description: Wert muss größer 0 sein. required: - darlehensBetrag - tilgungsWunsch Gebaeude: type: object properties: anzahlDerGewerbeeinheiten: type: integer format: int32 description: Nur bei ObjektArt == HAUS. anzahlDerWohneinheitenImGebaeude: type: integer format: int32 anzahlVollgeschosse: type: integer format: int32 aufbauFinanzierung: type: boolean aufzugVorhanden: type: boolean ausstattung: type: string enum: - EINFACH - MITTEL - GEHOBEN - STARK_GEHOBEN baujahr: type: string description: Die Jahreszahl wird als vierstellig repräsentiert. example: "2022" bauweise: type: string enum: - FACHWERK_MIT_STROH_LEHM - FACHWERK_MIT_ZIEGELN - GLAS_STAHL - HOLZ - MASSIV bezeichnungWohneinheit: type: string description: Nur bei ObjektArt == EIGENTUMSWOHNUNG. dachgeschossAusbau: type: string description: Nur bei ObjektArt == HAUS. enum: - FLACHDACH - NICHT_AUSGEBAUT - TEILWEISE_AUSGEBAUT - VOLL_AUSGEBAUT denkmalschutz: type: boolean description: Nur bei ObjektArt != GRUNDSTUECK. einliegerwohnungVorhanden: type: boolean description: Nur bei ObjektArt == HAUS. energieEffizienzAusweis: $ref: "#/components/schemas/EnergieEffizienzAusweis" geschossLage: type: string description: Nur bei ObjektArt == EIGENTUMSWOHNUNG. enum: - UNTERGESCHOSS - ERDGESCHOSS - ERSTES_OBERGESCHOSS - ZWEITES_OBERGESCHOSS - DRITTES_BIS_FUENFTES_OBERGESCHOSS - AB_SECHSTES_OBERGESCHOSS - UNBEKANNT gewerbeflaeche: $ref: "#/components/schemas/GebaeudeFlaeche" hausAnordnung: type: string enum: - FREISTEHEND - KOPFHAUS - MITTELHAUS hausTyp: type: string description: Nur bei ObjektArt == HAUS. enum: - DOPPELHAUSHAELFTE - EINFAMILIENHAUS - MEHRFAMILIENHAUS - REIHENHAUS - ZWEIFAMILIENHAUS istFertighaus: type: boolean description: Nur bei ObjektArt == HAUS. kellerausbau: type: string enum: - AUSGEBAUT - TEILWEISE_AUSGEBAUT - VORHANDEN kubatur: type: number description: Angabe in Kubikmetern. miteigentumsAnteil: $ref: "#/components/schemas/MiteigentumsAnteil" modernisierungsAngaben: $ref: "#/components/schemas/ModernisierungsAngaben" unterkellerung: type: string description: Nur bei ObjektArt == HAUS. enum: - NICHT_UNTERKELLERT - TEILWEISE_UNTERKELLERT - UNTERKELLERT wohnflaeche: $ref: "#/components/schemas/GebaeudeFlaeche" zustand: type: string description: Nur bei ObjektArt != GRUNDSTUECK. enum: - SEHR_GUT - GUT - MITTEL - MAESSIG - SCHLECHT GebaeudeFlaeche: type: object properties: gesamtGroesse: type: number vermietungsInformationen: $ref: "#/components/schemas/VermietungsInformationen" GirokontoPraeferenz: type: object properties: bestehendeKontoverbindungBei: type: array items: type: string kontowechselWirdBeabsichtigt: type: boolean GrundbuchAngabe: type: object properties: anmerkungen: type: string bandUndBlatt: type: string flurstuecke: type: array items: $ref: "#/components/schemas/Flurstueck" ort: type: string description: Ort des als Grundbuchamt zuständigen Amtsgerichtes rechteInAbteilung2: $ref: "#/components/schemas/RechteAbteilung2" Grundstueck: type: object properties: groesse: type: number grundstuecksArt: type: string enum: - UNBEBAUTES_WOHNGRUNDSTUECK - UNBEBAUTES_MISCHGRUNDSTUECK - UNBEBAUTES_GEWERBEGRUNDSTUECK - LANDWIRTSCHAFTLICHES_GRUNDSTUECK - SONSTIGES_GRUNDSTUECK Haushalt: type: object properties: antragsteller: type: array items: $ref: "#/components/schemas/Antragsteller" anzahlErwachseneImHaushalt: type: integer format: int32 description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." anzahlKinderNichtImHaushalt: type: integer format: int32 description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." bestehendeImmobilien: type: array items: $ref: "#/components/schemas/BestehendeImmobilie" erfahrungImmobilienFinanzierung: type: boolean id: type: string kfzAnzahl: type: integer format: int32 description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." kfzKostenMonatlich: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." kinder: type: array items: $ref: "#/components/schemas/Kind" lebenshaltungsKostenMonatlich: type: number description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht\ \ von allen Produktanbietern bei der Angebotsermittlung berücksichtigt." obligo: $ref: "#/components/schemas/VermoegenVerbindlichkeiten" positionen: $ref: "#/components/schemas/HaushaltsPositionen" HaushaltsPositionen: type: object properties: bankUndSparguthaben: type: array items: $ref: "#/components/schemas/BankUndSparguthaben" bausparvertraege: type: array items: $ref: "#/components/schemas/BestehenderBausparvertrag" ehegattenUnterhalt: type: array items: $ref: "#/components/schemas/EinnahmenMonatlich" einkuenfteAusNebentaetigkeit: type: array items: $ref: "#/components/schemas/EinkuenfteAusNebentaetigkeit" lebensUndRentenVersicherungen: type: array items: $ref: "#/components/schemas/LebensOderRentenversicherungVermoegen" mietAusgaben: type: array items: $ref: "#/components/schemas/MietAusgaben" privateDarlehen: type: array items: $ref: "#/components/schemas/Verbindlichkeit" privateKrankenversicherung: type: array items: $ref: "#/components/schemas/AusgabenMonatlich" ratenkredite: type: array items: $ref: "#/components/schemas/Verbindlichkeit" sonstigeAusgaben: type: array items: $ref: "#/components/schemas/AusgabenMonatlich" sonstigeEinnahmen: type: array items: $ref: "#/components/schemas/EinnahmenMonatlich" sonstigeVerbindlichkeiten: type: array items: $ref: "#/components/schemas/Verbindlichkeit" sonstigeVermoegen: type: array items: $ref: "#/components/schemas/Vermoegen" sparplaene: type: array items: $ref: "#/components/schemas/Sparplaene" unbefristeteZusatzRenten: type: array items: $ref: "#/components/schemas/EinnahmenMonatlich" unterhaltsVerpflichtungen: type: array items: $ref: "#/components/schemas/AusgabenMonatlich" variableEinkuenfte: type: array items: $ref: "#/components/schemas/EinnahmenMonatlich" versicherungsAusgaben: type: array items: $ref: "#/components/schemas/AusgabenMonatlich" wertpapiere: type: array items: $ref: "#/components/schemas/Wertpapiere" KfwDarlehensWunsch: type: object description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" properties: bestehendesDarlehenDerImmobilieIdsBeiAbloesung: type: array description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG items: type: string description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG darlehensBetrag: type: number description: Der Darlehensbetrag muss ein positiver Wert zwischen 1000 und 10 Milliarden sein. kfwEnergieEffizienzGruppe: type: string description: "Nur bei Programm 261 (SANIERUNG), 297 (NEUBAU) und 298 (NEUBAU)\ \ notwendig. STANDARD ist nur für alte Programme vorgesehen." enum: - STANDARD - NEUBAU - SANIERUNG kfwEnergieEffizienzStandard: type: string enum: - STANDARD_40 - STANDARD_40_PLUS - STANDARD_40_EEK - STANDARD_40_NH - STANDARD_55 - STANDARD_55_EEK - STANDARD_70 - STANDARD_70_EEK - STANDARD_85 - STANDARD_85_EEK - STANDARD_100 - STANDARD_100_EEK - STANDARD_DENKMAL - STANDARD_DENKMAL_EEK - KLIMAFREUNDLICH_STANDARD - KLIMAFREUNDLICH_QNG kfwProgramm: type: string description: "Programm 261 wird nur noch in der Sanierungsvariante, die\ \ Programme 141, 151, 152, 153, 155, 167 und 262 werden gar nicht mehr\ \ angeboten" 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 - PROGRAMM_308 - PROGRAMM_358 - PROGRAMM_359 kfwSanierungsFahrplanLiegtVor: type: boolean description: serielles Sanieren laufzeitInJahren: type: integer format: int32 provision: type: number tilgungsfreieAnlaufjahre: type: integer format: int32 description: "Erlaubt ist 1,2,3,4,5. Maximalwert abhängig von der Laufzeit" zinsBindungInJahren: type: integer format: int32 description: "Wert muss größer 0 sein. Bei Programm 124: 5 oder 10, bei\ \ Programm 300/308 nur 10, sonst: 10 oder 20." required: - darlehensBetrag Kind: type: object properties: geburtsdatum: type: string format: date id: type: string kindergeldWirdBezogen: type: boolean name: type: string unterhaltsEinnahmenBetragMonatlich: type: number KonditionsUebersicht: type: object properties: darlehenId: type: string exzerpt: type: string html: type: string produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" LeadTracking: type: object properties: kampagne: type: string keyword: type: string kundenBetreuerBenachrichtigen: type: boolean trackingId: type: string LebensOderRentenversicherungVermoegen: type: object properties: id: type: string maximalAufzuloesenderBetrag: type: number praemieMonatlich: type: number rueckkaufsWertAktuell: type: number tarif: type: string typ: type: string enum: - KAPITALBILDENDE_LEBENSVERSICHERUNG - FONDSGEBUNDENE_LEBENSVERSICHERUNG - KAPITALBILDENDE_RENTENVERSICHERUNG - FONDSGEBUNDENE_RENTENVERSICHERUNG - RISIKO_LEBENSVERSICHERUNG vermoegensEinsatz: type: string enum: - KEIN_EINSATZ - ABTRETEN - AUFLOESEN versicherungsGesellschaft: type: string versicherungsSumme: type: number vertragsBeginn: type: string format: date vertragsEnde: type: string format: date vertragsNummer: type: string verwaltungsgebuehrenJaehrlich: type: number LegitimationsDaten: type: object properties: ausstellendeBehoerde: type: string ausstellungsdatum: type: string format: date ausweisArt: type: string enum: - PERSONALAUSWEIS - REISEPASS - ANDERE ausweisArtBeiAndererAusweis: type: string description: Nur wenn ausweisArt = ANDERE ausweisNummer: type: string Link: type: object properties: deprecation: type: string href: type: string hreflang: type: string name: type: string profile: type: string templated: type: boolean title: type: string type: type: string Links: type: object additionalProperties: $ref: "#/components/schemas/Link" Meldung: type: object properties: bereichsZuordnung: type: string enum: - ANTRAGSTELLER - OBJEKT - VORHABEN - ALTERNATIV - ANPASSUNG - UNBERUECKSICHTIGTE_ANGABE bereichsZuordnungId: type: string description: "Die ID ist in der Kundenangaben-API erforderlich, um die Entitä\ t zu identifizieren, welche angepasst werden muss." code: type: string kundenangabenApiFelder: type: array description: "Bei der angegebenen Meldung sind die betroffenen Felder in\ \ der Kundenangaben-API anzupassen. Nutze diese Info, um zu identifizieren,\ \ welche konkreten Felder angepasst werden müssen." items: type: string description: "Bei der angegebenen Meldung sind die betroffenen Felder\ \ in der Kundenangaben-API anzupassen. Nutze diese Info, um zu identifizieren,\ \ welche konkreten Felder angepasst werden müssen." meldungsKategorie: type: string enum: - AUSZAHLUNGS_VORAUSSETZUNG - MACHBAR - MACHBARKEITS_HINWEIS - ANPASSUNG_KUNDENWUNSCH - ANPASSUNG_VERTRIEBSWUNSCH - UNBERUECKSICHTIGTE_ANGABE - KONDITIONEN_UNTER_VORBEHALT_VOLLSTAENDIGER_DATEN - KONDITIONEN_UNTER_VORBEHALT_EXTERNER_SCHNITTSTELLEN - MACHBARKEIT_UNTER_VORBEHALT_VOLLSTAENDIGER_DATEN - MACHBARKEIT_UNTER_VORBEHALT_EXTERNER_SCHNITTSTELLEN - MACHBAR_UNTER_VORBEHALT_PRODUZENT - NICHT_MACHBAR - NICHT_ANBIETBAR produktAnbieterId: type: string text: type: string Meldungen: type: object properties: _links: $ref: "#/components/schemas/Links" meldungen: type: array items: $ref: "#/components/schemas/Meldung" MietAusgaben: type: object properties: ausgabenMonatlich: type: number entfallenMitFinanzierung: type: boolean MiteigentumsAnteil: type: object description: Nur bei ObjektArt == EIGENTUMSWOHNUNG. properties: anteil: type: number format: double gesamt: type: integer format: int32 ModernisierungsAngaben: type: object properties: badWc: type: boolean bodenWandTreppe: type: boolean dach: type: boolean fenster: type: boolean heizungZentral: type: boolean modernisierungsGrad: type: string enum: - GERING - MITTEL - HOCH modernisierungsJahr: type: string description: Die Jahreszahl wird als vierstellig repräsentiert. example: "2022" raumaufteilung: type: boolean stromAbwasserHeizkoerper: type: boolean waermedaemmung: type: boolean wurdeModernisiert: type: boolean 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 rateMonatlich: type: number typ: type: string enum: - ARBEITGEBERDARLEHEN - BAUSPARDARLEHEN - OEFFENTLICHES_DARLEHEN - RATENKREDIT zinsBindung: $ref: "#/components/schemas/ZinsBindung" Partner: type: object properties: anrede: type: string enum: - FRAU - HERR anschrift: $ref: "#/components/schemas/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 description: Die ID eines Partners im Europace2 System telefonnummer: type: string vertriebsOrganisation: $ref: "#/components/schemas/VertriebsOrganisation" vorname: type: string webseite: type: string Postadresse: type: object properties: hausnummer: type: string ort: type: string postleitzahl: type: string strasse: type: string Praeferenzen: type: object properties: girokonto: $ref: "#/components/schemas/GirokontoPraeferenz" tilgungssatzwechselPraeferenz: $ref: "#/components/schemas/TilgungsSatzWechselPraeferenz" PrivatDarlehensWunsch: type: object description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" properties: bestehendesDarlehenDerImmobilieIdsBeiAbloesung: type: array description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG items: type: string description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG darlehensBetrag: type: number description: Der Darlehensbetrag muss ein positiver Wert zwischen 1000 und 10 Milliarden sein. laufzeitInMonaten: type: integer format: int32 description: Wert muss größer 0 sein. provision: type: number required: - darlehensBetrag ProduktAnbieter: type: object properties: _links: $ref: "#/components/schemas/Links" name: type: string partnerId: type: string produktAnbieterId: type: string ProduktFeature: type: object properties: produktAnbieterId: type: string produktFeature: type: string ProvisionsInfo: type: object properties: _links: $ref: "#/components/schemas/Links" betrag: type: number partnerId: type: string RechteAbteilung2: type: object description: "Belastungen und Beschränkungen in der Nutzbarkeit des Grundstü\ cks. Leitungsrechte, Verzichte auf Abstandsflächen, Wegerechte, Insolvenzvermerke." properties: beschreibung: type: string betrag: type: number vorhanden: type: boolean RegionalFoerderDarlehensWunsch: type: object description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" properties: bestehendesDarlehenDerImmobilieIdsBeiAbloesung: type: array description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG items: type: string description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG darlehensBetrag: type: number description: Der Darlehensbetrag muss ein positiver Wert zwischen 1000 und 10 Milliarden sein. laufzeitInJahren: type: integer format: int32 provision: type: number regionalFoerderbankProgramm: type: string enum: - L_BANK_KOMBI_DARLEHEN_WOHNEN - L_BANK_WOHNEN_MIT_KIND - L_BANK_WOHNEN_MIT_ZUKUNFT - NRW_BANK_WOHNEIGENTUM - NRW_BANK_GEBAEUDESANIERUNG - NRW_BANK_NACHHALTIG_WOHNEN tilgungsfreieAnlaufjahre: type: integer format: int32 zinsBindungInJahren: type: integer format: int32 description: Wert muss größer 0 sein. required: - darlehensBetrag - regionalFoerderbankProgramm SituationNachRenteneintritt: type: object description: nur bei art != RENTNER properties: gesetzlicheRenteMonatlich: type: number privateRenteMonatlich: type: number rentenBeginn: type: string format: date sonstigesEinkommenMonatlich: type: number SonderZahlung: type: object properties: anzahl: type: integer format: int32 betrag: type: number termin: type: string format: date zahlweise: type: string enum: - EINMALIG - MONATLICH - VIERTELJAEHRLICH - HALBJAEHRLICH - JAEHRLICH SparPhase: type: object properties: guthabenBeiZuteilung: type: number sparBeitragMonatlich: type: number sparPhaseInJahren: type: integer format: int32 Sparplaene: type: object properties: aktuellerWert: type: number description: Betrag des aktuellen Bank- und Sparguthaben beitragMonatlich: type: number ertrag: type: number deprecated: true description: 'Das Feld ist Deprecated und wird bis zur Löschung als Fallback für ''maximalAufzuloesenderWert'' benutzt. Zur Angabe des einzusetzenden Vermögens dient das Feld ''maximalAufzuloesenderWert''. ' maximalAufzuloesenderWert: type: number description: Maximal einzusetzender Betrag des Bank- und Sparguthabens vermoegensEinsatz: type: string enum: - KEIN_EINSATZ - ABTRETEN - AUFLOESEN zukuenftigeEinnahmen: type: number Staat: type: object properties: isoCountryCode: type: string name: type: string Tilgung: type: object properties: anfaenglicheTilgung: type: number sonderTilgungJaehrlich: type: number tilgungsBeginn: type: string format: date tilgungsErsatzProduktId: type: string tilgungsart: type: string enum: - VOLLTILGER - TILGUNGS_AUSGESETZT - ANFAENGLICHE_TILGUNG - RATE tilgungsfreieAnlaufJahre: type: integer format: int32 TilgungsPhase: type: object properties: bausparDarlehenSumme: type: number sollZinsNachZuteilung: type: number tilgungsBeitragMonatlich: type: number tilgungsPhaseInJahren: type: integer format: int32 TilgungsSatzWechselPraeferenz: type: object properties: mindestensBenoetigt: type: integer format: int32 tilgungsSatzwechselPraeferenz: type: string enum: - MINDESTENS_BENOETIGT - NICHT_EINGEPLANT_ODER_ABSEHBAR - EGAL TilgungsWunsch: type: object properties: anfaenglicheTilgung: type: number description: "Darf nur angegeben werden, wenn 'volltilgerWennAnnuitaetenOderForward'\ \ und 'rate' nicht gesetzt sind. Wert muss größer/gleich 0 sein" ausgesetztBerechnet: type: boolean description: ausgesetztBerechnet und ausgesetztEigenesAngebot dürfen nicht beide true sein ausgesetztEigenesAngebot: type: boolean description: ausgesetztBerechnet und ausgesetztEigenesAngebot dürfen nicht beide true sein bausparWunsch: $ref: "#/components/schemas/BausparWunsch" rate: type: number description: "Darf nur angegeben werden, wenn 'anfaenglicheTilgung' und\ \ 'volltilgerWennAnnuitaetenOderForward' nicht gesetzt sind. Wert muss\ \ größer 0 sein" tilgungsBeginn: type: string format: date tilgungsErsatzProduktId: type: string volltilgerWennAnnuitaetenOderForward: type: boolean description: "Darf nur angegeben werden, wenn 'anfaenglicheTilgung' und\ \ 'rate' nicht gesetzt sind." Unterlage: type: object properties: bezugsObjektId: type: string code: type: string faelligkeit: type: string enum: - ZUR_VERBINDLICHEN_ANGEBOTSANNAHME - VOR_DER_ERSTEN_AUSZAHLUNG - VOR_JEDER_AUSZAHLUNG - VOR_AUSZAHLUNG_LETZTE_RATE - NACHZUREICHEN_SOBALD_VERFUEGBAR produktAnbieterId: type: string text: type: string zuordnung: type: string enum: - ANTRAGSTELLER - OBJEKT - VORHABEN - ALTERNATIV - ANPASSUNG - UNBERUECKSICHTIGTE_ANGABE Unterlagen: type: object properties: _links: $ref: "#/components/schemas/Links" unterlagen: type: array items: $ref: "#/components/schemas/Unterlage" V3Ergebnis: type: object properties: _links: $ref: "#/components/schemas/Links" absicherungen: type: array items: $ref: "#/components/schemas/Absicherung" annahmeFrist: type: string format: date-time anpassungsStatus: type: string enum: - NICHT_ANGEPASST - ANGEPASST - ALTERNATIV bausparAngebote: type: array items: $ref: "#/components/schemas/BausparAngebot" beleihung: type: array items: $ref: "#/components/schemas/Beleihung" darlehen: type: array items: $ref: "#/components/schemas/Darlehen" darlehensSumme: type: number effektivZins: type: number elektronischeUnterlagenEinreichung: type: boolean erzeugtAm: type: string format: date-time gemerktesAngebot: $ref: "#/components/schemas/V3GemerktesAngebot" kennung: type: string machbarkeit: type: string enum: - MACHBAR - UNTER_VORBEHALT - NICHT_MACHBAR meldungen: type: array items: $ref: "#/components/schemas/Meldung" produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" produktFeatures: type: array items: $ref: "#/components/schemas/ProduktFeature" provisionKundenbetreuerRelativ: type: number rateMonatlich: type: number sollZins: type: number vollstaendigkeitsStatus: type: string enum: - NICHT_VOLLSTAENDIG - VOLLSTAENDIG V3GemerktesAngebot: type: object properties: _links: $ref: "#/components/schemas/Links" absicherungen: type: array items: $ref: "#/components/schemas/Absicherung" annahmeFrist: type: string format: date-time anpassungsStatus: type: string enum: - NICHT_ANGEPASST - ANGEPASST - ALTERNATIV basisAngebotsId: type: string bausparAngebote: type: array items: $ref: "#/components/schemas/BausparAngebot" beleihung: type: array items: $ref: "#/components/schemas/Beleihung" beschreibung: type: string bewertung: type: string enum: - ANGEBOT_ENTSPRICHT_MEINER_EMPFEHLUNG - ANGEBOT_ENTSPRICHT_DEM_WUNSCH_DES_KUNDEN darlehen: type: array items: $ref: "#/components/schemas/Darlehen" darlehensSumme: type: number effektivZins: type: number elektronischeUnterlagenEinreichung: type: boolean erzeugtAm: type: string format: date-time fazit: type: string id: type: string kennung: type: string laufendeNummer: type: integer format: int32 machbarkeit: type: string enum: - MACHBAR - UNTER_VORBEHALT - NICHT_MACHBAR produktAnbieter: $ref: "#/components/schemas/ProduktAnbieter" produktFeatures: type: array items: type: string provisionKundenbetreuerRelativ: type: number rateMonatlich: type: number sollZins: type: number uebergabeAn: type: string uebergabeDatum: type: string format: date-time vollstaendigkeitsStatus: type: string enum: - NICHT_VOLLSTAENDIG - VOLLSTAENDIG zuGrundeLiegendesAngebot: type: string VariablesDarlehensWunsch: type: object description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" properties: bestehendesDarlehenDerImmobilieIdsBeiAbloesung: type: array description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG items: type: string description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG darlehensBetrag: type: number description: Der Darlehensbetrag muss ein positiver Wert zwischen 1000 und 10 Milliarden sein. provision: type: number tilgungsWunsch: $ref: "#/components/schemas/TilgungsWunsch" required: - darlehensBetrag - tilgungsWunsch Verbindlichkeit: type: object properties: glaeubiger: type: string laufzeitEnde: type: string format: date rateMonatlich: type: number restschuld: type: number wirdAbgeloest: type: boolean VermietungsInformationen: type: object properties: mieteinnahmenNettoKaltMonatlich: type: number nutzungsArt: type: string enum: - EIGENGENUTZT - TEIL_VERMIETET - VERMIETET vermieteteFlaeche: type: number Vermoegen: type: object properties: aktuellerWert: type: number description: Betrag des aktuellen Bank- und Sparguthaben ertrag: type: number deprecated: true description: 'Das Feld ist Deprecated und wird bis zur Löschung als Fallback für ''maximalAufzuloesenderWert'' benutzt. Zur Angabe des einzusetzenden Vermögens dient das Feld ''maximalAufzuloesenderWert''. ' maximalAufzuloesenderWert: type: number description: Maximal einzusetzender Betrag des Bank- und Sparguthabens vermoegensEinsatz: type: string enum: - KEIN_EINSATZ - ABTRETEN - AUFLOESEN zukuenftigeEinnahmen: type: number VermoegenVerbindlichkeit: type: object properties: aktuellerWert: type: number anrechnungFuerBlankoAnteil: type: number bezeichner: type: string kontonummer: type: string vermoegensTyp: type: string enum: - VERMOEGEN - VERBINDLICHKEIT VermoegenVerbindlichkeiten: type: object description: "Diese Angabe ist produktanbieterspezifisch, sie wird nicht von\ \ allen Produktanbietern bei der Angebotsermittlung berücksichtigt." properties: vermoegenOderVerbindlichkeiten: type: array items: $ref: "#/components/schemas/VermoegenVerbindlichkeit" VertriebsOrganisation: type: object properties: firmenName: type: string id: type: string organisationsName: type: string organisationsNameFuerProvisionsClearing: type: string partner: type: string vertriebsOrganisationsId: type: string Vorhaben: type: object properties: eigenleistungWennNeubauOderModernisierungsmassnahmen: type: number externeBausparAngebote: type: array items: $ref: "#/components/schemas/BausparAngebotExtern" finanzbedarf: $ref: "#/components/schemas/Finanzbedarf" finanzierungswunsch: $ref: "#/components/schemas/Finanzierungswunsch" geplanteEnergie: type: number description: in Kilowattstunden p.a. je qm geplanterCo2Wert: type: number description: in Kilogramm p.a. je qm id: type: string nachfinanzierung: type: boolean description: "Wenn es sich um eine Nachfinanzierung handelt, dann dieses\ \ Feld auf true setzen. Wird z.Zt. nur von der DSL Bank ausgewertet. Nur\ \ setzen, wenn auch bestehende Darlehen in der Finanzierungsimmobilie\ \ vorhanden sind." nachrangigeExterneDarlehen: type: array items: $ref: "#/components/schemas/NachrangigesExternesDarlehen" verwendungszweck: type: string description: "Wenn es sich um eine Anschlussfinanzierung handelt und ein\ \ bestehendes Darlehen vorhanden ist, dann muss dieses den Wert 'verwendenAls'='ABLOESEN'\ \ beinhalten. Außerdem wird bei einer Anschlussfinanzierung ein Haushalt\ \ mit einem Antragsteller und Einkommen benötigt." enum: - ANSCHLUSSFINANZIERUNG - KAUF - KAUF_NEUBAU_VOM_BAUTRAEGER - MODERNISIERUNG_UMBAU_ANBAU - NEUBAU - KAPITALBESCHAFFUNG required: - finanzierungswunsch Wertpapiere: type: object properties: aktuellerWert: type: number description: Betrag des aktuellen Bank- und Sparguthaben dividendenJaehrlich: type: number ertrag: type: number deprecated: true description: 'Das Feld ist Deprecated und wird bis zur Löschung als Fallback für ''maximalAufzuloesenderWert'' benutzt. Zur Angabe des einzusetzenden Vermögens dient das Feld ''maximalAufzuloesenderWert''. ' maximalAufzuloesenderWert: type: number description: Maximal einzusetzender Betrag des Bank- und Sparguthabens vermoegensEinsatz: type: string enum: - KEIN_EINSATZ - ABTRETEN - AUFLOESEN zukuenftigeEinnahmen: type: number Zahlungsplaene: type: object properties: _links: $ref: "#/components/schemas/Links" zahlungsplaene: type: array items: $ref: "#/components/schemas/Zahlungsplan" Zahlungsplan: type: object properties: _links: $ref: "#/components/schemas/Links" bausteinTyp: type: string enum: - ANNUITAETEN_DARLEHEN - FORWARD_DARLEHEN - REGIONAL_FOERDER_DARLEHEN - KFW_DARLEHEN - PRIVAT_DARLEHEN - ZWISCHEN_FINANZIERUNG - VARIABLES_DARLEHEN - BAUSPARVERTRAG gesamtSumme: $ref: "#/components/schemas/Eintrag" identifier: type: string sparplanSummenEintragZumZuteilungsZeitpunkt: $ref: "#/components/schemas/Eintrag" summeEndeDerZinsbindung: $ref: "#/components/schemas/Eintrag" typ: type: string enum: - SPARPLAN - TILGUNGSPLAN zahlungen: type: array items: $ref: "#/components/schemas/Eintrag" ZinsBindung: type: object properties: endetAm: type: string format: date jahre: type: integer format: int32 monate: type: integer format: int32 restschuldNachZinsBindungsEnde: type: number summeZinsenInZinsBindung: type: number ZwischenFinanzierungsWunsch: type: object description: "muss leer sein, wenn eines der anderen Attribute gefüllt ist" properties: bestehendesDarlehenDerImmobilieIdsBeiAbloesung: type: array description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG items: type: string description: für Vorhaben verwendungszweck==ANSCHLUSSFINANZIERUNG darlehensBetrag: type: number description: Der Darlehensbetrag muss ein positiver Wert zwischen 1000 und 10 Milliarden sein. detailsZurVerwendung: type: string maximaleLaufzeitInMonaten: type: integer format: int32 provision: type: number verwendungszweck: type: string enum: - VORFINANZIERUNG_OEFFENTLICHER_MITTEL - VERKAUF_EINES_ANDEREN_OBJEKTS - SONSTIGE_VERWENDUNG required: - darlehensBetrag Zwischenfinanzierung: type: object properties: detailsZurVerwendung: type: string maximaleLaufzeitInMonaten: type: integer format: int32 verwendungszweck: type: string enum: - VORFINANZIERUNG_OEFFENTLICHER_MITTEL - VERKAUF_EINES_ANDEREN_OBJEKTS - SONSTIGE_VERWENDUNG securitySchemes: oAuth2: flows: clientCredentials: scopes: baufinanzierung:angebot:ermitteln: Ermitteln eines Angebots tokenUrl: https://api.europace.de/auth/access-token type: oauth2