swagger.yml

swagger: '2.0'
info:
  version: 3.2.0
  title: KEX Market Engine API
basePath: /v1
schemes:
  - http
  - https
paths:
  /annehmen:
    post:
      operationId: "annehmen"
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Annahme erfolgreich
          schema:
            $ref: '#/definitions/annahmeResponse'
        '500':
          description: Bei der Annahme ist ein technischer Fehler aufgetreten
      parameters:
        - in: 'body'
          name: 'body'
          required: true
          schema:
            $ref: '#/definitions/annahmeRequest'

definitions:

  #####################
  ###    Request    ###
  #####################

  request:
    type: object
    properties:
      traceId:
        description: Zur Nachverfolgung von Anfragen über mehrere Services hinweg - bitte in Ihre Log-Einträge aufnehmen.
        type: string
      vorgangsnummer:
        description: Identifiziert einen Europace-Vorgang.
        type: string
      baufiSmartVorgangsnummer:
        description: Identifikation des assoziierten BaufiSmart-Vorgangs, aus dem heraus der KreditSmart-Vorgang (vorgangsnummer) erstellt wurde.
        type: string
      antragsteller:
        type: array
        items:
          $ref: '#/definitions/antragsteller'
      gemeinsameAntragstellerangaben:
        $ref: '#/definitions/gemeinsameAntragstellerangaben'
      finanzierungswunsch:
        $ref: '#/definitions/finanzierungswunsch'
      konto:
        $ref: '#/definitions/konto'
      kundenbetreuer:
        $ref: '#/definitions/kundenbetreuer'
      vertriebskanal:
        description: Zur Aussteuerung der Dokumentegenerierung. Erlaubte Auspraegungen siehe '#/definitions/vertriebskanal'
        type: string
      featureToggles:
        description: Zur Steuerung von Features abhängig vom Request.
        type: array
        items:
          $ref: '#/definitions/featureToggle'
    required:
      - traceId
      - vorgangsnummer
      - finanzierungswunsch
      - kundenbetreuer

  annahmeRequest:
    allOf:
      - $ref: '#/definitions/request'
      - type: object
        properties:
          antragsnummer:
            description: Identifiziert einen Europace-Antrag.
            type: string
          angebotsvariantentyp:
            description: Token, dass dazu dient das gewünschte Produkt identifizieren zu können. Format ist frei wählbar - der Inhalt wird von Europace nicht semantisch interpretiert. Kann z.B. enthalten - Produktanbieter, Produkt-ID.
            type: string
          bearbeiter:
            $ref: '#/definitions/bearbeiter'
          handelsbeziehung:
            $ref: '#/definitions/handelsbeziehung'
          beratungsart:
            $ref: '#/definitions/beratungsart'
          kontoumsaetze:
            description: Liste mit Kontoumsatzdaten in Base64 und zugehörigen AntragstellerIds
            type: array
            items:
              $ref: "#/definitions/kontoumsaetze"
        required:
          - antragsnummer
          - angebotsvariantentyp
          - handelsbeziehung
          - beratungsart

  vertriebskanal:
    type: string
    enum:
      - B2B
      - B2B2C

  beratungsart:
    type: string
    enum:
      - PRAESENZ_GESCHAEFT
      - FERN_ABSATZ_GESCHAEFT
      - AUSSER_GESCHAEFTSRAUM_VERTRAG

  kontoumsaetze:
    type: object
    properties:
      umsatzdaten:
        type: string
        format: byte
      antragstellerIds:
        type: array
        items:
          $ref: string
    required:
      - umsatzdaten
      - antragstellerIds

  featureToggle:
    type: object
    properties:
      id:
        type: string
      aktiv:
        type: boolean

  ###
  ### Kundenbetreuer, Bearbeiter und Handelsbeziehung
  ###

  kundenbetreuer:
    type: object
    properties:
      partnerId:
        description: Die PartnerId ist 5-stellig und identifiziert eine Plakette aus dem Europace-Partnermanagement.
        type: string
      vertriebsorganisationsId:
        description: Wird im Europace-Partnermanagement gepflegt.
        type: string
      firma:
        type: string
      vorname:
        type: string
      nachname:
        type: string
      anschrift:
        $ref: '#/definitions/adresse'
      telefon:
        type: string
      fax:
        type: string
      email:
        type: string
        format: email
      iban:
        type: string
      anrede:
        $ref: '#/definitions/anrede'
    required:
      - partnerId
      - firma
      - vorname
      - nachname
      - anrede

  anrede:
    type: string
    enum:
      - HERR
      - FRAU
      - DIVERS

  bearbeiter:
    type: object
    properties:
      vorname:
        type: string
      nachname:
        type: string

  handelsbeziehung:
    type: object
    properties:
      produktanbieter:
        description: ID eines Produktanbieters. Wird im Europace-Partnermanagement an der Plakette des Produktanbieters gepflegt.
        type: string
      kreditprovisionswunsch:
        $ref: '#/definitions/prozent'
      vertriebsgruppe:
        description: Wird vom Produktanbieter definiert und im Europace-Partnermanagement an der Handelsbeziehung gepflegt.
        type: string
      produktanbieterParameter:
        description: Zusätzlicher Parameter des Produktanbieters. Wird im Europace-Partnermanagement unter Partnerkennzeichen gepflegt.
        type: array
        items:
          $ref: '#/definitions/produktanbieterParameter'
    required:
      - produktanbieter

  produktanbieterParameter:
    type: object
    additionalProperties:
      type: object

  ###
  ### Antragsteller
  ###

  gemeinsameAntragstellerangaben:
    type: object
    properties:
      bonitaetsangaben:
        $ref: '#/definitions/bonitaetsangaben'
      kinder:
        type: array
        items:
          $ref: '#/definitions/kind'

  antragsteller:
    type: object
    properties:
      id:
        type: string
      haushaltspartnerId:
        description: Antragsteller ID des Haushaltspartners.
        type: string
      persoenlicheAngaben:
        $ref: '#/definitions/persoenlicheAngaben'
      derzeitigeBeschaeftigung:
        $ref: '#/definitions/derzeitigeBeschaeftigung'
      vorherigeBeschaeftigung:
        $ref: '#/definitions/vorherigeBeschaeftigung'
      derzeitigeWohnsituation:
        $ref: '#/definitions/derzeitigeWohnsituation'
      vorherigeWohnsituation:
        $ref: '#/definitions/vorherigeWohnsituation'
      kontakt:
        $ref: '#/definitions/kontakt'
      aufenthaltsstatus:
        $ref: '#/definitions/aufenthaltsstatus'
      kinder:
        type: array
        items:
          $ref: '#/definitions/kind'
      anzahlPkw:
        type: integer
      rentenversicherung:
        $ref: '#/definitions/rentenversicherung'
      legitimation:
        $ref: '#/definitions/legitimation'
      bonitaetsangaben:
        $ref: '#/definitions/bonitaetsangaben'

  kontakt:
    type: object
    properties:
      telefonPrivat:
        type: string
      telefonGeschaeftlich:
        type: string
      email:
        type: string
        format: email

  kind:
    type: object
    properties:
      id:
        type: string
      kindergeldBerechtigt:
        type: boolean

  persoenlicheAngaben:
    type: object
    properties:
      geschlecht:
        $ref: '#/definitions/geschlecht'
      titel:
        $ref: '#/definitions/titel'
      vorname:
        type: string
      nachname:
        type: string
      geburtsdatum:
        type: string
        format: date
      geburtsort:
        type: string
      geburtsland:
        $ref: '#/definitions/land'
      geburtsname:
        type: string
      staatsangehoerigkeit:
        $ref: '#/definitions/land'
      familienstand:
        $ref: '#/definitions/familienstand'
      anzahlPersonenImHaushalt:
        type: integer
      steuerId:
        type: string

  titel:
    type: string
    enum:
      - Dipl.-Ing.
      - Dr.
      - Dr. med.
      - Dr. med. dent.
      - Dr. med. vet.
      - Dr. ing.
      - Dr. jur.
      - Dr. phil.
      - Dr. rer. nat.
      - Dr. rer. pol.
      - Dr. Dr.
      - Dr. h. c.
      - Prof.
      - Prof. Dr.
      - Prof. Dr. med.
      - Prof. Dr. Dr.

  geschlecht:
    type: string
    enum:
      - WEIBLICH
      - MAENNLICH
      - DIVERS

  familienstand:
    type: string
    enum:
      - LEDIG
      - VERHEIRATET
      - GESCHIEDEN
      - VERWITWET
      - GETRENNT_LEBEND
      - EHEAEHNLICHE_GEMEINSCHAFT
      - EINGETRAGENE_LEBENSPARTNERSCHAFT

  derzeitigeBeschaeftigung:
    type: object
    properties:
      beschaeftigungsverhaeltnis:
        $ref: '#/definitions/beschaeftigungsverhaeltnis'
      befristet:
        $ref: '#/definitions/beschaeftigungsbefristung'
      beschaeftigungsbeginn:
        type: string
        format: date
      befristetBis:
        type: string
        format: date
      beruf:
        type: string
      arbeitgeber:
        $ref: '#/definitions/arbeitgeber'
      branche:
        $ref: '#/definitions/branche'

  arbeitgeber:
    type: object
    properties:
      name:
        type: string
      anschrift:
        $ref: '#/definitions/adresse'

  beschaeftigungsverhaeltnis:
    type: string
    enum:
      - ANGESTELLT
      - ARBEITER
      - BEAMTER
      - GF_GESELLSCHAFTER
      - SELBSTAENDIG
      - FREIBERUFLER
      - RENTNER
      - HAUSFRAU
      - ARBEITSLOS

  branche:
    type: string
    enum:
      - BAUGEWERBE
      - DIENSTLEISTUNGEN
      - ENERGIE_WASSERVERSORGUNG_BERGBAU
      - ERZIEHUNG_UNTERRICHT
      - GEBIETSKOERPERSCHAFTEN
      - GEMEINNUETZIGE_ORGANISATION
      - GESUNDHEIT_SOZIALWESEN
      - HANDEL
      - HOTEL_GASTRONOMIE
      - INFORMATION_KOMMUNIKATION
      - KREDITINSTITUTE_VERSICHERUNGEN
      - KULTUR_SPORT_UNTERHALTUNG
      - LANDWIRTSCHAFT_FORSTWIRTSCHAFT_FISCHEREI
      - OEFFENTLICHER_DIENST
      - PRIVATE_HAUSHALTE
      - VERARBEITENDES_GEWERBE
      - VERKEHR_LOGISTIK

  beschaeftigungsbefristung:
    type: string
    enum:
      - UNBEFRISTET
      - BEFRISTET
      - PROBEZEIT

  vorherigeBeschaeftigung:
    properties:
      beschaeftigungsbeginn:
        type: string
        format: date
      beschaeftigungsende:
        type: string
        format: date
      arbeitgeber:
        $ref: '#/definitions/arbeitgeber'

  derzeitigeWohnsituation:
    type: object
    properties:
      wohnart:
        $ref: '#/definitions/wohnart'
      wohnhaftSeit:
        type: string
        format: date
      anschrift:
        $ref: '#/definitions/adresse'

  wohnart:
    type: string
    enum:
      - ZUR_MIETE
      - ZUR_UNTERMIETE
      - IM_EIGENEN_HAUS
      - BEI_DEN_ELTERN

  vorherigeWohnsituation:
    type: object
    properties:
      wohnhaftSeit:
        type: string
        format: date
      anschrift:
        $ref: '#/definitions/adresse'

  aufenthaltsstatus:
    type: object
    properties:
      aufenthaltstitel:
        $ref: '#/definitions/aufenthaltstitel'
      arbeitserlaubnisBefristetBis:
        type: string
        format: date

  aufenthaltstitel:
    type: object
    properties:
      inDeutschlandSeit:
        type: string
        format: date
      art:
        $ref: '#/definitions/aufenthaltsart'
      befristetBis:
        type: string
        format: date

  aufenthaltsart:
    type: string
    enum:
      - AUFENTHALTSERLAUBNIS_UNBEFRISTET
      - AUFENTHALTSERLAUBNIS_BEFRISTET
      - VISUM

  rentenversicherung:
    type: object
    properties:
      name:
        type: string
      anschrift:
        $ref: '#/definitions/adresse'
      renteneintritt:
        type: string
        format: date

  legitimation:
    type: object
    properties:
      ausweisart:
        $ref: '#/definitions/ausweisart'
      ausweisnummer:
        type: string
      ausstellendeBehoerde:
        type: string
      ausstellungsdatum:
        type: string
        format: date
      ausstellungsort:
        type: string

  ausweisart:
    type: string
    enum:
      - PERSONALAUSWEIS
      - REISEPASS
      - ANDERER_AUSWEIS

  fahrzeug:
    type: object
    properties:
      erstzulassungsdatum:
        type: string
        format: date
      kaufpreis:
        $ref: '#/definitions/euro'
      beglicheneKosten:
        $ref: '#/definitions/euro'
      fahrzeugleistung:
        $ref: '#/definitions/fahrzeugleistung'
      laufleistung:
        type: integer
      marke:
        type: string
      modell:
        type: string
      verkaeuferart:
        $ref: '#/definitions/fahrzeugverkaeuferart'

  fahrzeugleistung:
    type: object
    properties:
      nennleistung:
        type: number
      einheit:
        $ref: '#/definitions/leistungseinheit'

  leistungseinheit:
    type: string
    enum:
      - PS
      - KW

  fahrzeugverkaeuferart:
    type: string
    enum:
      - PRIVAT
      - HAENDLER

  modernisierung:
    type: object
    properties:
      modernisierungsbetrag:
        $ref: '#/definitions/euro'

  bonitaetsangaben:
    type: object
    properties:
      einnahmen:
        $ref: '#/definitions/einnahmen'
      monatlicheAusgaben:
        $ref: '#/definitions/ausgaben'
      vermoegen:
        $ref: '#/definitions/vermoegen'
      verbindlichkeiten:
        $ref: '#/definitions/verbindlichkeiten'

  einnahmen:
    type: object
    properties:
      monatlicheEinnahmen:
        $ref: '#/definitions/monatlicheEinnahmen'
      jaehrlicheEinnahmen:
        $ref: '#/definitions/jaehrlicheEinnahmen'

  monatlicheEinnahmen:
    type: object
    properties:
      regelmaessigesUnselbstaendigesEinkommen:
        $ref: '#/definitions/euro'
      rente:
        $ref: '#/definitions/euro'
      kindesunterhalt:
        $ref: '#/definitions/euro'
      ehegattenunterhalt:
        $ref: '#/definitions/euro'
      kindergeld:
        $ref: '#/definitions/euro'
      nebentaetigkeiten:
        type: array
        items:
          $ref: '#/definitions/nebentaetigkeit'
      mietUndPachteinnahmen:
        $ref: '#/definitions/mietUndPachteinnahmen'
      sonstigeEinnahmen:
        $ref: '#/definitions/euro'

  nebentaetigkeit:
    type: object
    properties:
      betrag:
        $ref: '#/definitions/euro'
      beginn:
        type: string
        format: date

  mietUndPachteinnahmen:
    type: object
    properties:
      warm:
        $ref: '#/definitions/euro'
      kalt:
        $ref: '#/definitions/euro'

  jaehrlicheEinnahmen:
    type: object
    properties:
      einkommenAusSelbstaendigkeit:
        $ref: '#/definitions/einkommenAusSelbstaendigkeit'

  einkommenAusSelbstaendigkeit:
    type: object
    properties:
      nettoeinkommen:
        $ref: '#/definitions/euro'
      zuVersteuerndesEinkommen:
        $ref: '#/definitions/jaehrlicheAngaben'
      einkommenssteuer:
        $ref: '#/definitions/jaehrlicheAngaben'
      abschreibungen:
        $ref: '#/definitions/jaehrlicheAngaben'
      bruttoEinkommenErwartet:
        $ref: '#/definitions/euro'
      bilanzierend:
        type: boolean

  jaehrlicheAngaben:
    type: object
    properties:
      laufendesJahr:
        $ref: '#/definitions/euro'
      vorEinemJahr:
        $ref: '#/definitions/euro'
      vorZweiJahren:
        $ref: '#/definitions/euro'
      vorDreiJahren:
        $ref: '#/definitions/euro'

  ausgaben:
    type: object
    properties:
      krankenversicherungsbeitraege:
        $ref: '#/definitions/euro'
      eigenmieteInklusiveNebenkosten:
        $ref: '#/definitions/euro'
      unterhalt:
        $ref: '#/definitions/euro'
      lebensversicherungsbeitraege:
        $ref: '#/definitions/euro'
      bauspardarlehensrate:
        $ref: '#/definitions/euro'
      sonstigeAusgaben:
        $ref: '#/definitions/euro'

  vermoegen:
    type: object
    properties:
      immobilien:
        type: array
        items:
          $ref: '#/definitions/immobilie'

  immobilie:
    type: object
    properties:
      id:
        type: string
      art:
        $ref: '#/definitions/immobilienart'
      verkehrswert:
        $ref: '#/definitions/euro'
      wohnflaeche:
        type: integer
      vermieteteWohnflaeche:
        type: integer
      nutzungsart:
        $ref: '#/definitions/immobiliennutzungsart'
      nebenkosten:
        $ref: '#/definitions/euro'

  immobilienart:
    type: string
    enum:
      - EIGENTUMSWOHNUNG
      - EINFAMILIENHAUS
      - MEHRFAMILIENHAUS
      - BUERO_GESCHAEFTSGEBAEUDE

  immobiliennutzungsart:
    type: string
    enum:
      - VERMIETET
      - EIGENGENUTZT
      - EIGENGENUTZT_UND_VERMIETET

  verbindlichkeiten:
    type: object
    properties:
      ratenkredite:
        type: array
        items:
          $ref: '#/definitions/ratenkredit'
      sonstigeVerbindlichkeiten:
        type: array
        items:
          $ref: '#/definitions/sonstigeVerbindlichkeit'
      leasings:
        type: array
        items:
          $ref: '#/definitions/leasing'
      kreditkarten:
        type: array
        items:
          $ref: '#/definitions/kreditkarte'
      dispositionskredite:
        type: array
        items:
          $ref: '#/definitions/dispositionskredit'
      immobiliendarlehen:
        type: array
        items:
          $ref: '#/definitions/immobiliendarlehen'

  ratenkredit:
    type: object
    properties:
      id:
        type: string
      monatlicheRate:
        $ref: '#/definitions/euro'
      letzteRate:
        $ref: '#/definitions/euro'
      datumLetzteRate:
        type: string
        format: date
      restschuld:
        $ref: '#/definitions/euro'
      glaeubiger:
        type: string

  sonstigeVerbindlichkeit:
    type: object
    properties:
      id:
        type: string
      monatlicheRate:
        $ref: '#/definitions/euro'
      letzteRate:
        $ref: '#/definitions/euro'
      datumLetzteRate:
        type: string
        format: date
      restschuld:
        $ref: '#/definitions/euro'
      glaeubiger:
        type: string

  leasing:
    type: object
    properties:
      id:
        type: string
      monatlicheRate:
        $ref: '#/definitions/euro'
      letzteRate:
        $ref: '#/definitions/euro'
      datumLetzteRate:
        type: string
        format: date
      glaeubiger:
        type: string

  kreditkarte:
    type: object
    properties:
      id:
        type: string
      verfuegungsrahmen:
        $ref: '#/definitions/euro'
      monatlicheRate:
        $ref: '#/definitions/euro'
      beanspruchterBetrag:
        $ref: '#/definitions/euro'
      zinssatz:
        $ref: '#/definitions/prozent'
      glaeubiger:
        type: string

  dispositionskredit:
    type: object
    properties:
      id:
        type: string
      verfuegungsrahmen:
        $ref: '#/definitions/euro'
      beanspruchterBetrag:
        $ref: '#/definitions/euro'
      zinssatz:
        $ref: '#/definitions/prozent'
      glaeubiger:
        type: string

  immobiliendarlehen:
    type: object
    properties:
      immobilieId:
        type: string
      monatlicheRate:
        $ref: '#/definitions/euro'
      restschuld:
        $ref: '#/definitions/euro'

  ###
  ### Finanzierungswunsch
  ###

  finanzierungswunsch:
    type: object
    properties:
      kreditwunsch:
        $ref: '#/definitions/kreditwunsch'
      versicherungswunsch:
        type: array
        items:
          $ref: '#/definitions/versicherungsrisiken'
      abzuloesendeVerbindlichkeiten:
        $ref: '#/definitions/abzuloesendeVerbindlichkeiten'
      fahrzeug:
        $ref: '#/definitions/fahrzeug'
      modernisierung:
        $ref: '#/definitions/modernisierung'

    required:
      - kreditwunsch

  kreditwunsch:
    type: object
    properties:
      finanzierungszweck:
        $ref: '#/definitions/finanzierungszweck'
      verwendung:
        type: string
      auszahlungsbetrag:
        $ref: '#/definitions/euro'
      ratenzahlungstermin:
        $ref: '#/definitions/ratenzahlungstermin'
      laufzeitInMonaten:
        description: laufzeitInMonaten oder rateProMonat wird übermittelt.
        type: integer
      rateProMonat:
        description: laufzeitInMonaten oder rateProMonat wird übermittelt.
        $ref: '#/definitions/euro'
    required:
      - auszahlungsbetrag

  abzuloesendeVerbindlichkeiten:
    type: object
    properties:
      ratenkredite:
        type: array
        items:
          $ref: '#/definitions/abzuloesenderRatenkredit'
      sonstigeVerbindlichkeiten:
        type: array
        items:
          $ref: '#/definitions/abzuloesendeSonstigeVerbindlichkeit'
      kreditkarten:
        type: array
        items:
          $ref: '#/definitions/abzuloesendeKreditkarte'
      dispositionskredite:
        type: array
        items:
          $ref: '#/definitions/abzuloesenderDispositionskredit'

  finanzierungszweck:
    description: Verwendungszweck
    type: string
    enum:
      - UMSCHULDUNG
      - SONSTIGES
      - NEUWAGENKAUF
      - MODERNISIERUNG_UND_WOHNEN

  ratenzahlungstermin:
    type: string
    enum:
      - MONATSANFANG
      - MONATSMITTE
      - MONATSENDE

  abzuloesenderRatenkredit:
    type: object
    properties:
      id:
        type: string
      datumErsteRate:
        type: string
        format: date
      urspruenglicherBetrag:
        $ref: '#/definitions/euro'
      abloeseBetrag:
        $ref: '#/definitions/euro'
      konto:
        $ref: '#/definitions/konto'

  abzuloesendeSonstigeVerbindlichkeit:
    type: object
    properties:
      id:
        type: string
      datumErsteRate:
        type: string
        format: date
      urspruenglicherBetrag:
        $ref: '#/definitions/euro'
      abloeseBetrag:
        $ref: '#/definitions/euro'
      konto:
        $ref: '#/definitions/konto'

  abzuloesendeKreditkarte:
    type: object
    properties:
      id:
        type: string
      abloeseBetrag:
        $ref: '#/definitions/euro'
      konto:
        $ref: '#/definitions/konto'

  abzuloesenderDispositionskredit:
    type: object
    properties:
      id:
        type: string
      abloeseBetrag:
        $ref: '#/definitions/euro'
      konto:
        $ref: '#/definitions/konto'

  konto:
    type: object
    properties:
      kreditinstitut:
        type: string
      kontoinhaberIds:
        type: array
        items:
          type: string
      iban:
        type: string
      bic:
        type: string

  ###
  ### Globale Typen innerhalb Request
  ###

  adresse:
    type: object
    properties:
      strasse:
        type: string
      hausnummer:
        type: string
      postleitzahl:
        type: string
      ort:
        type: string
      land:
        $ref: '#/definitions/land'

  #####################
  ###    Response   ###
  #####################

  annahmeResponse:
    type: object
    properties:
      angebot:
        $ref: '#/definitions/angebot'
      supportMeldung:
        type: string
        description: Hinweis für den Support, um zu verstehen, was im Backend los ist. (StackTrace oder sonstiger Hinweis auf das Problem)
      dokumente:
        type: array
        items:
          $ref: '#/definitions/dokument'
      identifikation:
        type: array
        items:
          $ref: '#/definitions/identifikation'

  angebot:
    type: object
    properties:
      produktanbieter:
        description: ID eines Produktanbieters, wie in der Anfrage unter handelsbeziehung.produktanbieter angegeben. Ordnet das Angebot dem angefragtem Produktanbieter zu.
        type: string
      referenznummerProduktanbieter:
        description: Vertrags- oder Antragsnummer des Produktanbieters. Dient auch der späteren Identifizierung des Antrags bei Statusupdates.
        type: string
      referenznummerDienstleister:
        description: Erfolgt die Antragserzeugung mithilfe eines Dienstleisters, wird hier die Antrags-ID des durchleitenden Dienstleisters erwartet.
        type: string
      produktbezeichnung:
        type: string
      produktart:
        $ref: '#/definitions/produktart'
      angebotsvariantentyp:
        description: Token, dass dazu dient die bei der Ermittlung berechnete AngebotsVariante bei der Annahme identifizieren zu können.
        type: string
      kredit:
        description: Angaben zu den Kredit-Konditionen. Wenn diese fehlen (null) wird das Angebot als NICHT-MACHBAR interpretiert.
        $ref: '#/definitions/kredit'
      status:
        $ref: '#/definitions/angebotsstatus'
      meldungen:
        description: Meldungen werden dem Vermittler angezeigt, um ihn im Beratungsprozess zu unterstützen.
        type: array
        items:
          $ref: '#/definitions/meldung'
      unterlagen:
        description: Liste der einzureichenden Dokumente.
        type: array
        items:
          $ref: '#/definitions/unterlage'
      bonitaetscheck:
        $ref: '#/definitions/bonitaetscheck'
      tilgungsplan:
        $ref: '#/definitions/tilgungsplan'
      maximalerAuszahlungsbetrag:
        $ref: '#/definitions/euro'
    required:
      - produktanbieter
      - produktbezeichnung
      - produktart
      - angebotsvariantentyp
      - status

  produktart:
    type: string
    enum:
      - RATENKREDIT
      - AUTOKREDIT
      - MODERNISIERUNGSKREDIT
      - BUSINESSKREDIT

  unterlage:
    type: object
    properties:
      code:
        type: string
      text:
        type: string
      referenz:
        $ref: '#/definitions/unterlageReferenz'
    required:
      - text

  unterlageReferenz:
    type: object
    properties:
      id:
        type: string
      art:
        $ref: '#/definitions/unterlageReferenzArt'
    required:
      - id
      - art

  unterlageReferenzArt:
    type: string
    enum:
      - ANTRAGSTELLER

  angebotsstatus:
    type: object
    properties:
      machbarkeitsstatus:
        $ref: '#/definitions/machbarkeitsstatus'
      angepasst:
        description: true wenn der Kredit- oder Versicherungswunsch des Antragstellers angepasst wurde. In diesem Falle sollte es entsprechende Anpassungsmeldungen (Kategorie ANPASSUNG) geben.
        type: boolean
    required:
      - machbarkeitsstatus
      - angepasst

  machbarkeitsstatus:
    type: string
    enum:
      - MACHBAR
      - MACHBAR_UNTER_VORBEHALT_PRODUKTANBIETER
      - NICHT_MACHBAR

  kredit:
    type: object
    properties:
      vertragsbeginn:
        type: string
        format: date
      effektivzinssatz:
        $ref: '#/definitions/prozent'
      sollzinssatz:
        $ref: '#/definitions/prozent'
      gesamtbetrag:
        description: Auszahlungsbetrag + Versicherungsprämie + Kreditzinsen
        $ref: '#/definitions/euro'
      nettokreditbetrag:
        description: Auszahlungsbetrag + Versicherungsprämie
        $ref: '#/definitions/euro'
      auszahlungsbetrag:
        description: Kreditbetrag
        $ref: '#/definitions/euro'
      laufzeitInMonaten:
        type: integer
      rateProMonat:
        $ref: '#/definitions/euro'
      letzteRate:
        $ref: '#/definitions/euro'
      provisionsbetrag:
        $ref: '#/definitions/euro'
      basisbetragFuerDieProvisionsermittlung:
        $ref: '#/definitions/euro'
      vorlaufzinsenProTag:
        $ref: '#/definitions/euro'
      versicherung:
        description: Darf nur geliefert werden, wenn mindestens ein Risiko versichert ist.
        $ref: '#/definitions/versicherung'
    required:
      - effektivzinssatz
      - sollzinssatz
      - gesamtbetrag
      - nettokreditbetrag
      - auszahlungsbetrag
      - laufzeitInMonaten
      - rateProMonat
      - letzteRate
      - provisionsbetrag
      - basisbetragFuerDieProvisionsermittlung
      - vorlaufzinsenProTag

  versicherung:
    type: object
    properties:
      basisFuerDieProvisionsermittlung:
        $ref: '#/definitions/basisFuerDieVersicherungsprovisionsermittlung'
      provisionsbetrag:
        $ref: '#/definitions/euro'
      praemieBrutto:
        description: Versicherungsprämie inklusive Steuer für Arbeitslosigkeitsversicherung
        $ref: '#/definitions/euro'
      praemieNetto:
        description: Versicherungsprämie exklusive Steuer für Arbeitslosigkeitsversicherung
        $ref: '#/definitions/euro'
      risiken:
        type: array
        items:
          $ref: '#/definitions/versicherungsrisiken'
      versichererIds:
        description: IDs der Versicherer. Gültige Ausprägungen erhalten Sie von ihrem Ansprechpartner bei Europace.
        type: array
        items:
          type: string
        minItems: 1
        uniqueItems: true
    required:
      - basisFuerDieProvisionsermittlung
      - provisionsbetrag
      - praemieBrutto
      - praemieNetto
      - risiken
      - versichererIds

  basisFuerDieVersicherungsprovisionsermittlung:
    type: string
    enum:
      - VERSICHERUNGS_PRAEMIE_NETTO
      - VERSICHERUNGS_PRAEMIE_BRUTTO

  meldung:
    type: object
    properties:
      kategorie:
        $ref: '#/definitions/meldungskategorie'
      text:
        type: string
      code:
        type: string
        description: Identifiziert eine Meldung anhand ihrer fachlichen Bedeutung. Dient der Analyse in Logs.
        example: bank.anpassung.laufzeit
    required:
      - kategorie
      - text

  meldungskategorie:
    type: string
    enum:
      - MACHBARKEIT
      - VOLLSTAENDIGKEIT
      - HINWEIS
      - ANPASSUNG

  dokument:
    type: object
    properties:
      dateiname:
        type: string
      base64pdf:
        type: string
        format: byte
      sichtbarkeit:
        $ref: '#/definitions/dokumentsichtbarkeit'
    required:
      - dateiname
      - base64pdf
      - sichtbarkeit

  dokumentsichtbarkeit:
    type: object
    properties:
      sichtbarFuerVertrieb:
        type: boolean
      sichtbarFuerProduktanbieter:
        description: Zum Beispiel zum Ausschluss von Dokumenten vom Dokumente-Upload.
        type: boolean

  identifikation:
    type: object
    properties:
      antragstellerId:
        type: string
      videolegitimationUrl:
        type: string
      qesUrl:
        type: string
    required:
      - antragstellerId

  tilgungsplan:
    type: object
    properties:
      eintraege:
        description: In der Regel werden die Zahlungsperioden nur während des ersten Kalenderjahres monatlich ausgewiesen. Die folgenden Perioden werden auf Jahresebene aggregiert, um den Tilgungsplan kurz zu halten.
        type: array
        items:
          $ref: '#/definitions/tilgungsplanEintrag'
      schlusswerte:
        description: Enthält den Restsaldo sowie für Zahlung, Zinsen und Tilgung die Summen über den gesamten Tilgungsplan. Monat und Jahr werden nicht erwartet.
        $ref: '#/definitions/tilgungsplanEintrag'
    required:
      - eintraege
      - schlusswerte

  tilgungsplanEintrag:
    type: object
    properties:
      jahr:
        type: integer
        minimum: 2000
        maximum: 2100
      monat:
        type: integer
        minimum: 1
        maximum: 12
      tag:
        type: integer
        minimum: 1
        maximum: 31
      zahlung:
        $ref: '#/definitions/euro'
      zinsen:
        $ref: '#/definitions/euro'
      tilgung:
        $ref: '#/definitions/euro'
      saldo:
        $ref: '#/definitions/euro'

  bonitaetscheck:
    type: object
    properties:
      ueberschrift:
        type: string
      ueberschuss:
        $ref: '#/definitions/euro'
      bloecke:
        type: array
        items:
          $ref: '#/definitions/titelBlock'

  block:
    type: object
    properties:
      zeilen:
        type: array
        items:
          $ref: '#/definitions/zeile'

  titelBlock:
    allOf:
      - $ref: '#/definitions/block'
      - type: object
        properties:
          titel:
            type: string
          innerBlock:
            $ref: '#/definitions/innerBlock'

  innerBlock:
    allOf:
      - $ref: '#/definitions/block'
      - type: object
        properties:
          hervorgehoben:
            type: boolean

  zeile:
    type: object
    description: Wert sollte ungleich 0 sein. Der Übersichtlichkeit halber sind Ein- und Ausgabepositionen mit 0 Euro nicht zu mappen.
    properties:
      hervorgehoben:
        type: boolean
      label:
        type: string
        description: Wird in der Haushaltsrechnung in KreditSmart angezeigt. Der Einheitlichkeit halber bitte mit Europace abstimmen.
        ###########################################
        ###  Beispiele für Einnahmenpositionen  ###
        ###########################################
        ###  Unselbstständiges Nettoeinkommen   ###
        ###  Selbstständiges Nettoeinkommen     ###
        ###  Einkünfte aus Nebentätigkeit       ###
        ###  Rente                              ###
        ###  Kindesunterhalt                    ###
        ###  Ehegattenunterhalt                 ###
        ###  Kindergeld                         ###
        ###  Mieteinnahmen                      ###
        ###  Einkünfte aus Kapitalvermögen      ###
        ###  Einnahmen aus sonstigem Einkommen  ###
        ###########################################

        ##########################################
        ###  Beispiele für Ausgabenpositionen  ###
        ##########################################
        ###  Lebenshaltungskosten              ###
        ###  Mietausgaben                      ###
        ###  Nebenkosten Wohneigentum          ###
        ###  Bewirtschaftungskosten            ###
        ###  Unterhaltszahlungen               ###
        ###  Bauspar-Beiträge                  ###
        ###  Raten weiterer Immobiliendarlehen ###
        ###  Kreditraten                       ###
        ###  Private Leasingraten              ###
        ###  Sonstige Verbindlichkeitsraten    ###
        ###  Krankenversicherungsbeiträge      ###
        ###  Lebensversicherungsbeiträge       ###
        ###  Mobilitätskosten                  ###
        ###  Sonstige Ausgaben                 ###
        ###  Rate der aktuellen Finanzierung   ###
        ##########################################
      wert:
        $ref: '#/definitions/euro'
    required:
      - label
      - wert

  ###########################################
  ### Globale Typen fuer Request+Response ###
  ###########################################


  versicherungsrisiken:
    type: object
    properties:
      antragstellerId:
        type: string
      tod:
        type: boolean
      arbeitsunfaehigkeit:
        type: boolean
      arbeitslosigkeit:
        type: boolean
    required:
      - antragstellerId
      - tod
      - arbeitsunfaehigkeit
      - arbeitslosigkeit

  euro:
    type: number
    description: Euro-Betrag mit bis zu 2 Nachkommastellen
    format: 'xxx.xx'
    example: 10000.00

  prozent:
    type: number
    description: 1 basierter Prozentwert mit bis zu 4 Nachkommastellen
    format: 'x.xxxx'
    example: 0.0257

  land:
    type: string
    description: Land als ISO 3166-1 alpha-2 Code (nur Grossbuchstaben)
    pattern: '^[A-Z]{2}$'
    example: DE