Merge pull request #195 from europace/api-update-pvs-22-04-2024-09-46

Neue Api-Version vom 22-04-2024-09-46
europace · Apr 22, 2024 · 13b385b · 13b385b
2 parents 96764ee + 8ee1852
commit 13b385b
Show file tree

Hide file tree

Showing 5 changed files with 232 additions and 1 deletion.
diff --git a/api/baufi-passende-vorschlaege-api.yaml b/api/baufi-passende-vorschlaege-api.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   description: 'As consumer, I want to determine appropriate financing proposals based on my situation and preferences. Analyze my needs and compare and find the best offers which fits my needs.'
-  version: 1.0.46
+  version: 1.0.51
   title: Vorschlaege API
   contact:
     name: Europace AG
@@ -449,6 +449,10 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Darlehen'
+        endEnergieBedarfAktuell:
+          type: number
+          description: 'Current final energy requirement in KWh/m²a'
+          example: 85.50
     Finanzierungsbedarf:
       type: object
       required:
@@ -510,6 +514,10 @@ components:
         grundstueckBereitsBezahlt:
           type: boolean
           description: 'True, if property already paid'
+        endEnergieGeplant:
+          type: number
+          description: 'Planned final energy requirement after modernization in KWh/m²a'
+          example: 4.50
     Anschrift:
       type: object
       properties:

