Release 1.5.0 - Integration of ID fields for unique external referenc…

…ing (#190)

The ID field is output during the query (`GET`). When updating (`PUT`),
the ID must be reused if the same object is referenced. The ID field is
not required when creating (`POST`).

As this is a significant change to the content, the minor version number
is incremented here.

kundenangaben-openapi.yaml

@@ -8,7 +8,7 @@ info:
     name: Europace AG
     url: http://developer.europace.de
     email: [email protected]
-  version: 1.4.39; dff3fe220311d92e22f73a3a0b456088a3d0c2a8
+  version: 1.5.0; f1accdacee254c339eb81e25fe81cec7549b9445
 externalDocs:
   url: https://developer.europace.de/api/baufismart-kundenangaben-api
 servers:
@@ -103,16 +103,16 @@ paths:
       responses:
         "503":
           $ref: '#/components/responses/ServiceNotAvailable'
-        "404":
-          $ref: '#/components/responses/NotFound'
-        "422":
-          $ref: '#/components/responses/UnprocessableEntity'
         "204":
           description: Kundenangaben in einem bestehenden Vorgang überschrieben
           headers:
             X-TraceId:
               $ref: '#/components/headers/tracingIdHeader'
               style: simple
+        "404":
+          $ref: '#/components/responses/NotFound'
+        "422":
+          $ref: '#/components/responses/UnprocessableEntity'
         "401":
           $ref: '#/components/responses/Unauthorized'
         "429":
@@ -320,6 +320,9 @@ components:
       - $ref: '#/components/schemas/Finanzierungsbaustein'
       - type: object
         properties:
+          id:
+            type: string
+            description: Eindeutige interne ID
           referenzId:
             type: string
             description: "Eindeutige Referenz-ID für diesen Finanzierungsbaustein.\
@@ -560,6 +563,9 @@ components:
     Bankverbindung:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         iban:
           type: string
         bic:
@@ -598,6 +604,9 @@ components:
       - $ref: '#/components/schemas/Finanzierungsbaustein'
       - type: object
         properties:
+          id:
+            type: string
+            description: Eindeutige interne ID
           kundenreferenzIdsDerVertragspartner:
             type: array
             description: Liste von ReferenzIds der Kunden.
@@ -1137,6 +1146,9 @@ components:
     BausparvertragAlsVermoegen:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         angesparterBetrag:
           type: number
           format: double
@@ -1340,6 +1352,9 @@ components:
     BestehendeImmobilie:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         bezeichnung:
           type: string
         immobilie:
@@ -1403,6 +1418,9 @@ components:
       - '@type'
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         darlehensgeber:
           oneOf:
           - $ref: '#/components/schemas/ProduktanbieterDarlehensgeber'
@@ -1913,6 +1931,9 @@ components:
     Finanzierungsbedarf:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         finanzierungszweck:
           oneOf:
           - $ref: '#/components/schemas/Anschlussfinanzierung'
@@ -2074,6 +2095,9 @@ components:
       - $ref: '#/components/schemas/Finanzierungsbaustein'
       - type: object
         properties:
+          id:
+            type: string
+            description: Eindeutige interne ID
           referenzId:
             type: string
             description: "Eindeutige Referenz-ID für diesen Finanzierungsbaustein.\
@@ -2234,6 +2258,9 @@ components:
     Haushalt:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         kunden:
           maxItems: 2
           minItems: 0
@@ -2347,6 +2374,9 @@ components:
     Immobilie:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         adresse:
           $ref: '#/components/schemas/Anschrift'
         typ:
@@ -2806,6 +2836,9 @@ components:
       - $ref: '#/components/schemas/Finanzierungsbaustein'
       - type: object
         properties:
+          id:
+            type: string
+            description: Eindeutige interne ID
           darlehensbetrag:
             type: number
             format: double
@@ -3175,6 +3208,9 @@ components:
     Kind:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         name:
           type: string
         geburtsdatum:
@@ -3224,6 +3260,9 @@ components:
       - referenzId
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         externeKundenId:
           type: string
           description: Externe ID für diesen Kunden. In anderen APIs auch als externeAntragstellerId
@@ -3289,6 +3328,9 @@ components:
     LebensOderRentenversicherung:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         rueckkaufswert:
           type: number
           format: double
@@ -3789,6 +3831,9 @@ components:
       - $ref: '#/components/schemas/Finanzierungsbaustein'
       - type: object
         properties:
+          id:
+            type: string
+            description: Eindeutige interne ID
           referenzId:
             type: string
             description: "Eindeutige Referenz-ID für diesen Finanzierungsbaustein.\
@@ -5020,6 +5065,9 @@ components:
     Ratenschutz:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         kundenreferenzIdDerVersichertenPerson:
           type: string
           description: ReferenzId eines Kunden.
@@ -5554,6 +5602,9 @@ components:
       - typ
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         typ:
           type: string
           enum:
@@ -5600,6 +5651,9 @@ components:
       - $ref: '#/components/schemas/Finanzierungsbaustein'
       - type: object
         properties:
+          id:
+            type: string
+            description: Eindeutige interne ID
           referenzId:
             type: string
             description: "Eindeutige Referenz-ID für diesen Finanzierungsbaustein.\
@@ -5618,6 +5672,9 @@ components:
     Verbindlichkeit:
       type: object
       properties:
+        id:
+          type: string
+          description: Eindeutige interne ID
         rateMonatlich:
           type: number
           format: double
@@ -6316,6 +6373,9 @@ components:
       - $ref: '#/components/schemas/Finanzierungsbaustein'
       - type: object
         properties:
+          id:
+            type: string
+            description: Eindeutige interne ID
           referenzId:
             type: string
             description: "Eindeutige Referenz-ID für diesen Finanzierungsbaustein.\