diff --git a/docs/requests/request-ermitteln.json b/docs/requests/request-ermitteln.json
@@ -0,0 +1,55 @@
+{
+  "metadaten": {
+    "datenkontext": "TEST_MODUS",
+    "extKundenId": "",
+    "extClientId": ""
+  },
+  "kundenangaben": {
+    "haushalte": [
+      {
+        "kunden": [
+          {
+            "beschaeftigtSeit": "2010-01-26",
+            "arbeitBefristet": false,
+            "einkommenNetto": 5000,
+            "geburtsdatum": "1999-05-26",
+            "beschaeftigungsArt": "ANGESTELLTER"
+          }
+        ],
+        "finanzielleSituation": {
+          "eigenKapital": 100000,
+          "sonstigeEinnahmen": 0,
+          "nichtAbgeloestePrivateDarlehenRestschuld": 0,
+          "nichtAbgeloesteRatenkrediteRestschuld": 0
+        }
+      }
+    ],
+    "finanzierungsbedarf": {
+      "finanzierungszweck": "KAUF",
+      "grundstueckKaufpreis": 380000,
+      "kaufpreis": 250000,
+      "modernisierungsKostenInklEigenleistungen": 25000,
+      "modernisierungEigenleistung": 15000,
+      "praeferenzen": {
+        "rate": 900,
+        "faelligkeitsdatum": "{{faelligkeitsdatum}}",
+        "kreditEntscheidungsZeit": "{{kreditEntscheidungsZeit}}",
+        "laufzeit": 60,
+        "produktAnbieterIds": "DKB"
+      }
+    },
+    "finanzierungsobjekt": {
+      "objektArt": "EINFAMILIENHAUS",
+      "vermietet": false,
+      "baujahr": 2000,
+      "gewerblicheNutzung": false,
+      "anschrift": {
+        "plz": "10179",
+        "ort": "Berlin",
+        "strasse": "Klosterstrasse",
+        "hausnummer": "8"
+      },
+      "wohnflaeche": 150
+    }
+  }
+}
diff --git a/docs/requests/request-max-kaufpreis.json b/docs/requests/request-max-kaufpreis.json
@@ -0,0 +1,50 @@
+{
+  "metadaten": {
+    "datenkontext": "TEST_MODUS",
+    "gewuenschteAnzahlVorschlaege": 1,
+    "mode": "maximum-offer"
+  },
+  "kundenangaben": {
+    "haushalte": [
+      {
+        "kunden": [
+          {
+            "einkommenNetto": 5000,
+            "geburtsdatum": "1983-10-20",
+            "beschaeftigungsArt": "ANGESTELLTER"
+          }
+        ],
+        "finanzielleSituation": {
+          "eigenKapital": 19000
+        }
+      }
+    ],
+    "finanzierungsbedarf": {
+      "grundstueckBereitsBezahlt": false,
+      "praeferenzen": {
+        "zinsbindungInJahren": 10
+      },
+      "finanzierungszweck": "KAUF",
+      "kaufpreis": 1,
+      "maklergebuehr": 0
+    },
+    "finanzierungsobjekt": {
+      "vermietet": false,
+      "gewerblicheNutzung": false,
+      "darlehensliste": [
+        {
+          "restschuld": {}
+        }
+      ],
+      "objektArt": "EINFAMILIENHAUS",
+      "anschrift": {
+        "plz": "15517",
+        "ort": "Königsdorf",
+        "strasse": "",
+        "hausnummer": ""
+      },
+      "wohnflaeche": 100,
+      "baujahr": 2020
+    }
+  }
+}
diff --git a/docs/requests/request-prolongation.json b/docs/requests/request-prolongation.json
@@ -0,0 +1,81 @@
+{
+  "metadaten": {
+    "datenkontext": "TEST_MODUS",
+    "extKundenId": "",
+    "extClientId": ""
+  },
+  "kundenangaben": {
+    "haushalte": [
+      {
+        "kunden": [
+          {
+            "beschaeftigtSeit": "2010-01-26",
+            "arbeitBefristet": false,
+            "einkommenNetto": 5000,
+            "geburtsdatum": "1999-05-26",
+            "beschaeftigungsArt": "ANGESTELLTER"
+          }
+        ],
+        "finanzielleSituation": {
+          "eigenKapital": 100000,
+          "sonstigeEinnahmen": 0,
+          "nichtAbgeloestePrivateDarlehenRestschuld": 0,
+          "nichtAbgeloesteRatenkrediteRestschuld": 0
+        }
+      }
+    ],
+    "finanzierungsbedarf": {
+      "finanzierungszweck": "ANSCHLUSSFINANZIERUNG",
+      "grundstueckKaufpreis": 380000,
+      "kaufpreis": 250000,
+      "modernisierungsKostenInklEigenleistungen": 25000,
+      "modernisierungEigenleistung": 15000,
+      "sonderzahlungZumZinsbindungsEnde" : 20000,
+      "praeferenzen": {
+        "rate": 900,
+        "faelligkeitsdatum": "{{faelligkeitsdatum}}",
+        "kreditEntscheidungsZeit": "{{kreditEntscheidungsZeit}}",
+        "laufzeit": 15,
+        "zinsbindungInJahren": 10,
+        "bereitstellungszinsfreieZeit": 3,
+        "tilgung": 2.00
+      },
+      "darlehenswunsch": 250000
+    },
+    "finanzierungsobjekt": {
+      "objektArt": "EINFAMILIENHAUS",
+      "vermietet": false,
+      "baujahr": 2000,
+      "gewerblicheNutzung": false,
+      "anschrift": {
+        "plz": "10179",
+        "ort": "Berlin",
+        "strasse": "Klosterstrasse",
+        "hausnummer": "8"
+      },
+      "wohnflaeche": 150,
+      "marktwert": 1000000,
+      "darlehensliste": [
+        {
+          "wirdAbgeloest": false,
+          "darlehensgeber": "MUSTERBANK",
+          "grundschuld": 500000,
+          "restschuld": {
+            "aktuell": 45879.81
+          }
+        },
+        {
+          "wirdAbgeloest": true,
+          "darlehensgeber": "SPARDA_BW",
+          "grundschuld": 125867.85,
+          "zinsbindungBis": "2021-12-31",
+          "laufzeitende": "2054-09-30",
+          "restschuld": {
+            "zumAbloeseTermin": 125867.85
+          },
+          "darlehenskontonummer": "Abloesedarlehen"
+        }
+      ]
+    }
+  }
+}
diff --git a/docs/requests/request.json b/docs/requests/request.json
@@ -0,0 +1,37 @@
+{
+  "metadaten": {
+    "datenkontext": "TEST_MODUS",
+    "gewuenschteAnzahlVorschlaege": 10
+  },
+  "kundenangaben": {
+    "haushalte": [
+      {
+        "kunden": [
+          {
+            "beschaeftigtSeit": "2018-08-01",
+            "beschaeftigungsArt": "ANGESTELLTER",
+            "arbeitBefristet": false,
+            "einkommenNetto": 6500,
+            "geburtsdatum": "1996-03-09"
+          }
+        ],
+        "finanzielleSituation": {
+          "eigenKapital": 5000,
+          "nichtAbgeloesteRatenkrediteRestschuld": 0
+        }
+      }
+    ],
+    "finanzierungsbedarf": {
+      "finanzierungszweck": "KAUF",
+      "kaufpreis": 299000,
+      "praeferenzen": {
+        "produktAnbieterIds": "DKB,ING_DIBA"
+      }
+    },
+    "finanzierungsobjekt": {
+      "anschrift": {
+        "plz": "45711"
+      }
+    }
+  }
+}