openapi: 3.0.2
info:
  title: Interhyp Submission commands submissions API
  version: 2.0.0
  contact:
    name: Interhyp AG (Team Provider Excellence)
    email: support_submission_api@interhyp.de
  license:
    name: Interhyp AG
  description: '### This document describes the RESTful API and resources provided by Interhyp AG.<p> The RESTful API provides access to resources associated to submission process via *URI* paths, a client application will make an HTTP request using standard HTTP methods like *GET, PUT, POST and DELETE* and parse the response in *JSON* format.<p>

    ### API Audience<p> The API is intended to be consumed by clients who want to integrate Interhyp submission process in their own workflow.

    + **Bank Partners**

    ### API design Principles <p> During API design a set of principles were taken into consideration.

    + **API First**

    + **Mobile First**

    ### API client <p> As an API client you should adhere to the following robustness principle

    + **Tolerant Reader** Be tolerant with unknown fields in the payload. This is required to avoid new API versions if new fields were added, i.e. ignore new fields but do not eliminate them from payload if needed for subsequent *PUT* requests

    + Be prepared to handle HTTP status codes not explicitly specified in endpoint definitions.'
servers:
- url: https://api-test.interhyp.de/submission
  description: Test-Staging
- url: https://api.interhyp.de/submission
  description: Production
security:
- BearerAuth: []
tags:
- name: submissions
  description: provides endpoints for submission resources associated with a specific financing partner
paths:
  /submissions:
    get:
      summary: Delivers all active submissions for a specific financing partner.
      description: 'This endpoint gives a possibility to retrieve information about active submissions that belong to a specific financing partner

        filtered by submission date using `since` query parameter.


        **Tip:** A submission is considered to be active, when it has not been revoked.


        *By Default*, we will return the first *20* matching records. However, this is not a hard limitation! `limit` parameter can be used

        to tell the API how many records you want to receive at once *(max 50)*.</br>


        To get further matching records, `after` or `before` parameters can be used to tell the API the start of each page using specified

        cursor.</br>


        To navigate through the query result, a reference to the following navigations are included in the response *(next, previous)*.

        '
      operationId: getSubmissions
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/since'
      - $ref: '#/components/parameters/until'
      - $ref: '#/components/parameters/sbms-limit'
      - $ref: '#/components/parameters/cursor-after'
      - $ref: '#/components/parameters/cursor-before'
      - $ref: '#/components/parameters/sbms-sort'
      responses:
        '200':
          description: A paged array of submissions matching the provided criteria.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Submissions'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}:
    get:
      summary: Get a specific submission
      description: "This endpoint gives a possibility to retrieve information about a specific submission using it's id.\nA submission (Kreditantrag) holds all the information in order to help the financing partners during credit decision phase.\n\nThis endpoint utilizes *Expansion* feature, where *by default* only basic information shall be returned. In order to access more full details, two options are available\n\n  - follow provided links in order to navigate to submission sub-resources (i.e /v2/submissions/{submissionId}/overview)\n\n  - initiate the call with request parameter `embed` set to *TRUE* (i.e /v2/submissions/{submissionId}?embed=true)\n\nPlease refer to *Expansion* section for more details."
      operationId: getSubmissionById
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      - $ref: '#/components/parameters/embed'
      responses:
        '200':
          description: Requested submission is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Submission'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}/calculations/{calculationType}:
    get:
      summary: Get calculation data
      description: "Delivers calculation basics for specified calculation type.\nCalculation type options:\n  - CONDITION (Konditionskalkulation)\n\n  - HOUSEHOLD (HH-Rechnung)\n\n  - LENDING_VALUE (Beleihungswert)"
      operationId: getSubmissionCalculationByType
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      - $ref: '#/components/parameters/calculation-type'
      responses:
        '200':
          description: Requested calculation data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Calculations'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}/commands:
    post:
      summary: Modify an existing submission.
      description: 'This endpoint gives a possibility to modify an existing submission asynchronously by creating a command to perform this operation, as a result a *command id* shall be returned.


        In order to follow up the command execution result, a call to `/v2/commands` endpoint could be made providing the *command id*

        '
      operationId: modifySubmission
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifySubmissionCommand'
      responses:
        '201':
          description: Reference to the created resource.
          headers:
            Location:
              schema:
                type: string
                description: 'DE: Link zu einer spezifischen Ressource <br/> EN: Link to retrieve a specific resource

                  '
                example: http://some-domain/some/link/to/somewhere
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandId'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}/credit-loans/{creditLoanId}:
    get:
      summary: Get a specific credit loan
      description: 'Delivers detailed information about a specific credit loan associated with this submission.


        A Credit Loan represents specific financing structure component.'
      operationId: getSubmissionCreditLoanById
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      - $ref: '#/components/parameters/credit-loan-id'
      responses:
        '200':
          description: Requested Credit Loan Details are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditLoan'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}/financing-application:
    get:
      summary: Get a submitted financing application
      description: "Delivers information about existing financing application associated with a specific submission.\n\nA Financing Application holds all the information which have been collected from the Applicants during the consultation phase. Holds information regarding\n  - Applicants Personal details\n\n  - Applicants Credit Worthiness\n\n  - Estates involved in the financing process\n\n  - Venture\n\n  - Consultation Unit\n\n  - Offer\n\n\nThis endpoint utilizes *Expansion* feature, where *by default* only basic information shall be returned. In order to access more full details, two options are available\n\n  - follow provided links in order to navigate to financing-application sub-resources (i.e /v2/financing-applications/{applicationId}/estates)\n\n  - initiate the call with request parameter `embed` set to *TRUE* (i.e /v2/submissions/{submissionId}/financing-application?embed=true)\n\nPlease refer to *Expansion* section for more details.\n"
      operationId: getSubmissionFinancingApplication
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      - $ref: '#/components/parameters/embed'
      responses:
        '200':
          description: Financing application is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancingApplication'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested financing application resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}/handover-documents:
    get:
      summary: Get handover documents
      description: "Delivers metadata regarding the system generated reports for a specific submission.\nHandover reports including but not limited to\n  - Übergabeprotokoll (Handover protocol)\n\n  - Provideranschreiben (Provider cover letter)\n\n  - Überarbeiteter Antrag (Revised application)\n\n  - Kalkulation (Condition calculation)\n\n  - HH-Rechnung (Household calculation)"
      operationId: getHandoverDocuments
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      responses:
        '200':
          description: Requested meta data are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditDecisionDocumentMetaData'
              example: '{ "documents": [ { "submissionId": "de-20230227-en9lndd-ev3y1", "documentId": "63a86906-ad38-45bc-a10e-c1d0b8978af5", "documentType": "CONDITION_CALCULATION", "documentName": "condition calculation", "createdAt": "2019-12-29T10:22:50Z", "href": { "href": "https://api.interhyp.de/submission/v2/submissions/de-20230424-krczwx6-5sves/handover/reports/NDMzOTk4Mi1QUk9WSURFUl9DT1ZFUl9MRVRURVItUHJvdmlkZXJhbnNjaHJlaWJlbg==" } } ] }'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
              example: '{ "timestamp": "2023-03-07T17:49:39.995Z", "title": "Bad Request", "status": 400, "traceId": "64077933c36912de13fb3cd7ae0c00c8", "instance": "/v2/submissions/de-20230314-0rztcss-55vcy/status" }'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
              example: '{ "error": "invalid token", "error_description": "Access token expired", }'
        '403':
          description: Error indicates insufficient privileges to create/access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
              example: '{ "timestamp": "2023-03-14T10:00:00.995Z", "title": "Forbidden", "status": 403, "traceId": "64077933c36912de13fb3cd7ae0c00c8", "instance": "/v2/submissions/de-20230314-0rztcss-55vcy/status" }'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
              example: '{ "timestamp": "2023-03-14T10:00:00.995Z", "title": "Internal Server Error", "status": 500, "traceId": "64077933c36912de13fb3cd7ae0c00c8", "instance": "/v2/submissions/de-20230314-0rztcss-55vcy/status" }'
  /submissions/{submissionId}/handover/reports:
    get:
      summary: Get handover reports
      deprecated: true
      description: "@deprecated: Please use instead endpoint: '/v2/submissions/{submissionId}/handover-documents:'\nDelivers metadata regarding the system generated reports for a specific submission.\nHandover reports including but not limited to\n  - Übergabeprotokoll\n\n  - Provideranschreiben\n\n  - Überarbeiteter Antrag\n\n  - Kalkulation\n\n  - HH-Rechnung\n\nHandover reports are associated with a specific financing structure context (i.e `Main` or `Nachrang` component)."
      operationId: getSubmissionHandoverReports
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      responses:
        '200':
          description: Requested handover reports are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverReports'
        '202':
          description: Payload is being prepared, try again later
          headers:
            Retry-After:
              schema:
                type: integer
              description: payload is expected to be ready after the specified amout of seconds
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}/handover/reports/{name}:
    get:
      summary: Get a specific handover report as `PDF`
      description: Delivers detailed information about a specific handover report as `PDF` document.
      operationId: getSubmissionHandoverReportByName
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      - $ref: '#/components/parameters/handover-report-name'
      responses:
        '200':
          description: Requested handover report is returned
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/HandoverReportBinary'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}/overview:
    get:
      summary: Get the overview for a submission
      description: Delivers an overview for the requested submission.
      operationId: getSubmissionOverview
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      responses:
        '200':
          description: Requested overview of the submission is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionOverview'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
  /submissions/{submissionId}/status:
    get:
      summary: Get current status of specified submission
      description: Delivers information about current status of a specific submission
      operationId: getSubmissionStatusById
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      responses:
        '200':
          description: Current status of the requested submission is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionStatus'
              example: '{ "type": "SUBMITTED", "remark": "Submission was submitted", "changedOn": "2023-03-14T10:22:50Z" }'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
              example: '{ "timestamp": "2023-03-07T17:49:39.995Z", "title": "Bad Request", "status": 400, "traceId": "64077933c36912de13fb3cd7ae0c00c8", "instance": "/v2/submissions/de-20230314-0rztcss-55vcy/status" }'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
              example: '{ "error": "invalid token", "error_description": "Access token expired", }'
        '403':
          description: Error indicates insufficient privileges to create/access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
              example: '{ "timestamp": "2023-03-14T10:00:00.995Z", "title": "Forbidden", "status": 403, "traceId": "64077933c36912de13fb3cd7ae0c00c8", "instance": "/v2/submissions/de-20230314-0rztcss-55vcy/status" }'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
              example: '{ "timestamp": "2023-03-14T10:00:00.995Z", "title": "Internal Server Error", "status": 500, "traceId": "64077933c36912de13fb3cd7ae0c00c8", "instance": "/v2/submissions/de-20230314-0rztcss-55vcy/status" }'
  /submissions/{submissionId}/uploaded-documents/{documentId}/content:
    get:
      summary: Get a specific submission document as `PDF`
      description: Delivers detailed information about a specific submission document as `PDF` document.
      operationId: getSubmissionDocumentById
      tags:
      - submissions
      parameters:
      - $ref: '#/components/parameters/submission-id'
      - $ref: '#/components/parameters/document-id'
      responses:
        '200':
          description: Requested submission document is returned
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/SubmissionDocumentBinary'
        '400':
          description: Error indicates missing or wrong request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '401':
          description: Error indicates no access to the required resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthProblem'
        '404':
          description: Error indicates that a requested submission document resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RFC7807Problem'
components:
  schemas:
    EntryMarking:
      type: object
      description: 'Object to define entry markings like ''the end of the fixed interest rate'' or ''the amortization rate changed to''. The properties ''name'' and ''period'' are required and there can be additional key/value pairs for the specific markings like, ''rate: 3.5%'' for the value of the changed amortization rate if name is ''AMORTIZATION_RATE_CHANGED''.

        '
      allOf:
      - $ref: '#/components/schemas/EntryPeriod'
      required:
      - name
      properties:
        name:
          description: The name of the marking
          $ref: '#/components/schemas/MarkingName'
        rate:
          description: present if type is 'AMORTIZATION_RATE_CHANGED'
          $ref: '#/components/schemas/EuroAmount'
        amount:
          description: present if type is 'EXTRA_PAYMENT'
          $ref: '#/components/schemas/EuroAmount'
    AuxiliaryLoan:
      description: 'DE: Information zum Nachrangdarlehen. <br/>

        EN: Information about the auxiliary loan.

        '
      type: object
      required:
      - product
      allOf:
      - $ref: '#/components/schemas/BaseLoan'
      properties:
        annuityDetails:
          $ref: '#/components/schemas/AnnuityDetails'
        product:
          $ref: '#/components/schemas/AuxProductType'
    Contact:
      type: object
      properties:
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/Phone'
        email:
          type: string
          description: 'DE: E-Mail des Antragstellers <br/> EN: E-Mail of the customer

            '
          example: primary@example.com
    HouseUtilityOwnUnitGroup:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseHouseUtilityUnitGroup'
    AlimonyInfo:
      type: object
      required:
      - alimony
      description: 'DE: Informationen über Unterhaltseinkünfte. <br/> EN: Information regarding alimony income.

        '
      properties:
        alimony:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        maritalPart:
          description: 'DE: Davon: aus Ehegattenunterhalt. <br/>

            EN: Of which: from spousal aliment.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        childPart:
          description: 'DE: Davon: aus Kindesunterhalt. <br/>

            EN: Of which: from child support.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    PersonName:
      type: object
      required:
      - gender
      - firstName
      - lastName
      properties:
        gender:
          type: string
          description: 'DE: Geschlecht der Person (nicht abschließende Aufzählung), z. B. M=männlich, F=weiblich, D=divers, UNSPECIFIED. <br/> EN: Open ended enum contains gender of the person, possible values are M=male, F=female, D=diverse, UNSPECIFIED.

            '
          x-extensible-enum:
          - M
          - F
          - D
          - UNSPECIFIED
        title:
          $ref: '#/components/schemas/Title'
        firstName:
          type: string
          description: 'DE: Vorname der Person. <br/> EN: First name of the person.

            '
        lastName:
          type: string
          description: 'DE: Nachname der Person. <br/> EN: Last name of the person.

            '
        maidenName:
          type: string
          description: 'DE: Geburtsname der Person. <br/> EN: Maiden name of the person.

            '
    CalculationType:
      type: string
      description: 'DE: Kalkulationstyp (nicht abschließende Aufzählung), z.B. HOUSEHOLD=Haushaltsrechnung, CONDITION=Konditionskalkulation, LENDING_VALUE=Beleihungswert-Kalkulation <br/> EN: Calculation type - open ended enum contains property type details, possible values are HOUSEHOLD, CONDITION, LENDING_VALUE

        '
      example: HOUSEHOLD
      x-extensible-enum:
      - HOUSEHOLD
      - CONDITION
      - LENDING_VALUE
    ExistingModernisations:
      type: object
      description: 'DE: Information über die durchgeführte Modernisierungen. <br/> EN: Complete information about modernisations that were carried out.

        '
      properties:
        yearOfLastRefurbishment:
          description: 'DE: Jahr der letzten Modernisierung. <br/> EN: Year of a the last modernisation.

            '
          $ref: '#/components/schemas/Year'
        yearOfTotalRefurbishment:
          description: 'DE: Jahr der Totalsanierung. <br/> EN: Year of a complete modernisation.

            '
          $ref: '#/components/schemas/Year'
        description:
          description: 'DE: Beschreibung über die durchgeführte Modernisierungen. <br/>

            EN: Description of modernisations that were carried out.

            '
          type: string
        totalCosts:
          description: 'DE: Gesammte Modernisierungskosten. <br/>

            EN: Total modernisation costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        breakdown:
          description: 'DE: Detailierte Information über die durchgeführte Modernisierungen. <br/>

            EN: Breakdown (details) about the modernisations that were carried out.

            '
          items:
            $ref: '#/components/schemas/ExistingModernisation'
    MaritalPropertyStatusKey:
      type: string
      description: 'DE: Beschreibung des ehelichen Güterstandes (nicht abschließende Aufzählung, zum Beispiel: COMMUNITY_OF_ACQUESTS_AND_GAINS = ZUGEWINNGEMEINSCHAFT, SEPARATION_OF_PROPERTY = GÜTERTRENNUNG, ABSOLUTE_COMMUNITY_PROPERTY = GÜTERGEMEINSCHAFT). <br/> EN: Open ended enum contains values for the matrimonial property, possible values are COMMUNITY_OF_ACQUESTS_AND_GAINS, SEPARATE_PROPERTY, ABSOLUTE_COMMUNITY_PROPERTY.

        '
      example: COMMUNITY_OF_ACQUESTS_AND_GAINS
      x-extensible-enum:
      - COMMUNITY_OF_ACQUESTS_AND_GAINS
      - SEPARATE_PROPERTY
      - ABSOLUTE_COMMUNITY_PROPERTY
      - OTHER
    SuspendedAmortizationDetails:
      type: object
      required:
      - rateType
      description: 'DE: Information zum Tilgungssurrogat. <br/> EN: Information about the repayment surrogate.

        '
      allOf:
      - $ref: '#/components/schemas/BaseRateDetails'
      properties:
        type:
          $ref: '#/components/schemas/SuspendedRepaymentProductType'
        sum:
          description: 'DE: Tilgungsbetrag. <br/>

            EN: Amortisation sum.

            '
          $ref: '#/components/schemas/EuroAmount'
        contractSignedWith:
          description: 'DE: Referenz zu den Antragsteller der den Vetrag unterschrieben hat. <br/>

            EN: Reference to the applicant who signed the contract.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        contractDuration:
          description: 'DE: Vertragsdauer. <br/>

            EN: Contract duration.

            '
          $ref: '#/components/schemas/Duration'
        upcomingPayments:
          $ref: '#/components/schemas/UpcomingPayments'
        savingBurden:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        depositValue:
          $ref: '#/components/schemas/EuroAmount'
        contractNumber:
          description: 'DE: Vertragsnummer. <br/> EN: Contract number.

            '
          type: string
        combinedProduct:
          $ref: '#/components/schemas/SuspendedAmortizationCombinedProduct'
        debtId:
          description: Id of an existing mortgage saving plan
          $ref: '#/components/schemas/DebtId'
        amortizationProvider:
          description: Amortization product in case of mortgage saving plan or company providing life insurance in case of life insurance
          type: string
        homePurchaseSavingProvider:
          $ref: '#/components/schemas/HomePurchaseSavingProvider'
        externalId:
          description: id (projection id) used to identify the product used as a suspended amortization in the bank external system
          type: string
    SelfEmploymentIncome:
      type: object
      description: 'DE: Informationen über Einkommen aus einer selbststaendigen Taetigkeit (nach Steuern). <br/> EN: Information about self-employment Income (after Tax deduction).

        '
      required:
      - income
      properties:
        income:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        details:
          $ref: '#/components/schemas/SelfEmploymentIncomeDetails'
    Title:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/TitleKey'
    ApplicantItem:
      type: object
      required:
      - applicantRef
      - person
      properties:
        applicantRef:
          description: 'DE: Id und Referenz des Antragstellers. <br/> EN: Id and reference of the applicant.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        person:
          description: 'DE: Personendaten des Antragsstellers. <br/> EN: Personal data of the applicant.

            '
          $ref: '#/components/schemas/Person'
        embedded:
          description: 'DE: Vollständige Daten des Antragsstellers. <br/> EN: Complete data of the applicant.

            '
          $ref: '#/components/schemas/Applicant'
    MarginDetails:
      type: object
      required:
      - marginCorrection
      - margins
      properties:
        margins:
          type: array
          items:
            $ref: '#/components/schemas/Margin'
        marginCorrection:
          description: Margen Korrektur; ecision 'Margenkorrektur'
          $ref: '#/components/schemas/RawPercentage'
    RepaymentPlans:
      type: object
      required:
      - plans
      properties:
        plans:
          type: array
          items:
            $ref: '#/components/schemas/RepaymentPlan'
    PublicPreFinancing:
      type: object
      required:
      - amount
      - type
      description: 'DE: Information zu einem Zwischenfinanzierung in Zusammenhang mit einer öffentlichen Vorfinanzierung. <br/> EN: Bridging debt associated with public pre-financing.

        '
      allOf:
      - $ref: '#/components/schemas/BaseBridgingLoanDetails'
      properties:
        type:
          description: 'DE: Art der öffentlichen Vorfinanzierung. <br/> EN: Type of the public pre financing.

            '
          type: string
        company:
          description: 'DE: Unternehmen, welches die öffentlichen Vorfinanzierung bereitgestellt hat. <br/> EN: Company that provided the pre-financing.

            '
          type: string
        amount:
          description: 'DE: Vorfinanzierungsbetrag. <br/>

            EN: Pre-financing amount.

            '
          $ref: '#/components/schemas/EuroAmount'
    ModernisationTypeAndScope:
      type: object
      description: 'DE: Information über den Typ und Umfang der Modernisierung. <br/>

        EN: Information about the type and scope of the modernisation.

        '
      required:
      - modernisationType
      properties:
        modernisationType:
          $ref: '#/components/schemas/ModernisationType'
        modernisationScope:
          $ref: '#/components/schemas/ModernisationScope'
    PauseReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/PauseReasonKey'
    BaseProductCalculation:
      type: object
      required:
      - type
      - context
      - calculationDate
      properties:
        type:
          $ref: '#/components/schemas/CalculationType'
        context:
          $ref: '#/components/schemas/CalculationContext'
        calculationDate:
          description: 'DE: Datum der Kalkulation. <br/>

            EN: Calculation date.

            '
          $ref: '#/components/schemas/ISODate'
      discriminator:
        propertyName: type
    RefuseSignContractCommand:
      description: command to indicate that a customer refused to sign a contract.
      type: object
      required:
      - reason
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
        reason:
          $ref: '#/components/schemas/RefuseSignContractReason'
    CreditLoanItem:
      type: object
      description: 'Holds information regarding a specific submission credit loan.


        Further details will be delivered in the embedded property if specified.


        Please refer to *Expansion* section for more details.

        '
      properties:
        id:
          $ref: '#/components/schemas/CreditLoanId'
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        types:
          type: array
          description: 'DE: Art des Darlehens. <br/>

            EN: set of loan types associated with this credit loan.

            '
          items:
            $ref: '#/components/schemas/LoanType'
          minItems: 1
        embedded:
          $ref: '#/components/schemas/CreditLoan'
    RealEstateGuarantees:
      type: object
      description: 'DE: Bürgschaften für die Immobilie. <br/> EN: Guarantees associated with the real estate.

        '
      properties:
        plannedSell:
          description: 'DE: Flag, ob das Immobilienvermögen vor dem Finanzierungsprozess verkauft werden soll. <br/> EN: Flag indicates whether the real estate to be sold before the financing.

            '
          type: boolean
          nullable: true
        secureFinancing:
          description: 'DE: Flag, ob das Immobilienvermögen als Zusatzsicherheit verwendet werden soll. <br/> EN: Flag indicates whether the real estate to be used to secure the financing.

            '
          type: boolean
          nullable: true
    FinancingVentureBuyExisting:
      description: 'DE: Information über das Finanzierungsvorhaben für den Kauf einer bestehender Immobilie. <br/>

        EN: Information about the financing venture to buy an existing property.

        '
      required:
      - financingNeed
      - financingDetails
      allOf:
      - $ref: '#/components/schemas/BaseFinancingVenture'
      properties:
        financingNeed:
          $ref: '#/components/schemas/ForeignEstateFinancingNeed'
        financingDetails:
          $ref: '#/components/schemas/FinancingDetails'
    RegulatoryAuthorityLegalBasisKey:
      type: string
      description: 'DE: Relevante Rechtsnorm (nicht abschließende Aufzählung), z.B. (34_C_GEWO, 34_I_GEWO siehe auch (https://www.gesetze-im-internet.de/gewo/)). <br/> EN: Open ended enum contains the relevant legal norm, possible values are (34_C_GEWO, 34_I_GEWO).

        '
      x-extensible-enum:
      - 34_C_GEWO
      - 34_I_GEWO
    ForeclosureSale:
      description: 'DE: Information über Zwangsversteigerung. <br/> EN: Information about foreclosure sale.

        '
      type: object
      properties:
        previousOwner:
          $ref: '#/components/schemas/PreviousOwner'
        estimatedValue:
          description: 'DE: Geschätzte Wert der Immobile. <br/>

            EN: Estimated property value.

            '
          $ref: '#/components/schemas/EuroAmount'
        auction:
          $ref: '#/components/schemas/AuctionInfo'
    SubmissionDefaultStatus:
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
    EstateBuildingCosts:
      description: 'DE: Sammlung aller Kosten, die für den Bau der Immobilie relevant sind. <br/>

        EN: All costs associated with construction of the property.

        '
      type: object
      required:
      - construction
      properties:
        landPrice:
          description: 'DE: Grundstückpreis. <br/>

            EN: Land price.

            '
          $ref: '#/components/schemas/EuroAmount'
        construction:
          description: 'DE: Baukosten. <br/>

            EN: Construction costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        additional:
          description: 'DE: Zusätzliche Kosten. <br/>

            EN: Additional costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        outside:
          description: 'DE: Kosten der Außenanlagen. <br/>

            EN: Cost of the outdoor facilities.

            '
          $ref: '#/components/schemas/EuroAmount'
    CalculationContext:
      type: object
      description: 'DE: Kalkulation nach Art des Darlehens. <br/>

        EN: A set of financing structure contexts, which are associated with this calculation (i.e `Main` or `Nachrang` component)..

        '
      properties:
        components:
          type: array
          items:
            $ref: '#/components/schemas/CalculationContextComponent'
    LoanPartnerProcessingUnitId:
      description: 'DE: ID der Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. <br/> EN: Id of the loan partner processing unit.

        '
      required:
      - value
      properties:
        value:
          type: string
    LoanPartnerProcessingInfo:
      description: 'DE: Einheit des Kreditgebers, welche die Einreichung bearbeitet und aktueller (Kreditsach-)Bearbeiter. <br/> EN: Processing Unit and current processor of the loan partner.

        '
      type: object
      deprecated: true
      properties:
        unit:
          $ref: '#/components/schemas/LoanPartnerProcessingUnit'
        processor:
          $ref: '#/components/schemas/LoanPartnerProcessor'
    BaseRealEstateRating:
      type: object
      description: 'DE: Information laut Immobilionbewertung. <br/> EN: Information from estate evaluation

        '
      required:
      - type
      properties:
        type:
          type: string
        marketValue:
          description: 'DE: Geschätzter Marktwert. <br/> EN: Estimated market value.

            '
          $ref: '#/components/schemas/EuroAmount'
        marketValueEvaluation:
          description: 'DE: Marktwert entsprechend einer Infoquelle (z. B. Sprengnetter). <br/> EN: Market value according to an information source (e.g. Sprengnetter).

            '
          $ref: '#/components/schemas/MarketValueEvaluation'
      discriminator:
        propertyName: type
    PropertyRegisterMortgage:
      description: 'DE: Hyptheken, Grundschulden, Rentenschulden (Eintrag aus der dritten Abteilung des Grundbuchblattes). <br/> EN: Mortgages, land charges, annuities (entry from the third section of the land register sheet).

        '
      type: object
      properties:
        serial:
          description: 'DE: Laufende Nummer im Grundbuch. <br/> EN: Serial number in land register.

            '
          type: string
        rank:
          description: 'DE: Rangstelle im Grundbuch. <br/> EN: Cadastral reference.

            '
          type: string
        inventories:
          description: 'DE: Referenzen zu den Einträgen im Bestandsverzeichnis. <br/> EN: References to the entries in the inventory.

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterInventoryId'
        nominalAmount:
          description: 'DE: Im Grundbuch eingetragener Betrag. <br/> EN: Amount entered in the land register.

            '
          $ref: '#/components/schemas/EuroAmount'
        cessionClaim:
          $ref: '#/components/schemas/CessionClaim'
        creditor:
          description: 'EN: Creditor DE: Gläubiger

            '
          type: string
        interest:
          description: 'EN: Interest DE: Dinglicher Zins

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        nonRecurringLoanUndertaking:
          description: 'EN: One-time value DE: Einmalvalutierung siehe [Einmalvalutierung](https://de.wikipedia.org/wiki/Einmalvalutierungserkl%C3%A4rung)

            '
          type: boolean
          nullable: true
        auxiliary:
          description: 'EN: Additional services DE: Nebenleistungen

            '
          $ref: '#/components/schemas/Percentage'
        primary:
          description: 'DE: Flag um anzuzeigen, ob der Darlehensgeber als vorrangiger Gläubiger im Grundbuch eingetragen ist. <br/> EN: Flag to indicate whether the lender is registered as primary creditor in the land register.

            '
          type: boolean
          nullable: true
        typeOfBurden:
          type: string
          description: 'DE: Art der Belastung. <br/>

            EN: Type of Burden

            '
          x-extensible-enum:
          - LAND_CHARGE
          - MORTGAGE
        residualDebt:
          description: 'DE: Restschuld. <br/>

            EN: Residual debt

            '
          $ref: '#/components/schemas/EuroAmount'
    InterestRateUpdate:
      oneOf:
      - $ref: '#/components/schemas/AnnuityInterestRateUpdate'
      - $ref: '#/components/schemas/BuildingSavingPlanInterestRateUpdate'
      discriminator:
        propertyName: rateUpdateType
        mapping:
          ANNUITY: '#/components/schemas/AnnuityInterestRateUpdate'
          BUILDING_SAVING_PLAN: '#/components/schemas/BuildingSavingPlanInterestRateUpdate'
    Cursor:
      type: object
      description: 'A cursor refers to a random string of characters which marks a specific item in a collection of data.


        The cursor will always point to the item, however it will be invalidated if the item is deleted or removed.

        '
      properties:
        before:
          type: string
          description: 'This is the cursor that points to the start of the page of data that has been returned.

            '
        after:
          type: string
          description: This is the cursor that points to the end of the page of data that has been returned.
    ProcessorName:
      description: 'DE: Username, Vor- und Nachname des (Kredit-)Bearbeiters. <br/> EN: Username, first- and lastname of the loan partner processor.

        '
      required:
      - userName
      properties:
        userName:
          type: string
        firstName:
          type: string
        lastName:
          type: string
    CreditDecisionDocumentMetaData:
      type: object
      deprecated: true
      properties:
        documents:
          type: array
          items:
            $ref: '#/components/schemas/DocumentMetaData'
    ResourceRef:
      required:
      - href
      properties:
        href:
          type: string
          description: 'DE: Link zu einer spezifischen Ressource. <br/> EN: Link to retrieve a specific resource.

            '
          example: http://some-domain/some/link/to/somewhere
      x-skip-camel-case-check: true
    DebtId:
      type: object
      description: 'DE: ID der Verbindlichkeit. <br/>

        EN: ID of the associated Debt.

        '
      required:
      - value
      properties:
        value:
          type: string
    OriginInfo:
      type: object
      required:
      - client
      - externalId
      description: 'DE: Enthält die Information über Datenquelle und Daten-Identifikator aus dem externen System. <br/> EN: Contains information about Data source and data identifier in the external system.

        '
      properties:
        client:
          $ref: '#/components/schemas/Client'
        externalId:
          $ref: '#/components/schemas/ExternalId'
        intentId:
          $ref: '#/components/schemas/IntentId'
    OpenPropertySale:
      type: object
      description: 'DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem Immobilienverkauf. <br/> EN: Information about bridging debt associated with property sale.

        '
      allOf:
      - $ref: '#/components/schemas/BaseBridgingLoanDetails'
      properties:
        debtAmount:
          description: 'DE: Aktuelle Grundschuldhöhe. <br/>

            EN: Current debt amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        residualDebt:
          description: 'DE: Aktuelle Restschuld. <br/>

            EN: Current remaining debt.

            '
          $ref: '#/components/schemas/EuroAmount'
    InitialSubmissionEstimate:
      description: 'DE: Voraussichtliches Entscheidungsdatum. <br/> EN: Estimated decision date.

        '
      type: object
      properties:
        createdAt:
          $ref: '#/components/schemas/ISODateTime'
    ExternalProcessingReason:
      type: string
      description: 'EN: Open ended enum contains possible reasons for external processing (EXTERNAL_EXPERT_ASSESSMENT, INTERNAL_EXPERT_ASSESSMENT, DECISION_INTERNAL_UNIT, CONTRACT_CREATION, FORWARD_FINAL_DECISION, REJECT_NOTICE, WAITING_FOR_ORIGINAL_CONTRACT, OTHER) DE: Mögliche Gruende fur das Warten auf externe Faktoren (EXTERNAL_EXPERT_ASSESSMENT=Externes Gutachten, INTERNAL_EXPERT_ASSESSMENT=Internes Gutachten,  DECISION_INTERNAL_UNIT=Entscheidung Marktfolge, CONTRACT_CREATION=Vertragserstellung,  FORWARD_FINAL_DECISION=Weitergabe finale Genehmigung, REJECT_NOTICE=Ablehnungsankündigung, WAITING_FOR_ORIGINAL_CONTRACT=Warten auf Vertragsoriginal,  OTHER=Nicht aufgeführter Grund)

        '
      example: OTHER
      x-extensible-enum:
      - EXTERNAL_EXPERT_ASSESSMENT
      - INTERNAL_EXPERT_ASSESSMENT
      - DECISION_INTERNAL_UNIT
      - CONTRACT_CREATION
      - FORWARD_FINAL_DECISION
      - REJECT_NOTICE
      - WAITING_FOR_ORIGINAL_CONTRACT
      - OTHER
    ApplicationSubTypeKey:
      type: string
      description: 'DE: Unterkategorie des Antragstyp (nicht abschließende Aufzählung), z.B. (NEW_APPLICANT, PROLONGATION, SUPPLEMENTARY_FINANCING). <br/>

        EN: Open ended enum contains application sub type, possible values are (NEW_APPLICANT, PROLONGATION, SUPPLEMENTARY_FINANCING).

        '
      example: NEW_APPLICANT
      x-extensible-enum:
      - NEW_APPLICANT
      - PROLONGATION
      - SUPPLEMENTARY_FINANCING
    CreditPhasePayout:
      properties:
        amount:
          description: 'DE: Bauspardarlehenssumme. <br/>

            EN: The loan amount in EUR that is provided by the Bausparkasse.

            '
          $ref: '#/components/schemas/EuroAmount'
        payoutDate:
          description: 'DE: Datum der Auszahlungsdatum. <br/>

            EN: The date on which the credit is paid out.

            '
          $ref: '#/components/schemas/ISODate'
    KfwProgram:
      type: object
      properties:
        key:
          deprecated: true
          description: '@deprecated: Use field type for the program instead.

            '
          $ref: '#/components/schemas/KfwProgramKey'
        type:
          $ref: '#/components/schemas/KfwProgramType'
    RejectReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RejectReasonKey'
    CalculationDetail:
      description: 'DE: Detailierte Information über einen Eintrag in der Kalkulation.<br/>

        EN: Detailed information about single entry in the calculation.

        '
      type: object
      properties:
        index:
          type: integer
          description: 'DE: Reihenfolge Index innerhalb der Kalkulationdetails. <br/>

            EN: Order index within calculation details.

            '
        category:
          $ref: '#/components/schemas/DetailType'
        name:
          type: string
          description: 'DE: Name des Wertes. <br/>

            EN: Entry name.

            '
        description:
          type: string
          description: 'DE: Beschreibung des Wertes. <br/>

            EN: Entry description.

            '
        userInputValue:
          type: string
          description: 'DE: Von user eingetragene Wert. <br/>

            EN: User input value.

            '
        calculatedValue:
          type: string
          description: 'DE: Berechnete Wert. <br/>

            EN: Calculated value.

            '
        hints:
          type: array
          description: 'DE: Hinweise zum  <br/>

            EN: Collection of calculation hints.

            '
          items:
            type: string
    FinancingVentureBuyNew:
      description: 'DE: Information über das Finanzierungsvorhaben für den Kauf einer Neubauimmobilie. <br/>

        EN: Information about the financing venture to buy a newly built property.

        '
      required:
      - financingNeed
      - financingDetails
      allOf:
      - $ref: '#/components/schemas/BaseFinancingVenture'
      properties:
        financingNeed:
          $ref: '#/components/schemas/ForeignEstateFinancingNeed'
        financingDetails:
          description: 'DE: Finanzierungsdetails zum Kauf einer Neubauimmobilie. <br/>

            EN: Financing details relevant for purchase of newly build property.

            '
          $ref: '#/components/schemas/FinancingDetails'
        constructionStartDate:
          description: 'DE: Baubeginn des Neubaus. <br/>

            EN: Construction start date of the newly built property.

            '
          $ref: '#/components/schemas/ISODate'
    HouseholdCalculationCommandIncome:
      type: object
      required:
      - valuation
      - entries
      properties:
        value:
          description: Der vom Kunden eingetragene Wert
          $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        valuation:
          description: Der von der Bank angesetzte Wert
          $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        entries:
          type: array
          items:
            $ref: '#/components/schemas/HouseholdCalculationCommandEntry'
    LoanPartnerProcessorCommandTrigger:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseCommandTrigger'
      properties:
        processingUnit:
          deprecated: true
          description: This is deprecated and will be removed as soon as the services can handle the new field.
          $ref: '#/components/schemas/LoanPartnerProcessingInfo'
        processingUnitId:
          $ref: '#/components/schemas/CompanyId'
        processorId:
          $ref: '#/components/schemas/ProcessorId'
    HousingSituation:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/HousingSituationKey'
    ArchiveSubmissionCommand:
      description: Mark a submission as archived.
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
    ExistingModernisation:
      type: object
      description: 'DE: Information über die durchgeführte und geplante Modernisierungen. <br/> EN: Complete information about carried out and planned modernisations.

        '
      required:
      - modernisationTypeAndScope
      - modernisationCost
      properties:
        modernisationTypeAndScope:
          $ref: '#/components/schemas/ModernisationTypeAndScope'
        year:
          description: 'DE: Jahr der Modernisierung. <br/> EN: Year of modernisation.

            '
          $ref: '#/components/schemas/Year'
        modernisationCost:
          description: 'DE: Modernisierungskosten. <br/>

            EN: Modernisation costs.

            '
          $ref: '#/components/schemas/EuroAmount'
    ConsultationInfo:
      type: object
      deprecated: true
      x-replaced-with: Consultation.advisory
      required:
      - clientAdvisor
      description: 'DE: Informationen über die Beratung. <br/>

        EN: Information about the involved parties in the consultation phase.

        '
      properties:
        clientAdvisor:
          $ref: '#/components/schemas/OrganizationUser'
    SpecialHouseCharacteristics:
      description: 'DE: Spezielle Nutzung des Hauses. <br/> EN: Special use of the house.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSpecialRealEstateCharacteristics'
      properties:
        farm:
          description: 'DE: Bauernhof. <br/> EN: Farm.

            '
          type: boolean
          nullable: true
    RejectSubmissionCounterOfferCommand:
      type: object
      description: command to reject a counter offer.
      required:
      - counterOfferId
      - reason
      - remark
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        counterOfferId:
          $ref: '#/components/schemas/SubmissionCounterOfferId'
        reason:
          $ref: '#/components/schemas/RejectSubmissionCounterOfferReason'
        remark:
          type: string
    OtherCapitalFinancing:
      description: 'DE: Finanzierungsrelevante Information zur Kapitalbeschaffung. <br/>

        EN: Financing-relevant information about the raising capital need.

        '
      type: object
      required:
      - neededLoan
      allOf:
      - $ref: '#/components/schemas/BaseOwnEstateFinancingNeed'
      properties:
        neededLoan:
          $ref: '#/components/schemas/OtherCapitalNeededLoan'
    CreditLoanId:
      type: object
      description: 'DE: Id der Finanzierungsstruktur. <br/> EN: Credit Loan identifier.

        '
      required:
      - value
      properties:
        value:
          type: string
    PropertyRegister:
      description: 'DE: [Grundbuchinformationen](http://www.gesetze-im-internet.de/gbvfg/BJNR706370935.html#BJNR706370935BJNG000402307). <br/> EN: Information according to the property / land register (hereinafter referred to as land register).

        '
      type: object
      required:
      - cover
      properties:
        cover:
          description: 'DE: Allgemeine Information zum Grundbuchblatt (Aufschrift des Grundbuchblattes). <br/> EN: General information on the land register (title of land register sheet)

            '
          $ref: '#/components/schemas/RegisterCover'
        inventories:
          description: 'DE: Grundstück und Eigentum (Bestandsverzeichnis des Grundbuchblattes). <br/> EN: Land and property (inventory of the land register sheet).

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertiesRegisterInventory'
        owners:
          description: 'DE: Derzeitige Eigentümer (Erste Abteilung des Grundbuchblattes). <br/> EN: Current owners (first section of the land register sheet).

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterOwnerEntry'
        restrictions:
          description: 'DE: Lasten und Beschränkungen (Zweite Abteilung des Grundbuchblattes). <br/> EN: Burdens and restrictions (second section of the land register sheet).

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterRestriction'
        mortgages:
          description: 'DE: Hypotheken, Grundschulden, Rentenschulden (Dritte Abteilung des Grundbuchblattes). <br/> EN: Mortgages, land charges, annuity charges (third section of the land register sheet).

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterMortgage'
    ApplicantIdRef:
      type: object
      description: 'DE: Id und Referenz des Antragstellers. <br/> EN: Id and reference of the applicant.

        '
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        applicantId:
          $ref: '#/components/schemas/ApplicantId'
    OtherCapitalNeededLoanUsage:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/OtherCapitalNeededLoanUsageKey'
    CreditWorthiness:
      oneOf:
      - $ref: '#/components/schemas/SchufaRating'
      discriminator:
        propertyName: type
        mapping:
          SCHUFA: '#/components/schemas/SchufaRating'
    Recommendation:
      type: object
      description: 'DE: Empfehlung des Beraters. <br/> EN: Financing advisor recommendations.

        '
      properties:
        chefsSuggestion:
          type: boolean
          nullable: true
          description: 'DE: Angebot vom Berater empfohlen. <br/> EN: Offer is recommended by the financing advisor.

            '
        explanation:
          type: string
          description: 'DE: Erläuterung zur Empfehlung des Beraters. <br/> EN: Explanation of the financing advisor''s recommendation.

            '
    LoanToValueRatioProductCalculation:
      type: object
      description: 'DE: Information zu der Kalkulation <br/>

        EN: Information about the calculation.

        '
      required:
      - type
      - feasibility
      - lender
      allOf:
      - $ref: '#/components/schemas/BaseProductCalculation'
      properties:
        feasibility:
          $ref: '#/components/schemas/LoanToValueRatioBreakdown'
        conditioning:
          $ref: '#/components/schemas/LoanToValueRatioBreakdown'
        lender:
          type: string
          description: Darlehensgeber
    SelfEmploymentIncomeDetails:
      type: object
      description: 'DE: Berechnung des selbstständigen Einkommens. <br/> EN: Calculation of independent (self employment) income.

        '
      properties:
        method:
          $ref: '#/components/schemas/SelfEmploymentIncomeMethod'
        description:
          type: string
          description: 'DE: Anmerkungen zur Bilanz. <br/> EN: Notes on the balance.

            '
        averageNetProfit:
          description: 'DE: Durchschn. persönlicher Nachsteuergewinn. <br/>

            EN: Average after-tax profit.

            '
          $ref: '#/components/schemas/EuroAmount'
        values:
          type: array
          items:
            $ref: '#/components/schemas/SelfEmploymentIncomeItem'
    ExtendedPeriodicalSavingsEntry:
      type: object
      description: Savings plan (Sparplan, Summe Sparplan, letzte Periode Sparplan) including marking for special entries.
      allOf:
      - $ref: '#/components/schemas/PeriodicalSavingsEntry'
      properties:
        markings:
          type: array
          items:
            $ref: '#/components/schemas/EntryMarking'
    BaseLoan:
      type: object
      description: 'DE: Information zum Darlehen(-objekt). <br/> EN: Information about the financial loan.

        '
      required:
      - id
      - type
      - amount
      - loanPartner
      properties:
        id:
          $ref: '#/components/schemas/LoanId'
        seq:
          type: integer
          format: int32
          deprecated: true
          description: '@deprecated: Use field id for identification instead.

            '
        type:
          $ref: '#/components/schemas/LoanType'
        amount:
          description: 'DE: Darlehnsbetrag (per Tranche). <br/>

            EN: Loan amount (for loan component).

            '
          $ref: '#/components/schemas/EuroAmount'
        maturity:
          description: 'DE: Information zur Sollzinsbindung. <br/>

            EN: Information about interest rate maturity.

            '
          $ref: '#/components/schemas/InterestMaturity'
        specialRepayment:
          $ref: '#/components/schemas/SpecialRepayment'
        payout:
          $ref: '#/components/schemas/PayoutInfo'
        duration:
          description: 'DE: Darlehensdauer/Gesamtlaufzeit. <br/>

            EN: Loan duration.

            '
          $ref: '#/components/schemas/Duration'
        loanPartner:
          description: Please use the loanPartnerId instead.
          deprecated: true
          $ref: '#/components/schemas/LoanPartnerProcessingUnit'
        loanPartnerId:
          $ref: '#/components/schemas/CompanyId'
        financedMortgageProperty:
          description: 'DE: Referenz zu einem Beleihungsobjekt. <br/>

            EN: Reference to a lending object.

            '
          $ref: '#/components/schemas/EstateRef'
        contractNumber:
          type: string
          description: 'DE: Darlehensnummer / Vertragsnummer. <br/> EN: Loan number / contract number.

            '
        commission:
          $ref: '#/components/schemas/CommissionInfo'
        isSecuredByLandRegister:
          type: boolean
          description: 'DE: Ist das Darlehen grundpfandrechtlich besichert? <br /> EN: Is the loan secured by land register?

            '
        commitmentInterest:
          description: 'DE: Bereitstellungszins. <br/> EN: Periodical commitment interest rate.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        eHypCent:
          description: 'DE: Platformnutzungsgebühr . <br/>

            EN: Platform usage fees.

            '
          $ref: '#/components/schemas/EuroAmount'
        isForwardLoan:
          type: boolean
      discriminator:
        propertyName: type
    ResponsiblePerson:
      type: object
      required:
      - type
      - personName
      properties:
        type:
          $ref: '#/components/schemas/ResponsiblePersonType'
        personName:
          $ref: '#/components/schemas/PersonName'
        contact:
          $ref: '#/components/schemas/Contact'
    CalculationItem:
      type: object
      properties:
        context:
          x-is-plural: true
          type: array
          description: 'DE: Kalkulation nach Art des Darlehens. <br/>

            EN: A set of financing structure contexts, which are associated with this calculation (i.e `Main` or `Nachrang` component)..

            '
          items:
            $ref: '#/components/schemas/LoanType'
        calculation:
          $ref: '#/components/schemas/Calculation'
    ForeignEstateFinancingDetails:
      description: 'DE: Finanzierungsdetails über das Finanzierungvorhaben der Immobilie die erworben wird. <br/>

        EN: Financing details about financing process associated with the property which is to be acquired.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseFinancingDetails'
      properties:
        newOwners:
          description: 'DE: Eigentümer zum Zeitpunkt der Finanzierung (Erste Abteilung des Grundbuchblattes). <br/> EN: Owner at the time of financing (First Section of the Land Register Page)

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterOwner'
        saleInfo:
          $ref: '#/components/schemas/SaleInformation'
        vendor:
          $ref: '#/components/schemas/EstateVendor'
    MaritalStatusKey:
      type: string
      description: 'DE: Familienstand des Antragstellers (nicht abschließende Aufzählung, zum Beispiel: SINGLE = LEDIG, MARRIED = VERHEIRATET, REGISTERED_PARTNERSHIP = EINGETRAGENE LEBENSPARTNERSCHAFT, WIDOWED = VERWITWET, DIVORCED = GESCHIEDEN, SEPARATED=GETRENNT). <br/> EN: Open ended enum contains values for the marital status, possible values are SINGLE, MARRIED, REGISTERED_PARTNER, WIDOWED, DIVORCED, SEPARATED.

        '
      example: SINGLE
      x-extensible-enum:
      - SINGLE
      - MARRIED
      - REGISTERED_PARTNER
      - WIDOWED
      - DIVORCED
      - SEPARATED
      - COHABITING
      - OTHER
    BaseOwnEstateFinancingNeed:
      type: object
      required:
      - reason
      description: 'DE: Finanzierungsbedarf für die eigene Immobilie <br/> EN: Financing need for the own estate.

        '
      allOf:
      - $ref: '#/components/schemas/BaseFinancingNeed'
      properties:
        reason:
          type: string
        renovationCosts:
          description: 'DE: Werterhaltende Maßnahmen <br/> EN: Value-conserving actions

            '
          $ref: '#/components/schemas/EuroAmount'
        plannedModernisations:
          $ref: '#/components/schemas/PlannedModernisations'
        reschedulingMortgages:
          description: 'DE: Darlehen die umgeschuldet werden sollen <br/> EN: Mortgage which is to be rescheduled

            '
          type: array
          items:
            $ref: '#/components/schemas/ExistingMortgageRef'
      discriminator:
        propertyName: reason
    BaseInterestRateUpdate:
      type: object
      required:
      - rateUpdateType
      properties:
        rateUpdateType:
          type: string
          x-extensible-enum:
          - ANNUITY
          - BUILDING_SAVING_PLAN
      discriminator:
        propertyName: rateUpdateType
    EstateAdditionalCosts:
      type: object
      properties:
        inventoryCosts:
          $ref: '#/components/schemas/EuroAmount'
        otherCosts:
          $ref: '#/components/schemas/EuroAmount'
        description:
          type: string
    InsuranceExpense:
      type: object
      description: 'DE: Informationen über Ausgaben durch Versicherungen. <br/> EN: Informations related insurance expences.

        '
      properties:
        healthInsurance:
          description: 'DE: Private/freiw. gesetzliche Krankenversicherungsbeiträge. <br/>

            EN: Private/ voluntary statutory health insurance contributions.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        lifeInsurance:
          description: 'DE: Private Lebens- und Rentenversicherungsbeiträge. <br/>

            EN: Private life and pension insurance contributions.

            '
          $ref: '#/components/schemas/InsuranceBurden'
        accidentInsurance:
          description: 'DE: Unfallversicherungsbeiträge. <br/>

            EN: Accident insurance contributions.

            '
          $ref: '#/components/schemas/InsuranceBurden'
        disabilityInsurance:
          description: 'DE: Berufsunfähigkeitsversicherungsbeiträge. <br/>

            EN: Disability insurance contributions.

            '
          $ref: '#/components/schemas/InsuranceBurden'
    UserData:
      type: object
      properties:
        userId:
          $ref: '#/components/schemas/UserId'
        name:
          $ref: '#/components/schemas/PersonName'
        contact:
          $ref: '#/components/schemas/Contact'
        jobTitle:
          type: string
    SuspendedRepaymentProductTypeKey:
      type: string
      description: 'DE: Art des Tilgungssurrogats (nicht abschließende Aufzählung), z.B. DT_KAP_LV, DT_KAP_RV, BRIT_KAP_LV, BRIT_KAP_RV, FONDS_LV, FONDS_RV, FONDS_SPAR, BAU_SPAR, OTHER. <br/> EN: Open ended enum contains type of repayment surrogate, possible values are DT_KAP_LV, DT_KAP_RV, BRIT_KAP_LV, BRIT_KAP_RV, FONDS_LV, FONDS_RV, FONDS_SPAR, BAU_SPAR, OTHER.

        '
      example: DT_KAP_LV
      x-extensible-enum:
      - DT_KAP_LV
      - DT_KAP_RV
      - BRIT_KAP_LV
      - BRIT_KAP_RV
      - FONDS_LV
      - FONDS_RV
      - FONDS_SPAR
      - BAU_SPAR
      - OTHER
    EstateAdditionalLoan:
      description: 'DE: Information über ein bestehendes Darlehen (Hypothek). <br/>

        EN: Information about the already existing mortgage.

        '
      type: object
      required:
      - amount
      properties:
        amount:
          description: 'DE: Darlehenssumme. <br/>

            EN: Loan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        description:
          type: string
        usage:
          $ref: '#/components/schemas/EstateAdditionalLoanUsage'
    BaseSuspendedAmortizationCombinedProduct:
      type: object
      required:
      - product
      properties:
        product:
          $ref: '#/components/schemas/SuspendedRepaymentProductTypeKey'
      discriminator:
        propertyName: product
    CycleKey:
      type: string
      description: 'DE: Mögliche Zykluswerte (nicht abschließende Aufzählung), z.B. MONTHLY, QUARTERLY, HALF_YEARLY, ANNUAL, ONE_TIME. <br/> EN: Open ended enum contains possible cycle values, possible values are MONTHLY, QUARTERLY, HALF_YEARLY, ANNUAL, ONE_TIME.

        '
      example: ANNUAL
      x-extensible-enum:
      - MONTHLY
      - QUARTERLY
      - HALF_YEARLY
      - ANNUAL
      - ONE_TIME
    BaseExistingLoanDebt:
      type: object
      required:
      - debtId
      - type
      description: "DE: Finanzierungsrelevante Darlehen. <br/> EN: Existing loan debt.\n\nAn Existing debt could be any of the following types:\n - EMPLOYMENT\n - PRIVATE\n - MORTGAGE_SAVING_PLAN\n - OTHER\n - PUBLIC\n - SOLVENCY\n - EXISTING_MORTGAGE\n - EXISTING_REALESTATE\n - OPEN_PROPERTY_SALE\n"
      properties:
        debtId:
          description: 'DE: Id der dazugehörenden Schulden.


            Die Schulden können mit Hilfe des /v2/financing-applications/{financingApplicationId}/financial-standings/existing-loans/{debtId} abgefragt werden. <br/>


            EN: Id of the associated Debt.


            Debt can be accessed via the respective endpoint. */v2/financing-applications/{financingApplicationId}/financial-standings/existing-loans/{debtId}*

            '
          $ref: '#/components/schemas/DebtId'
        contractNumber:
          type: string
          description: 'DE: Vertragsnummer. <br/> EN: Contract number.

            '
        type:
          $ref: '#/components/schemas/ExistingDebtType'
        expectedFutureBurden:
          $ref: '#/components/schemas/DebtExpense'
      discriminator:
        propertyName: type
    UpcomingPayments:
      type: object
      description: 'DE: Kosten für das Tilgungssurrogat in den Folgeperioden. <br/> EN: Upcoming payments for repayment surrogate product.

        '
      properties:
        upcomingFees:
          deprecated: true
          description: '@deprecated: Upcoming fees are inadmissible. This was decided by the Federal Court of Justice in its ruling of November 15, 2022.

            DE: Höhe der wiederkehrenden Kosten. <br/>

            EN: Upcoming costs.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        closingFee:
          description: 'DE: Abschlussgebühr für das Tilgungssurrogat. <br/> EN: Acquisition fee for the repayment surrogate product.

            '
          $ref: '#/components/schemas/EuroAmount'
        paymentDuration:
          description: 'DE: Laufzeit des Tilgungssurrogats. <br/>

            EN: Duration of the repayment surrogate product.

            '
          $ref: '#/components/schemas/Duration'
    PeriodicalRawPercentage:
      description: 'DE: Periodischer Prozentsatz. <br/> EN: Periodical percentage.

        '
      type: object
      required:
      - percentage
      - cycle
      properties:
        percentage:
          $ref: '#/components/schemas/RawPercentage'
        cycle:
          $ref: '#/components/schemas/Cycle'
    ModernisationTypeKey:
      type: string
      description: 'DE: Typ der Modernisierung (nicht abschließende Aufzählung), z.B. (ELECTRIC, FASSADE, FLOOR_PLAN=Raumaufteilung, FLOORING=Bodenbeläge, HEATING, INSTALLATION, INSULATION=Wärmedämmung, ROOF, SANITARY=Sanitärobjekte, WINDOW, OTHER, HEAT_PROTECTION = Wärmeschutz, VENTILATION_SYSTEM = Lüftungsanlagen, DIGITAL_ENERGY_OPTIMISATION = Digitale Systeme zur Energieoptimierung). <br/> EN: Open ended enum contains types of modernisation, possible values are (ELECTRIC, FASSADE, FLOOR_PLAN, FLOORING, HEATING, INSTALLATION, INSULATION, ROOF, SANITARY, WINDOW, OTHER, HEAT_PROTECTION, VENTILATION_SYSTEM, DIGITAL_ENERGY_OPTIMISATION).

        '
      example: ELECTRIC
      x-extensible-enum:
      - ELECTRIC
      - FASSADE
      - FLOOR_PLAN
      - FLOORING
      - HEATING
      - INSTALLATION
      - INSULATION
      - ROOF
      - SANITARY
      - WINDOW
      - OTHER
      - HEAT_PROTECTION
      - VENTILATION_SYSTEM
      - DIGITAL_ENERGY_OPTIMISATION
    BaseResidualDebtProtection:
      type: object
      description: 'DE: Eine Restschuldabsicherung für eine der Tranchen. Wird über die LoanId referenziert, falls es mit einer Tranche verbunden ist.

        EN: A residual debt protection for the loans. Will be reference via the loan id, if connected to a loan.

        '
      required:
      - id
      - loanPartnerId
      - type
      properties:
        id:
          $ref: '#/components/schemas/ResidualDebtId'
        loanId:
          description: 'DE: Referenz zu der Tranche (wenn vorhanden), welche durch diese Restschuldabsicher abgesichert wird.

            EN: Reference to the loan (if available) that will be protected by this residual debt protection.

            '
          $ref: '#/components/schemas/LoanId'
        loanPartnerId:
          $ref: '#/components/schemas/CompanyId'
        type:
          $ref: '#/components/schemas/ResidualDebtProtectionType'
      discriminator:
        propertyName: type
    CounterOfferMainLoan:
      description: 'DE: Information zum Gegenangebot Hauptdarlehen. <br/>

        EN: Information about the counter offer main loan.

        '
      type: object
      required:
      - type
      - rateDetails
      allOf:
      - $ref: '#/components/schemas/BaseCounterOfferLoan'
      properties:
        rateDetails:
          description: 'DE: Detailinformation zu den Raten. <br/>

            EN: Detailed information about the rates.

            '
          $ref: '#/components/schemas/CounterOfferRateDetails'
    HandoverReport:
      type: object
      description: "DE: Metadaten zur den Einreichungsunterlagen. <br/>\nEN: Metadata regarding the system generated reports for a specific submission.\nHandover reports including but not limited to:\n  - Übergabeprotokoll\n\n  - Provideranschreiben\n\n  - Überarbeiteter Antrag\n\n  - Kalkulation\n\n  - HH-Rechnung\n"
      required:
      - name
      - description
      - createdAt
      properties:
        name:
          type: string
          description: 'DE: Bezeichnung der Einreichungsunterlage. <br/>

            EN: Name of the handover report.

            '
        description:
          type: string
          description: 'DE: Kurze Beschreibung der Einreichungsunterlage. <br/>

            EN: Short description of the handover report.

            '
        createdAt:
          $ref: '#/components/schemas/ISODateTime'
        context:
          type: array
          description: 'DE: Einreichungsunterlage nach Art des Darlehens. <br/>

            EN: A set of financing structure contexts, which are associated with this handover report (i.e `Main` or `Nachrang` component)..

            '
          items:
            $ref: '#/components/schemas/LoanType'
          x-is-plural: true
        content:
          description: 'DE: Link zur Unterlage als `PDF` Document. <br/>

            EN: Link to retrieve the content of a specific handover report as `PDF` document.

            '
          $ref: '#/components/schemas/ResourceRef'
    AdditionalField:
      description: 'DE: Zusätzliche Feldinformationen. <br/> EN: Additional field info.

        '
      type: object
      required:
      - id
      - name
      - value
      properties:
        id:
          type: string
        name:
          type: string
        value:
          type: string
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
    PaymentTimeKey:
      type: string
      description: 'DE: Mögliche Zahlungszeit-Arten (nicht abschließende Aufzählung), z.B. ADVANCE=Vorschüssig, ARREARS=Nachschüssig. <br/> EN: Open ended enum contains possible payment time types, possible values are ADVANCE, ARREARS.

        '
      example: ADVANCE
      x-extensible-enum:
      - ADVANCE
      - ARREARS
    FinancingApplicationStatus:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/FinancingApplicationStatusKey'
    LoanToValueRatioEntry:
      title: LoanToValueRatioEntry
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Name des Eintrages
        hints:
          type: array
          description: Liste an Hinweisen
          items:
            type: string
        realValue:
          description: Der tatsächliche Wert in Euro
          $ref: '#/components/schemas/RawEuroAmount'
        realValueComposition:
          type: string
          description: Der vom Scoring ausgegebene, unverarbeitete Text
        valuation:
          description: Der von der Bank angesetzte Wert in Euro
          $ref: '#/components/schemas/RawEuroAmount'
        loanId:
          $ref: '#/components/schemas/LoanId'
    House:
      description: 'DE: Zusätzliche Information zu der Immobilie von Typ "HOUSE" (Haus). <br/>

        EN: Additional Information for the estate with the type "HOUSE".

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/RealEstate'
      properties:
        rating:
          $ref: '#/components/schemas/HouseRating'
        attic:
          $ref: '#/components/schemas/AtticDetail'
        basement:
          $ref: '#/components/schemas/Basement'
        specialCharacteristics:
          $ref: '#/components/schemas/SpecialHouseCharacteristics'
        separatedByWEG:
          description: 'DE: Geteilt nach dem Wohneigentumsgesetz (WEG). <br/> EN: Separated based on the WEG law.

            '
          type: boolean
          nullable: true
          x-skip-camel-case-check: true
        utilityUnits:
          $ref: '#/components/schemas/HouseUtilityUnits'
    ResponsiblePersonType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ResponsiblePersonTypeKey'
    RentPeriodType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RentPeriodTypeKey'
    UpdateSubmissionLoanContractNumberCommand:
      description: Update the contract number of a loan of a submission.
      type: object
      required:
      - contracts
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        contracts:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ContractInfo'
        createdBy:
          description: 'DE: Optionale Informationen über den Auslöser der Aktion. <br/> EN: Optional information about the trigger of the command.

            '
          $ref: '#/components/schemas/PersonName'
    VariableIncomeBreakdown:
      type: object
      description: 'DE: Details über regelmäßige Einnahmen <br/>

        EN: Breakdown of the periodical income.

        '
      properties:
        bonus:
          $ref: '#/components/schemas/BonusIncome'
        shift:
          description: 'DE: Zusätzliches regelmäßiges Einkommen durch Nacht-/Schichtzuschlag. <br/>

            EN: Additional periodical income through night-/shift allowance.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        overtime:
          description: 'DE: Zusätzliches regelmäßiges Einkommen durch Überstunden. <br/>

            EN: Additional periodical income through overtime allowance.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        travelAllowance:
          description: 'DE: Zusätzliches regelmäßiges Einkommen durch Spesen/Reisekostenbeihilfe. <br/>

            EN: Additional periodical income through travel allowance.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        commission:
          description: 'DE: Zusätzliches regelmäßiges Einkommen durch Provisionen. <br/>

            EN: Additional periodical income through commission allowance.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    CalculationContextComponent:
      type: object
      properties:
        type:
          readOnly: true
          $ref: '#/components/schemas/LoanType'
        loanId:
          $ref: '#/components/schemas/LoanId'
    NationalityTypeKey:
      type: string
      description: 'DE: Art der Staatsbürgerschaft (nicht abschließende Aufzählung, zum Beispiel FIRST = Erste Staatsbürgerschaft, SECOND = Zweite Staatsbürgerschaft). <br/> EN: Open ended enum contains values for the Nationality, possible values are (FIRST, SECOND, THIRD).

        '
      x-extensible-enum:
      - FIRST
      - SECOND
      - THIRD
    AuctionInfo:
      type: object
      description: 'DE: Information zur Immobilienauktion. <br/> EN: Information about the estate auction.

        '
      properties:
        auctionDate:
          description: 'DE: Auktionsdatum. <br/>

            EN: Auction date.

            '
          $ref: '#/components/schemas/ISODate'
        auctionMaxBid:
          description: 'DE: Höchstes Auktionsgebot. <br/>

            EN: Highest auction bid.

            '
          $ref: '#/components/schemas/EuroAmount'
        bidAccepted:
          description: 'DE: Flag ob das Angebot schon angenommen wurde. <br/>

            EN: Indicates if the bid is already accepted.

            '
          type: boolean
          nullable: true
    VentureRelevantLoan:
      type: object
      required:
      - amount
      - type
      description: 'DE: Information über Darlehen die zu Hypothek hinzugefügt werden. <br/>

        EN: Information about existing loans added to the mortgage.

        '
      properties:
        debtId:
          description: 'DE: Id der dazugehörenden Schulden.


            Die Schulden können mit Hilfe des /v2/financing-applications/{financingApplicationId}/financial-standings/existing-loans/{debtId} abgefragt werden. <br/>


            EN: Id of the associated Debt.


            Debt can be accessed via the respective endpoint. */v2/financing-applications/{financingApplicationId}/financial-standings/existing-loans/{debtId}*

            '
          $ref: '#/components/schemas/DebtId'
        amount:
          description: 'DE: Darlehenssumme. <br/>

            EN: Loan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        type:
          $ref: '#/components/schemas/VentureRelevantLoanType'
        until:
          description: 'DE: Ablauf Sollzinsbindung. <br/>

            EN: Fixed interest rate expiry date.

            '
          $ref: '#/components/schemas/ISODate'
        description:
          description: 'DE: Beschreibung für bestehende Darlehen. <br/>

            EN: Description of the existing loan.

            '
          type: string
        contractNumber:
          type: string
          description: Contract number.
        burden:
          description: 'DE: Periodische Rate (z.B. monatliche Rate). <br/> EN: Periodical payment amount (e.g. rate per month).

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        debtor:
          description: The existing mortgage saving plan bank.
          $ref: '#/components/schemas/Debitor'
    RentInfo:
      type: object
      description: 'DE: Information über die Vermietung. <br/> EN: Rent information.

        '
      properties:
        sustainableRent:
          description: 'DE: Nachhaltige Miete pro qm. <br/>

            EN: Sustainable rent per square meter.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmountPerSquareMeter'
        expectedRent:
          description: 'DE: Erwartete Gesamtnettokaltmiete. <br/>

            EN: Expected total net cold rent.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        expectedRentCommercial:
          description: 'DE: Erwartete gewerbliche Nettokaltmiete. <br/>

            EN: Expected commercial net cold rent.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        expectedRentResidential:
          description: 'DE: Erwartete Nettokaltmiete wohnwirtschaftlich. <br/>

            EN: Expected residential net cold rent.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        garageRent:
          description: 'DE: Miete für Garage / Stellplatz. <br/>

            EN: Rent for garage / parking space.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    VentureRelevantLoanType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/VentureRelevantLoanTypeKey'
    ClientAdvisor:
      type: object
      description: 'DE: Informationen über den Endkundenberater. <br/> EN: Information about the customer sales advisor.

        '
      required:
      - userId
      properties:
        userId:
          $ref: '#/components/schemas/ClientAdvisorId'
        personName:
          $ref: '#/components/schemas/PersonName'
        contact:
          $ref: '#/components/schemas/Contact'
    SubmissionCounterOfferId:
      type: object
      required:
      - value
      description: 'DE: ID vom Gegenangebot. EN: Id of the counter offer.

        '
      properties:
        value:
          type: string
    RefuseSignContractReasonKey:
      type: string
      description: 'DE: Grund für die Ablehnung des Vertrags, mögliche Werte sind NOTARY_APPOINTMENT_UNAVAILABLE=Notartermin kann nicht rechtzeitig stattfinden, OBJECT_UNAVAILABLE=Objekt hat sich zerschlagen, VENTURE_UNAVAILABLE=Vorhaben hat sich zerschlagen, CUSTOMER_DECIDED_DIFFERENT_PROVIDER=Kunde hat sich für einen anderen Finanzierungspartner entschieden, NO_CUSTOMER_INTEREST=Kunde hat sich nicht mehr gemeldet, OTHER=Nicht aufgeführter Grund EN: Reason for refusing contract, possible values are NOTARY_APPOINTMENT_UNAVAILABLE, OBJECT_UNAVAILABLE, VENTURE_UNAVAILABLE, CUSTOMER_DECIDED_DIFFERENT_PROVIDER, NO_CUSTOMER_INTEREST, OTHER

        '
      x-extensible-enum:
      - NOTARY_APPOINTMENT_UNAVAILABLE
      - OBJECT_UNAVAILABLE
      - VENTURE_UNAVAILABLE
      - CUSTOMER_DECIDED_DIFFERENT_PROVIDER
      - NO_CUSTOMER_INTEREST
      - OTHER
    BasePropertyRegisterOwner:
      type: object
      description: 'DE: Information über den Eigentümer. <br/>

        EN: Information about property owner.

        '
      required:
      - type
      properties:
        type:
          description: 'DE: Eigentümertyp. <br/>

            EN: Owner type.

            '
          type: string
          x-extensible-enum:
          - APPLICANT
          - THIRD_PERSON
      discriminator:
        propertyName: type
    BaseBridgingLoanDetails:
      type: object
      required:
      - neededAmount
      - reason
      description: 'DE: Information zur Zwischenfinanzierung. <br/> EN: Details about bridging loan.

        '
      properties:
        reason:
          type: string
          description: 'DE: Grund für die Zwischenfinanzierung (nicht abschließende Aufzaehlung), z.B. OPEN_PROPERTY_SALE, CLOSED_PROPERTY_SALE, UNAVAILABLE, PUBLIC_PRE_FINANCE, EXISTING_BUILDING_SAVING_PLAN. <br/> EN: Open ended enum contains bridging loan debt reason, possible values are OPEN_PROPERTY_SALE, CLOSED_PROPERTY_SALE, UNAVAILABLE, PUBLIC_PRE_FINANCE, EXISTING_BUILDING_SAVING_PLAN.

            '
          example: OPEN_PROPERTY_SALE
          x-extensible-enum:
          - OPEN_PROPERTY_SALE
          - CLOSED_PROPERTY_SALE
          - UNAVAILABLE
          - PUBLIC_PRE_FINANCE
          - EXISTING_BUILDING_SAVING_PLAN
        neededAmount:
          description: 'DE: Zwischenfinanzierungsbetrag. <br/>

            EN: Bridging loan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        equityAvailabilityDate:
          description: 'DE: Verfügbarkeit des Kapitals. <br/>

            EN: Bridging loan availability date.

            '
          $ref: '#/components/schemas/ISODate'
      discriminator:
        propertyName: reason
    SubmissionRevokedStatus:
      type: object
      description: 'EN: Status containing information about revocation

        '
      required:
      - type
      - revocation
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        reason:
          type: string
          description: 'EN: Revocation reason

            '
        reasonDescription:
          type: string
          description: 'EN: Short description of the revocation reason

            '
        reasonType:
          $ref: '#/components/schemas/SubmissionRevokedReasonType'
        revokedOn:
          $ref: '#/components/schemas/ISODate'
    OwnershipInventory:
      description: 'DE: Eigentum an einem Gründstück/Objekt. <br/> EN: Ownership of a property.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BasePropertiesRegisterInventory'
      properties:
        inventoryUnitProperties:
          description: 'DE: Sammlung von Sondereigentümen (https://de.wikipedia.org/wiki/Sondereigentum) die mit diesem Miteigentum verbunden sind. <br/> EN: Collection of special properties (inventory units) associated with this co-ownership.

            '
          type: array
          items:
            $ref: '#/components/schemas/InventorySpecialProperty'
    HouseUtilityUnitGroups:
      type: object
      description: 'DE: Detail zu beschreibenden Wohneinheiten. Die Beschreibung der Wohneinheiten erfolgt in Gruppen. <br/>

        EN: Detail to be described residential units. The residential units can be described in groups.

        '
      properties:
        numberOfUnitGroups:
          type: integer
          format: int32
        breakdown:
          $ref: '#/components/schemas/HouseUtilityUnitGroupsBreakdown'
    PayoutInfo:
      type: object
      description: 'DE: Information zur Auszahlung des Darlehens. <br/> EN: Loan payout information.

        '
      properties:
        firstPayout:
          description: 'DE: Datum der ersten Teilauszahlung. <br/>

            EN: First payout date.

            '
          $ref: '#/components/schemas/ISODate'
        freeAllocationPeriod:
          description: 'DE: Bereitstellungszinsfreie Zeit. <br/>

            EN: Interest free period.

            '
          $ref: '#/components/schemas/Duration'
        payoutRate:
          description: 'DE: Auszahlungskurs. <br/>

            EN: Payout rate.

            '
          $ref: '#/components/schemas/Percentage'
    PreSubmissionCheckId:
      type: object
      description: 'An Id refers to a specific pre submission check resource.

        '
      properties:
        value:
          type: string
    PhoneType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/PhoneTypeKey'
    FinancingApplicationReason:
      type: string
      description: 'DE: Finanzierungsgründe (nicht abschließende Aufzählung), z.B. BUY_NEW, BUY_EXISTING, BUILD, REFINANCE, RENOVATE, RAISE_CAPITAL. <br/> EN: Open ended enum contains type of the financing reason, possible values are BUY_NEW, BUY_EXISTING, BUILD, REFINANCE, RENOVATE, RAISE_CAPITAL.

        '
      example: BUY_EXISTING
      x-extensible-enum:
      - BUY_NEW
      - BUY_EXISTING
      - BUILD
      - REFINANCE
      - RENOVATE
      - RAISE_CAPITAL
    IntentId:
      type: object
      description: 'DE: IntentId aus dem externen System. <br/> EN: IntentId in the external system.

        '
      properties:
        value:
          type: string
    PeriodicalEuroAmountPerSquareMeter:
      description: 'DE: Euro Betrag pro Quadratmeter in einem bestimmten Zeitraum. <br/> EN: Euro amount per square meter for a specific period.

        '
      type: object
      required:
      - periodicalAmount
      properties:
        periodicalAmount:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    SelfEmploymentIncomeMethod:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/SelfEmploymentIncomeMethodKey'
    SubmissionStatus:
      oneOf:
      - $ref: '#/components/schemas/SubmissionRejectedStatus'
      - $ref: '#/components/schemas/ContractDeliveredStatus'
      - $ref: '#/components/schemas/ContractSignedStatus'
      - $ref: '#/components/schemas/SubmissionDefaultStatus'
      - $ref: '#/components/schemas/SubmissionAwaitExternalProcessingStatus'
      - $ref: '#/components/schemas/SubmissionRevokedStatus'
      - $ref: '#/components/schemas/SubmissionCounterOfferCreatedStatus'
      - $ref: '#/components/schemas/SubmissionCounterOfferRejectedStatus'
      - $ref: '#/components/schemas/SubmissionCounterOfferRevokedStatus'
      - $ref: '#/components/schemas/SubmissionProcessingPausedStatus'
      - $ref: '#/components/schemas/SubmissionContractSignRefusedStatus'
      - $ref: '#/components/schemas/SubmissionContractCanceledStatus'
      - $ref: '#/components/schemas/ConfirmedSubmissionStatus'
      discriminator:
        propertyName: type
        mapping:
          REJECTED: '#/components/schemas/SubmissionRejectedStatus'
          CONTRACT_DELIVERED: '#/components/schemas/ContractDeliveredStatus'
          CONTRACT_SIGNED: '#/components/schemas/ContractSignedStatus'
          INWORK: '#/components/schemas/SubmissionDefaultStatus'
          APPROVED: '#/components/schemas/SubmissionDefaultStatus'
          REJECTION_REVOKED: '#/components/schemas/SubmissionDefaultStatus'
          AWAIT_EXTERNAL_PROCESSING: '#/components/schemas/SubmissionAwaitExternalProcessingStatus'
          CREATED: '#/components/schemas/SubmissionDefaultStatus'
          SUBMITTED: '#/components/schemas/SubmissionDefaultStatus'
          AVAILABLE_FOR_DECISION: '#/components/schemas/SubmissionDefaultStatus'
          REVOKED: '#/components/schemas/SubmissionRevokedStatus'
          COUNTER_OFFER_CREATED: '#/components/schemas/SubmissionCounterOfferCreatedStatus'
          COUNTER_OFFER_ACCEPTED: '#/components/schemas/SubmissionDefaultStatus'
          COUNTER_OFFER_REJECTED: '#/components/schemas/SubmissionCounterOfferRejectedStatus'
          COUNTER_OFFER_REVOKED: '#/components/schemas/SubmissionCounterOfferRevokedStatus'
          PROCESSING_PAUSED: '#/components/schemas/SubmissionProcessingPausedStatus'
          CONTRACT_SIGN_REFUSED: '#/components/schemas/SubmissionContractSignRefusedStatus'
          CONTRACT_CANCELED: '#/components/schemas/SubmissionContractCanceledStatus'
          CONFIRMED: '#/components/schemas/ConfirmedSubmissionStatus'
          REJECTED_AND_CLOSED: '#/components/schemas/SubmissionDefaultStatus'
    SubmissionCounterOfferRejectedStatus:
      type: object
      description: 'EN: Status containing information about counteroffer that was rejected

        '
      required:
      - type
      - reason
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        reason:
          $ref: '#/components/schemas/RejectSubmissionCounterOfferReason'
    DebtExpense:
      type: object
      description: 'DE: Details über bereits existierende Kreditausgaben. <br/>

        EN: Information about periodical expenses associated with existing loans.

        '
      required:
      - debtId
      - burden
      properties:
        debtId:
          $ref: '#/components/schemas/DebtId'
        burden:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    CounterOfferLoan:
      oneOf:
      - $ref: '#/components/schemas/CounterOfferMainLoan'
      - $ref: '#/components/schemas/CounterOfferKfwLoan'
      - $ref: '#/components/schemas/CounterOfferAuxiliaryLoan'
      discriminator:
        propertyName: type
        mapping:
          MAIN_LOAN: '#/components/schemas/CounterOfferMainLoan'
          KFW_PROMOTION_LOAN: '#/components/schemas/CounterOfferKfwLoan'
          AUXILIARY_LOAN: '#/components/schemas/CounterOfferAuxiliaryLoan'
    PropertyRegisterInventoryId:
      type: object
      required:
      - id
      description: 'DE: Laufende Nummer eines Grundstücks/Eigentum. <br/> EN: Serial number of the property.

        '
      properties:
        id:
          type: string
    ProcessorDetails:
      description: details of loan partner processor
      type: object
      required:
      - loanPartnerId
      properties:
        name:
          $ref: '#/components/schemas/PersonName'
        loanPartnerId:
          $ref: '#/components/schemas/CompanyId'
        contact:
          $ref: '#/components/schemas/Contact'
    Handover:
      type: object
      description: 'DE: Beratunsprotokoll und Empfehlung des Beraters. <br/> EN: Advisor Handover notes and recommendations.

        '
      properties:
        hints:
          type: string
          description: 'DE: Hinweise des Beraters. <br/> EN: Hints provided by the financing advisor.

            '
        documents:
          description: Link to retrieve list of handover documents
          $ref: '#/components/schemas/ResourceRef'
          example: https://api.interhyp.de/submission/v2/submissions/de-20230424-krczwx6-5sves/handover-documents
        handoverReports:
          deprecated: true
          description: '@deprecated: Please use field documents to get list of handover documents

            '
          type: array
          items:
            $ref: '#/components/schemas/HandoverReport'
    FinancialVentureItem:
      type: object
      description: 'DE: Relevante Information zu dem geplanten Finanziehrungsvorhaben. <br/>

        EN: Information about planed financing venture.

        '
      required:
      - _href
      - reason
      - mortgageProperty
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        reason:
          $ref: '#/components/schemas/FinancingApplicationReason'
        mortgageProperty:
          description: 'DE: Referenz zum Beleihungsobjekt/Finanzierungsobjekt auf welches sich das Finanzierungsvorhaben bezieht. <br/> EN: The Financing Asset / Property to which the financing venture relates.

            '
          $ref: '#/components/schemas/EstateRef'
        mainApplicant:
          description: 'DE: Referenz zum Hauptantragssteller auf den sich das Finanzierungsvorhaben bezieht. <br/> EN: Reference to the financing process related main applicant.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        embedded:
          description: 'DE: Komplette Information über das Finanzierungsvorhaben. <br/>

            EN: Complete information about the financing venture.

            '
          $ref: '#/components/schemas/FinancingVenture'
    HouseholdsQuery:
      type: object
      description: 'A wrapper Type to hold a set of households associated with the financing application.

        '
      properties:
        data:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Household'
    Utilization:
      description: 'DE: Wrapper für Nutzung des Ojektes <br/> EN: Wrapper for utilization of the property.

        '
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/UtilizationKey'
    AdditionalFields:
      description: 'DE: Zusätzliche Felder. <br/> EN: Additional fields.

        '
      type: object
      properties:
        fields:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalField'
    PreInquiryId:
      type: object
      description: 'DE: ID des Voranfrage. <br/> EN: PreInquiry identifier.

        '
      properties:
        value:
          type: string
    PropertyRegisterOwnerEntry:
      type: object
      description: 'DE: Eigentümer (Eintrag aus der zweiten Abteilung des Grundbuchblattes). <br/> EN: Owner (entry from the second section of the land register sheet).

        '
      properties:
        owners:
          description: 'DE: Sammlung von Eigentümer eines Grundstücks. EN: Collection of owners of the property.

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterOwner'
        inventories:
          description: 'DE: Referenzen zu den Einträgen im Bestandsverzeichnis. <br/> EN: References to the entries in the inventory.

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterInventoryId'
    HouseUnitCommercialUsage:
      type: object
      properties:
        commerceType:
          $ref: '#/components/schemas/HouseUnitCommerceType'
        description:
          type: string
    Salary:
      type: object
      required:
      - net
      description: 'DE: Informationen über das Gehalt. <br/> EN: Information regarding salary.

        '
      properties:
        gross:
          description: 'DE: Regelmäßiges Lohn und Gehalt (brutto). <br/>

            EN: Periodical gross salary.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        net:
          description: 'DE: Regelmäßiges Lohn und Gehalt (netto). <br/>

            EN: Periodical net salary.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        numberOfPayments:
          type: number
          format: double
          description: 'DE: Anzahl an Gehaltszahlungen. <br/> EN: Number of payments

            '
        assuredNumber:
          type: number
          format: double
          description: 'DE: Vertraglich zugesicherte Gehaltszahlungen (wenn numberOfPayments > 12). <br/> EN: Annually secured number of salaries as per employment contract (if numberOfPayments > 12)

            '
    OwnEstateFinancingDetails:
      description: 'DE: Finanzierungsdetails über das Finanzierungvorhaben der bereits besessenen Immobilie. <br/>

        EN: Financing details about financing process associated with already owned property.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseFinancingDetails'
      properties:
        acquisitionYear:
          description: 'DE: Jahr der Zahlung / Jahr der Fertigstellung. <br/> EN: Purchase / completion year.

            '
          $ref: '#/components/schemas/Year'
    FinancialStandingType:
      type: string
      description: 'DE: Finanzstatus (nicht abschließende Aufzählung), z.B. (EQUITY, DEBT, INCOME, EXPENSE). <br/> EN: Open ended enum contains possible types financial standing, possible values are (EQUITY, DEBT, INCOME, EXPENSE).

        '
      example: EQUITY
      x-extensible-enum:
      - EQUITY
      - DEBT
      - INCOME
      - EXPENSE
    HouseUnitCommerceTypeKey:
      type: string
      description: 'DE: Mögliche Gewerbearten. z.B. RETAIL, MEDICAL_PRACTICE, etc..  <br/> EN: Open ended enum contains commerce business line , possible values are (RETAIL, MEDICAL_PRACTICE, etc..).

        '
      x-extensible-enum:
      - RETAIL
      - MEDICAL_PRACTICE
      - OFFICE
      - WORKSHOP
      - WAREHOUSE
      - GASTRONOMY
      - HOTEL
      - VIDEO_STORE
      - NIGHT_CLUB
      - EROTIC
      - GAS_STATION
      - BETTING_SHOP
      - FITNESS_STUDIO
      - TAXI
      - TRANSPORT
      - CONSTRUCTION
      - BARBAR
      - OTHER
      - UNKNOWN
    BaseCounterOfferRateDetails:
      type: object
      required:
      - rateType
      - interestRate
      - amortisationRate
      properties:
        rateType:
          $ref: '#/components/schemas/RateDetailsType'
        interestRate:
          $ref: '#/components/schemas/InterestRate'
      discriminator:
        propertyName: rateType
    LendingValueCalculation:
      description: 'DE: Information zu der Kalkulation <br/>

        EN: Information about the calculation.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseCalculation'
      properties:
        lendingValue:
          $ref: '#/components/schemas/LoanQuota'
        details:
          type: array
          items:
            $ref: '#/components/schemas/CalculationDetail'
    AdvisoryDetails:
      type: object
      required:
      - clientAdvisor
      - broker
      - brokeragePlatform
      description: 'DE: Informationen über die Beratung. <br/>

        EN: Information about the involved parties in the consultation phase

        '
      properties:
        clientAdvisor:
          description: 'DE: Daten des Endkundekontakt. <br/>

            EN: Information about the client contact person.

            '
          $ref: '#/components/schemas/ClientAdvisor'
        subBrokers:
          type: array
          description: 'DE: Untervermittler des Antrags. <br/>

            EN: sub brokers.

            '
          items:
            $ref: '#/components/schemas/OrganizationUser'
        broker:
          description: 'DE: Daten des Vermittlers. <br/>

            EN: Information about the main Broker (Interhp, Prohyp, MLP Hyp or Prohyp-WhiteLabel-Partner).

            '
          $ref: '#/components/schemas/OrganizationUser'
        brokeragePlatform:
          description: 'DE: Vermittlerplattform. <br/>

            EN: Brokerage Platform

            '
          $ref: '#/components/schemas/BrokeragePlatform'
    ResponsiblePersonTypeKey:
      type: string
      description: 'DE: Rolle der zuständigen Person (nicht abschließende Aufzählung), z.B. (PROCESSOR=Ansprechpartner, MANAGER=Führungskraft). <br/> EN: Open ended enum contains the role of the responsible person , possible values are (PROCESSOR, MANAGER)

        '
      x-extensible-enum:
      - PROCESSOR
      - MANAGER
    ExternalId:
      type: object
      description: 'DE: Daten-Identifikator aus dem externen System. <br/> EN: Data identifier in the external system.

        '
      properties:
        value:
          type: string
    SubmissionContractSignRefusedStatus:
      type: object
      description: 'EN: Status containing information about refusing to sign the contract

        '
      required:
      - type
      - refuseReason
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        refuseReason:
          $ref: '#/components/schemas/RefuseSignContractReason'
    RevokeSubmissionCommand:
      description: This command is only used for internal purposes!
      type: object
      required:
      - reason
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        reason:
          $ref: '#/components/schemas/SubmissionRevokedReason'
        remark:
          type: string
    FinancingApplication:
      type: object
      required:
      - id
      - applicants
      - venture
      - financialStanding
      - estates
      properties:
        id:
          $ref: '#/components/schemas/FinancingApplicationId'
        status:
          $ref: '#/components/schemas/FinancingApplicationStatus'
        subType:
          $ref: '#/components/schemas/ApplicationSubType'
        applicantRelationships:
          $ref: '#/components/schemas/ApplicantRelationships'
        applicants:
          $ref: '#/components/schemas/Applicants'
        households:
          $ref: '#/components/schemas/Households'
        estates:
          $ref: '#/components/schemas/Estates'
        financialStanding:
          $ref: '#/components/schemas/FinancialStandings'
        venture:
          $ref: '#/components/schemas/FinancialVentureItem'
        consultation:
          $ref: '#/components/schemas/ConsultationItem'
        consultationInfo:
          $ref: '#/components/schemas/ConsultationInfo'
        offer:
          $ref: '#/components/schemas/FinancingOfferItem'
    SubmissionDataViolationSeverity:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/SubmissionDataViolationSeverityKey'
    PeriodicalCreditEntry:
      type: object
      allOf:
      - $ref: '#/components/schemas/EntryPeriod'
      - $ref: '#/components/schemas/CreditEntry'
    BuildingRepaymentPlan:
      type: object
      description: The repayment plan of the credit phase.
      required:
      - entries
      - entriesAggregated
      properties:
        entries:
          description: The array of credit entries (Tilgungsplan).
          type: array
          items:
            $ref: '#/components/schemas/ExtendedPeriodicalCreditEntry'
        entriesAggregated:
          $ref: '#/components/schemas/CreditEntry'
    FinancingApplicationStatusKey:
      type: string
      description: 'DE: Status des Finanzierungsantrages. <br/> EN: Status of the application.

        '
      x-extensible-enum:
      - QUALIFIED_FOR_SUBMISSION
      - SUBMITTED
    ResidualDebtProtectionType:
      type: string
      description: 'DE: Art der Restschuldabsicherung (nicht abschließende Aufzählung), z.B. BUILDING_SAVING_PLAN. <br/> EN: Open ended enum contains possible residual debt protection types, possible values are BUILDING_SAVING_PLAN.

        '
      example: BUILDING_SAVING_PLAN
      x-extensible-enum:
      - BUILDING_SAVING_PLAN
    CancelContractReasonKey:
      type: string
      description: 'DE: Grund für die Vertragskündigung, mögliche Werte sind NOTARY_APPOINTMENT_UNAVAILABLE=Notartermin kann nicht rechtzeitig stattfinden, OBJECT_UNAVAILABLE=Objekt hat sich zerschlagen, VENTURE_UNAVAILABLE=Vorhaben hat sich zerschlagen, CUSTOMER_DECIDED_DIFFERENT_PROVIDER=Kunde hat sich für einen anderen Finanzierungspartner entschieden, NO_CUSTOMER_INTEREST=Kunde hat sich nicht mehr gemeldet, OTHER=Nicht aufgeführter Grund EN: Reason for canceling contract, possible values are NOTARY_APPOINTMENT_UNAVAILABLE, OBJECT_UNAVAILABLE, VENTURE_UNAVAILABLE, CUSTOMER_DECIDED_DIFFERENT_PROVIDER, NO_CUSTOMER_INTEREST, OTHER

        '
      x-extensible-enum:
      - NOTARY_APPOINTMENT_UNAVAILABLE
      - OBJECT_UNAVAILABLE
      - VENTURE_UNAVAILABLE
      - CUSTOMER_DECIDED_DIFFERENT_PROVIDER
      - NO_CUSTOMER_INTEREST
      - OTHER
    InformerId:
      type: object
      required:
      - value
      description: 'DE: ID des Zuträgers. <br/> EN: Informer id.

        '
      properties:
        value:
          type: string
    Furnishing:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/FurnishingKey'
    LeaseInfo:
      type: object
      description: 'DE: Information über ein Erbbaurecht. <br/> EN: Estate leasehold information.

        '
      required:
      - leasehold
      properties:
        leasehold:
          description: 'DE: Flag ob Erbbaurecht vorhanden ist. <br/> EN: Flag to indicate if leasehold exists.

            '
          type: boolean
      discriminator:
        propertyName: leasehold
        mapping:
          true: '#/components/schemas/LeaseHold'
          false: '#/components/schemas/NoLeaseHold'
    BaseUnionInfo:
      type: object
      description: 'DE: Informationen zu Verbands- bzw. Gewerkschaftszugehörigkeit EN: Information regarding union membership

        '
      required:
      - membershipId
      - organisation
      properties:
        organisation:
          type: string
          description: 'DE: Gewerkschafts-Verband <br/>

            EN: union organisation

            '
          x-extensible-enum:
          - VERDI
          - IG_BAU
          - NGG
          - DBB
          - DBWV
          - THW_NRW
          - OTHER
        membershipId:
          type: string
          maxLength: 100
          description: 'DE: Mitgliedsnummer in der Gewerkschaft. EN: membership id for the union.

            '
      discriminator:
        propertyName: organisation
    BridgingFinancingMainProduct:
      type: object
      description: 'DE: Information zur Zwischenfinanzierung im Annuitätendarlehen. <br/> EN: Information on the bridging financing product in the annuity product.

        '
      allOf:
      - $ref: '#/components/schemas/BaseMainProduct'
      properties:
        details:
          $ref: '#/components/schemas/BridgingLoanDetails'
    FinancingVentureOtherCapitalFinancing:
      description: 'DE: Information über das Finanzierungsvorhaben bei der Kapitalbeschaffung. <br/>

        EN: Information about the financing venture for capital raising goal.

        '
      required:
      - financingNeed
      - financingDetails
      allOf:
      - $ref: '#/components/schemas/BaseFinancingVenture'
      properties:
        financingNeed:
          $ref: '#/components/schemas/OwnEstateFinancingNeed'
        financingDetails:
          $ref: '#/components/schemas/FinancingDetails'
    PlanTemplate:
      type: string
      description: 'Describes the repayment plan template based on the conditions of the corresponding loan. - standard: until the end of the fixed interest rate - lifetime: until full repayment - variable_12: 12 months for loans with variable interest rate

        '
      x-extensible-enum:
      - STANDARD
      - LIFETIME
      - VARIABLE_12
    AdvisorCommandTrigger:
      writeOnly: true
      type: object
      required:
      - advisor
      allOf:
      - $ref: '#/components/schemas/BaseCommandTrigger'
      properties:
        advisor:
          $ref: '#/components/schemas/Advisor'
    ConditionCalculation:
      description: 'DE: Information über Konditionskalkulation. <br/>

        EN: Information about condition calculation.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseCalculation'
      properties:
        loan:
          $ref: '#/components/schemas/LoanConditionGeneralInfo'
        details:
          type: array
          items:
            $ref: '#/components/schemas/LoanConditionDetail'
    EntryPeriod:
      type: object
      description: The date object for a cashflow entry.
      required:
      - period
      properties:
        period:
          description: Period in either day, month, year or quarter format, eg. 2021-08-01, 2021-08, 2021 or 2021-Q3
          pattern: ^(\d{4}-\d{2}-\d{2})|(\d{4}-\d{2})|(\d{4})|(\d{4}-(Q\d))$
          type: string
    ContractSignedStatus:
      type: object
      description: 'EN: Status containing information about signed contract

        '
      required:
      - type
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        contractSignDate:
          $ref: '#/components/schemas/ISODate'
        contracts:
          type: array
          items:
            $ref: '#/components/schemas/ExtendedContractInfo'
    HousingSituationKey:
      type: string
      description: 'DE: Art der derzeitigen Wohnsituation (nicht abschließende Aufzaehlung), z.B. (RENT=zur Miete, RATE=im Eigentum mit Darlehensrate, DEBT_FREE=im abbezahlten Eigentum, PARENTS=mietfrei bei den Eltern/Partner, OWN_PROPERTY=im Eigentum, FIRST_APPLICANT=in einer Eigentumswohnung). <br/> EN: Open ended enum contains value for the current housing/accomodation types, possible values are (RENT, RATE, DEBT_FREE, PARENTS, OWN_PROPERTY, FIRST_APPLICANT).

        '
      example: RENT
      x-extensible-enum:
      - RENT
      - RATE
      - DEBT_FREE
      - PARENTS
      - OWN_PROPERTY
      - FIRST_APPLICANT
      - OTHER
    ModernisationScope:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ModernisationScopeKey'
    PropertyRegisterOwnerThirdPerson:
      type: object
      allOf:
      - $ref: '#/components/schemas/BasePropertyRegisterOwner'
      properties:
        fullName:
          type: string
        person:
          $ref: '#/components/schemas/Person'
    PropertyRegisterRestriction:
      description: 'DE: Lasten und Beschränkungen (Eintrag aus der zweiten Abteilung des Grundbuchblattes). <br/> EN: Loads and restrictions (entry from the second section of the land register sheet).

        '
      type: object
      properties:
        inventories:
          description: 'DE: Referenzen zu den Einträgen im Bestandsverzeichnis. <br/> EN: References to the entries in the inventory.

            '
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegisterInventoryId'
        restriction:
          description: 'DE: Beschreibung der Lasten und Beschränkungen. <br/> EN: Description of burdens and restrictions.

            '
          type: string
        isRestricted:
          description: 'DE: Flag, um anzugeben, ob die Eigenschaft eingeschränkt ist. <br/> EN: Flag to indicate whether property is restricted.

            '
          type: boolean
        effectiveAfterMortgages:
          description: 'DE: Tritt die Last/Beschränkung im Rang zurück. D. h. indiziert ob eine mögliche Grundschuld im Rang vor dieser Last/Beschränkung steht <br/> EN: Resets the burden/limitation in rank. I.e. indicates if there is a possible land charge ranking before this burden/restriction.

            '
          type: boolean
          nullable: true
    RevokeSubmissionCounterOfferCommand:
      type: object
      description: command to revoke a counter offer.
      required:
      - counterOfferId
      - reason
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        counterOfferId:
          $ref: '#/components/schemas/SubmissionCounterOfferId'
        reason:
          $ref: '#/components/schemas/RevokeSubmissionCounterOfferReason'
        remark:
          type: string
    PropertyLocation:
      description: 'DE: Information über die Lage der Immobilie. <br/> EN: Information about the estate location.

        '
      type: object
      properties:
        neighbourhood:
          $ref: '#/components/schemas/Neighbourhood'
        negativeEffectsInNeighbourhood:
          description: 'DE: Sammlung von negativen Einflussfaktoren in der Umgebung. <br/>

            EN: Collection of negative effects caused by location.

            '
          type: array
          example: 'DE: Liegt in unmittelbarer Nähe einer Autobahn. <br/> EN: Lies in close distance of a highway.

            '
          items:
            type: string
          x-is-plural: true
        locationInhabitants:
          description: 'DE: Einwohnerzahl. <br/> EN: Number of inhabitants.

            '
          $ref: '#/components/schemas/Inhabitants'
    PreInquiry:
      type: object
      properties:
        preInquiryId:
          $ref: '#/components/schemas/PreInquiryId'
        createdAt:
          $ref: '#/components/schemas/ISODateTime'
        status:
          $ref: '#/components/schemas/PreInquiryStatus'
    PropertyRegisterOwnerApplicant:
      type: object
      required:
      - applicant
      allOf:
      - $ref: '#/components/schemas/BasePropertyRegisterOwner'
      properties:
        applicant:
          $ref: '#/components/schemas/ApplicantIdRef'
    PlannedModernisation:
      type: object
      description: 'DE: Information über die geplante Modernisierungen. <br/>

        EN: Information about planed modernisations.

        '
      required:
      - planedCosts
      properties:
        modernisationTypeAndScope:
          $ref: '#/components/schemas/ModernisationTypeAndScope'
        planedCosts:
          description: 'DE: Geplanten Modernisierungskosten. <br/>

            EN: Planed modernisation costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        valueAddingCosts:
          description: 'DE: Kosten für die wertsteigernden Modernisierungsmaßnahmen. <br/>

            EN: Costs associated with value adding modernisations.

            '
          $ref: '#/components/schemas/EuroAmount'
        kfwRelevant:
          type: boolean
          nullable: true
          description: 'DE: KFW Förderungsrelevante Modernisierung<br/> EN: modernisation has an impact on KfW subsidies

            '
        modernisationDetails:
          type: array
          items:
            $ref: '#/components/schemas/PlannedModernisationDetails'
    FinancingApplicationId:
      description: 'DE: ID des Finanzierungsantrages <br/> EN: Financing Application identifier

        '
      type: object
      required:
      - value
      properties:
        value:
          type: string
    UnavailableEquity:
      type: object
      required:
      - investmentType
      - investmentAmount
      description: 'DE: Information zur Zwischenfinanzierung in Zusammenhang mit nicht verfügbaren Eigenkapital. <br/> EN: Bridging Debt associated with unavailable equity

        '
      allOf:
      - $ref: '#/components/schemas/BaseBridgingLoanDetails'
      properties:
        investmentType:
          description: 'DE: Art der Kapitalbeteiligung. <br/> EN: Type of the equity investment.

            '
          type: string
        investmentCompany:
          description: 'DE: Unternehmen in welches das Kapital investiert wurde. <br/> EN: Company in which the equity is invested.

            '
          type: string
        investmentAmount:
          description: 'DE: Investionsbetrag. <br/>

            EN: Investment amount.

            '
          $ref: '#/components/schemas/EuroAmount'
    BaseCounterOfferLoan:
      type: object
      description: 'DE: Information zum Gegenangebot Darlehen. <br/> EN: Information about the counter offer loan.

        '
      required:
      - id
      - type
      - amount
      - maturity
      - specialRepayment
      - commission
      properties:
        id:
          $ref: '#/components/schemas/LoanId'
        type:
          $ref: '#/components/schemas/LoanType'
        amount:
          description: 'DE: Darlehnsbetrag (per Tranche). <br/>

            EN: Loan amount (for loan component).

            '
          $ref: '#/components/schemas/EuroAmount'
        maturity:
          $ref: '#/components/schemas/InterestMaturity'
        specialRepayment:
          $ref: '#/components/schemas/SpecialRepayment'
        commission:
          $ref: '#/components/schemas/CommissionInfo'
        commitmentInterest:
          description: 'DE: Bereitstellungszins. <br/> EN: Periodical commitment interest rate.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
      discriminator:
        propertyName: type
    ApartmentFloor:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ApartmentFloorKey'
    LoanId:
      type: object
      description: 'DE: ID des Darlehens. <br/> EN: Loan identifier.

        '
      properties:
        value:
          type: string
    CancelContractSubmissionCommand:
      description: command to cancel a signed contract of a submission on behalf of the customer.
      type: object
      required:
      - reason
      - cancellationDate
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        reason:
          $ref: '#/components/schemas/CancelContractReason'
        remark:
          type: string
        cancellationDate:
          $ref: '#/components/schemas/ISODate'
    ConfirmedSubmissionStatus:
      type: object
      description: 'EN: Status containing information about confirming the submission

        '
      required:
      - confirmedAt
      - type
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        confirmedAt:
          $ref: '#/components/schemas/ISODateTime'
    ApplicantRelationshipType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ApplicantRelationshipTypeKey'
    PensionIncomeBreakdown:
      type: object
      description: 'DE: Details über die für den Rentenanspruch releventen Daten. <br/>

        EN: Breakdown for Pension entitlement details.

        '
      properties:
        claimState:
          description: 'DE: Rentenanspruch gesetzlich. <br/>

            EN: Public pension entitlement.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        claimInsurance:
          description: 'DE: Rentenanspruch aus privaten Lebens- und Rentenversicherungsbeiträgen. <br/>

            EN: Pension entitlement from private life and pension insurance contributions.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    SelfEmploymentIncomeMethodKey:
      type: string
      description: 'DE: Berechnungsmethode für das Einkommen (nicht abschließende Aufzaehlung), z.B. (CUSTOMER_SPECIFICATION=Kundenangabe, PROFIT_AND_LOSS_ACCOUNT=Gewinn- und Verlustrechnung, NO_METHOD). <br/> EN: Open ended enum contains method for profit calculation, possible values are (CUSTOMER_SPECIFICATION, PROFIT_AND_LOSS_ACCOUNT, NO_METHOD).

        '
      example: CUSTOMER_SPECIFICATION
      x-extensible-enum:
      - CUSTOMER_SPECIFICATION
      - PROFIT_AND_LOSS_ACCOUNT
      - NO_METHOD
      - OTHER
    Informer:
      type: object
      description: 'DE: Informationen über den Zuträger. <br/> EN: Information about informer.

        '
      properties:
        informerId:
          $ref: '#/components/schemas/InformerId'
        externalId:
          type: string
          description: External Informer-ID
        person:
          $ref: '#/components/schemas/PersonName'
        contact:
          $ref: '#/components/schemas/Contact'
        address:
          $ref: '#/components/schemas/Address'
        company:
          type: string
          description: 'DE: Firma des Zuträgers. <br/> EN: Company of the informer.

            '
    HandoverReports:
      type: object
      description: 'A wrapper Type to hold a set of handover reports references.

        '
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/HandoverReport'
    LoanPartnerProcessor:
      description: 'DE: Der (Kredit-)Bearbeiter. <br/> EN: The loan partner processor.

        '
      required:
      - processorId
      - processorName
      properties:
        processorId:
          $ref: '#/components/schemas/LoanPartnerProcessorId'
        processorName:
          $ref: '#/components/schemas/LoanPartnerProcessorName'
        processorEmail:
          $ref: '#/components/schemas/LoanPartnerProcessorEmail'
    ClientAdvisorId:
      type: object
      required:
      - value
      description: 'DE: ID des Users. <br/> EN: ID of a user.

        '
      properties:
        value:
          type: string
    PhoneTypeKey:
      type: string
      description: 'DE: Art der Telefonnummer (nicht abschließende Aufzählung, zum Beispiel: MOBILE = Mobilfunknummer, LANDLINE = Festnetznummer, UNSPECIFIED = nicht angegeben, MOBILE_WORK= Firmenhandynummer). <br/> EN: Type of the phone number, possible values are MOBILE, LANDLINE, UNSPECIFIED, MOBILE_WORK.

        '
      x-extensible-enum:
      - MOBILE
      - LANDLINE
      - UNSPECIFIED
      - MOBILE_WORK
    OrganizationUser:
      type: object
      description: 'DE: Informationen über den Benutzer. EN: Information about the user.

        '
      properties:
        userData:
          $ref: '#/components/schemas/UserData'
        company:
          $ref: '#/components/schemas/OrganizationCompany'
    DeliverContractSubmissionCommand:
      type: object
      description: command to hand over the contract after successful credit decision.
      required:
      - contracts
      - contractDeliveryDate
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
        contracts:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ExtendedContractInfo'
        contractDeliveryDate:
          description: 'DE: Datum der Aushändigung des Vertrages. <br/> EN: Contract delivery date.

            '
          $ref: '#/components/schemas/ISODate'
    PensionIncome:
      type: object
      required:
      - pension
      description: 'DE: Regelmäßiges Einkommen aus Rente/Pension. <br/> EN: Periodical income from pension.

        '
      properties:
        pension:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        breakdown:
          $ref: '#/components/schemas/PensionIncomeBreakdown'
    HouseUnitCommerceType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/HouseUnitCommerceTypeKey'
    Occupation:
      oneOf:
      - $ref: '#/components/schemas/Employment'
      - $ref: '#/components/schemas/OtherOccupation'
      - $ref: '#/components/schemas/SelfEmployment'
      - $ref: '#/components/schemas/Executive'
      discriminator:
        propertyName: type
        mapping:
          EMPLOYEE: '#/components/schemas/Employment'
          WORKER: '#/components/schemas/Employment'
          UNEMPLOYED: '#/components/schemas/OtherOccupation'
          OFFICIAL: '#/components/schemas/Employment'
          PARENTAL_LEAVE: '#/components/schemas/Employment'
          FREELANCER: '#/components/schemas/SelfEmployment'
          MARGINALLY_EMPLOYED: '#/components/schemas/Employment'
          STOCKHOLDER: '#/components/schemas/OtherOccupation'
          HOUSE_WIFE_OR_HUSBAND: '#/components/schemas/OtherOccupation'
          INDEPENDENT_GENTLEMAN: '#/components/schemas/OtherOccupation'
          SELF_EMPLOYED_WITH_BALANCING: '#/components/schemas/SelfEmployment'
          SELF_EMPLOYED_WITHOUT_BALANCING: '#/components/schemas/SelfEmployment'
          PENSIONER: '#/components/schemas/OtherOccupation'
          STUDENT: '#/components/schemas/OtherOccupation'
          SOLDIER: '#/components/schemas/Employment'
          EXECUTIVE: '#/components/schemas/Executive'
    HouseUtilityUnitGroup:
      oneOf:
      - $ref: '#/components/schemas/HouseUtilityOwnUnitGroup'
      - $ref: '#/components/schemas/HouseUtilityRentedUnitGroup'
      discriminator:
        propertyName: utilization
        mapping:
          SELF_OCCUPIED: '#/components/schemas/HouseUtilityOwnUnitGroup'
          RENT_OUT: '#/components/schemas/HouseUtilityRentedUnitGroup'
    PercentageSpecialRepayment:
      description: 'DE: Sondertilgung in Prozent pro Periode. <br/>

        EN: Special repayment presented as percent per period.

        '
      type: object
      required:
      - percent
      allOf:
      - $ref: '#/components/schemas/BaseSpecialRepayment'
      properties:
        description:
          description: 'DE: Beschreibung der Sondertilgung. <br/> EN: Special repayment description.

            '
          type: string
        percent:
          description: 'DE: Sondertilgung in Prozent. <br/>

            EN: Payment percent per period.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
    LoanPlan:
      type: object
      required:
      - entries
      - entriesAggregated
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/PeriodicalRepaymentEntry'
        entriesAggregated:
          $ref: '#/components/schemas/RepaymentEntriesAggregated'
    CompanyVendor:
      type: object
      required:
      - company
      - vendorType
      allOf:
      - $ref: '#/components/schemas/BaseVendor'
      properties:
        company:
          type: string
          description: 'DE: Name der Firma, für welche der Immobilienverkäufer arbeitet. <br/> EN: The name of the estate vendor company.

            '
    Submissions:
      type: object
      description: 'A wrapper Type to hold a set of submission references and paging metadata.

        '
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubmissionItem'
        paging:
          $ref: '#/components/schemas/Paging'
    BaseFinancialStanding:
      type: object
      required:
      - financialStandingId
      - applicantId
      - type
      description: "DE: Bonitätsdaten des Antragstellers welche während der Beratungsphase gesammelt wurden.\n  - Eigenkapital\n  - Schulden\n  - Einkommen\n  - Ausgaben\nEN: Financial Standing as provided by the applicant during the consultation phase.\nA Financial Standing could be any of the following types:\n  - EQUITY\n  - DEBT\n  - INCOME\n  - EXPENSE\n"
      properties:
        financialStandingId:
          $ref: '#/components/schemas/FinancialStandingId'
        applicantId:
          description: 'DE: Ein Referenz wem die Bonitätinformation gehören. <br/> EN: Reference to whom belongs this financial standing.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        type:
          $ref: '#/components/schemas/FinancialStandingType'
      discriminator:
        propertyName: type
    ProductTypeKey:
      type: string
      description: 'DE: Art des Zusatzprodukten. <br/> EN: Enum contains type of the  additional product.

        '
      example: BAU_SPAR
      x-extensible-enum:
      - A_FONDS
      - AU_AL
      - BH_HAFTPF
      - BAU_SPAR
      - BU
      - CONTAINER
      - DREAD_DIS
      - FONDS_HYP
      - FONDS_LV
      - FONDS_RV
      - FONDS_SPAR
      - GES_FOND
      - GIRO
      - GFV
      - GRUND
      - HAFTPFL
      - HAUSRAT
      - HYPO
      - BSCHUTZ
      - INVEST
      - VERK_LVRV
      - KAPITAL_LV
      - PENSIONK
      - PRIV_KRANK
      - CREDIT
      - RECHT
      - RENTEN
      - RES_DEB_INS
      - RISIKO_LV
      - RURUP_RIEST
      - SOLAR
      - TEDDY
      - UNFALL
      - BUI
      - PREPAY_HARD
      - PREPAY_RELO
      - PREPAY_DIV
      - OTHER
    RemainingDebtAtComponent:
      type: object
      required:
      - loanId
      - remainingDebt
      properties:
        loanId:
          $ref: '#/components/schemas/LoanId'
        remainingDebt:
          $ref: '#/components/schemas/RawEuroAmount'
    PreSubmissionCheckItem:
      description: Performed pre-submission check information
      type: object
      required:
      - preSubmissionCheckId
      properties:
        preSubmissionCheckId:
          $ref: '#/components/schemas/PreSubmissionCheckId'
        createdAt:
          $ref: '#/components/schemas/ISODateTime'
    AnnuityDetails:
      description: 'DE: Detaillierte Information über das Annuitätsdarlehen. <br/>

        EN: Detailed information about periodic loan.

        '
      type: object
      required:
      - rateType
      allOf:
      - $ref: '#/components/schemas/BaseRateDetails'
      properties:
        amortisationRate:
          description: 'DE: Tilgungsrate (Prozent pro Periode). <br/>

            EN: Amortisation rate (percent per period).

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        fullAmortizer:
          type: boolean
          description: 'DE: Volltilger. <br/>

            EN: Full Amortizer.

            '
    CreditPhaseBurden:
      type: object
      properties:
        creditBurden:
          description: 'DE: Darlehensrate. <br/> EN: The credit rate.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        lastCreditBurden:
          description: 'DE: Schlussrate. <br/> EN: The last credit rate.

            '
          $ref: '#/components/schemas/EuroAmount'
        totalRatesPayed:
          description: 'DE: Zins- und Tilgungsbeiträge insgesamt (inkl. Sondertilgungen). <br/> EN: Sum of all payments made during credit phase.

            '
          $ref: '#/components/schemas/EuroAmount'
        numberOfCreditBurdens:
          description: 'DE: Anzahl der Zins- und Tilgungsbeiträge (inkl. Schlussrate). <br/> EN: Number of payed burdens including the last one.

            '
          type: integer
          format: int32
    SubmissionTimeline:
      type: object
      description: 'DE: Zeitplan einer Einreichung. EN: Timeline of a submission.

        '
      properties:
        predictedLoanPartnerDecisionDate:
          $ref: '#/components/schemas/PredictedLoanPartnerDecisionDate'
    RegulatoryAuthority:
      description: 'DE: Die Zuständige Aufsichtsbehörde der Firma. <br/> EN: Responsible supervisory authority of the company.

        '
      type: object
      properties:
        legalBasis:
          $ref: '#/components/schemas/RegulatoryAuthorityLegalBasis'
        name:
          description: 'DE: Name der Aufsichtsbehörde. <br/> EN: Name of the responsible supervisory authority.

            '
          type: string
        addressSummary:
          description: 'DE: Adresse der Aufsichtsbehörde. <br/> EN: Address of the responsible supervisory authority.

            '
          type: string
        url:
          type: string
          description: 'DE: Internetseite der Aufsichtsbehrde. <br/> EN: Website of the responsible supervisory authority.

            '
    Submission:
      type: object
      description: 'DE: Ein Kreditantrag enthält alle relevanten Informationen für eine Kreditentscheidung. <br/>

        EN: A submission holds all the information in order to help the financing partners during credit decision phase.

        '
      required:
      - submissionId
      properties:
        submissionId:
          $ref: '#/components/schemas/SubmissionId'
        financingApplication:
          $ref: '#/components/schemas/FinancingApplicationItem'
        overview:
          $ref: '#/components/schemas/SubmissionOverviewItem'
        creditLoans:
          $ref: '#/components/schemas/CreditLoans'
        residualDebtProtections:
          $ref: '#/components/schemas/ResidualDebtProtections'
        originInfo:
          $ref: '#/components/schemas/OriginInfo'
        preInquires:
          $ref: '#/components/schemas/PreInquires'
        preSubmissionChecks:
          $ref: '#/components/schemas/PreSubmissionCheckItems'
    ProductCalculation:
      oneOf:
      - $ref: '#/components/schemas/LoanToValueRatioProductCalculation'
      - $ref: '#/components/schemas/HouseholdProductCalculation'
      - $ref: '#/components/schemas/ConditionProductCalculation'
      discriminator:
        propertyName: type
        mapping:
          LENDING_VALUE: '#/components/schemas/LoanToValueRatioProductCalculation'
          HOUSEHOLD: '#/components/schemas/HouseholdProductCalculation'
          CONDITION: '#/components/schemas/ConditionProductCalculation'
    CloseRejectedSubmissionCommand:
      description: command to close rejected submission if new active component was detected that matches with previously rejected component.
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
    CommissionCalculationInfo:
      type: object
      required:
      - percent
      description: 'DE: Abschließende Information zur Provision. <br/> EN: Complete information about commissions.

        '
      properties:
        percent:
          description: 'DE: Provision in Prozent. <br/>

            EN: Commision in percent.

            '
          $ref: '#/components/schemas/RawPercentage'
        amount:
          description: 'DE: Provisionsbetrag. <br/>

            EN: Provision amount.

            '
          $ref: '#/components/schemas/RawEuroAmount'
        type:
          type: string
          x-extensible-enum:
          - TOTAL
          - INTERNAL
          - EXTERNAL
          - ON_TOP
    ProcessorId:
      description: 'DE: ID des Sachearbeiters bei einem Kreditgeber. EN: Id of the loan partner processor.

        '
      required:
      - value
      properties:
        value:
          type: string
    BaseVendor:
      type: object
      required:
      - vendorType
      properties:
        vendorType:
          type: string
          description: 'DE: Art des Immobilienverkäufers (nicht abschließende Aufzählung), z.B. (PERSON, COMPANY). <br/> EN: open ended enum contains type of the vendor, possible values are (PERSON, COMPANY).

            '
          example: PERSON
          x-extensible-enum:
          - PERSON
          - COMPANY
        contact:
          $ref: '#/components/schemas/Contact'
        address:
          $ref: '#/components/schemas/Address'
      discriminator:
        propertyName: vendorType
    Iban:
      type: object
      description: 'DE: IBAN <br/> EN: The International Bank Account Number

        '
      required:
      - value
      properties:
        value:
          type: string
          example: DE46500210000010130383
    FinancingNeedType:
      type: string
      example: OWN
      x-extensible-enum:
      - OWN
      - FOREIGN
    AlimonyExpense:
      type: object
      required:
      - alimony
      description: 'DE: Ausgaben durch Unterhalt. <br/> EN: Expenses for alimony.

        '
      properties:
        alimony:
          description: 'DE: Gesamte Unterhaltsausgaben. <br/> EN: Total alimony expenses

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        details:
          type: array
          items:
            $ref: '#/components/schemas/AlimonyExpenseDetail'
    AuxProductType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/AuxProductTypeKey'
    CapitalIncome:
      type: object
      description: 'DE: Zusätzliches regelmäßiges Einkommen durch Kapitalvermögen. <br/> EN: Additional periodical income from capital.

        '
      properties:
        capitalYield:
          description: 'DE: Regelmäßige Kapitalerträge (z.B. Zinsen, Dividenden). <br/>

            EN: Regular investment income (e.g. interest, dividends).

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        stocksAndBondsIncome:
          description: 'DE: Regelmäßige Einkünfte aus Beteiligungen (z.B. GmbH-Anteil). <br/>

            EN: Regular income from stock and bonds investments (e.g. GmbH share)

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        rentalIncomes:
          type: array
          items:
            $ref: '#/components/schemas/RentalIncomeItem'
    SubmissionRevokedReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/SubmissionRevokedReasonKey'
    SaleInformation:
      type: object
      description: 'DE: Information über den Objektverkauf. <br/> EN: Object sale information.

        '
      properties:
        familySale:
          description: 'DE: Verkauf findet innerhalb der Familie statt. <br/> EN: Sold within family.

            '
          type: boolean
          nullable: true
        fractionalOwnership:
          description: 'DE: Bruchteileigentum. <br/> EN: Fractional Ownership.

            '
          type: boolean
          nullable: true
        forcedSale:
          $ref: '#/components/schemas/ForeclosureSale'
        constructionCostInvoice:
          $ref: '#/components/schemas/ConstructionCostInvoice'
    KfwProgramType:
      type: string
      description: 'DE: KFW-Förderprogramm (nicht abschließende Aufzählung), z.B. KFW_124, KFW_151, KFW_152, KFW_153, KFW_159, KFW_167. <br/> EN: Open ended enum contains possible programs for Kfw, i.e. KFW_124, KFW_151, KFW_152, KFW_153, KFW_159, KFW_167.

        '
      example: KFW_124
      x-extensible-enum:
      - KFW_124
      - KFW_151
      - KFW_152
      - KFW_153
      - KFW_159
      - KFW_167
      - KFW_261
      - KFW_262
      - KFN_297
      - KFN_QNG_297
      - KFN_298
      - KFN_QNG_298
      - WEP_300
      - WEP_QNG_300
      - WEP_JKA_308
      - KFW_358
      - KFW_359
      - KNN_296
      - UNKNOWN
    SubmissionId:
      type: object
      description: 'An Id refers to a specific submission resource.

        '
      required:
      - value
      properties:
        value:
          type: string
    SpecialRepayment:
      oneOf:
      - $ref: '#/components/schemas/PercentageSpecialRepayment'
      - $ref: '#/components/schemas/TextSpecialRepayment'
      discriminator:
        propertyName: type
        mapping:
          PERCENTAGE: '#/components/schemas/PercentageSpecialRepayment'
          TEXT: '#/components/schemas/TextSpecialRepayment'
    RealEstateEquityDetails:
      type: object
      required:
      - equity
      description: 'DE: Informationen zum Eigenkapital durch Immobilienvermögen. <br/> EN: Details about equites associated with the real estate.

        '
      properties:
        equity:
          description: 'DE: Marktwert. <br/>

            EN: Market value.

            '
          $ref: '#/components/schemas/EuroAmount'
    PersonVendor:
      type: object
      required:
      - person
      - vendorType
      allOf:
      - $ref: '#/components/schemas/BaseVendor'
      properties:
        person:
          $ref: '#/components/schemas/Person'
    PhoneReachabilityKey:
      type: string
      description: 'DE: Erreichbarkeit unter dieser Telefonnumer (nicht abschließende Aufzählung, zum Beispiel: DAYTIME = tagsüber, EVENING = abends). <br/> EN: Reachable by this phone number, possible values are DAYTIME, EVENING.

        '
      x-extensible-enum:
      - DAYTIME
      - EVENING
    FinancialStandingItem:
      type: object
      description: 'Holds basic information associated with a specific financial standing type and whom it belongs.


        Further details will be delivered in the embedded property if specified.


        Please refer to *Expansion* section for more details.

        '
      properties:
        financialStandingRef:
          $ref: '#/components/schemas/FinancialStandingRef'
        type:
          $ref: '#/components/schemas/FinancialStandingType'
        applicantId:
          description: 'DE: Ein Referenz wem die Bonitätinformation gehören. <br/>

            EN: Reference to whom belongs this financial standing.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        embedded:
          $ref: '#/components/schemas/FinancialStanding'
    BaseCounterOfferSuspendedAmortizationCombinedProduct:
      type: object
      required:
      - product
      properties:
        product:
          $ref: '#/components/schemas/SuspendedRepaymentProductTypeKey'
      discriminator:
        propertyName: product
    SubmissionCounterOfferRevokedStatus:
      type: object
      description: 'EN: Status containing information about counteroffer that was revoked

        '
      required:
      - type
      - reason
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        reason:
          $ref: '#/components/schemas/RevokeSubmissionCounterOfferReason'
    ISODateTime:
      description: 'DE: Datum, Syntax nach <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339</a><br/> EN: Date according to <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339</a>

        '
      type: string
      format: date-time
      nullable: true
      example: 2019-12-29 10:22:50+00:00
    SubmissionCounterOffer:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/SubmissionCounterOfferId'
        offeredLoans:
          type: array
          items:
            $ref: '#/components/schemas/CreditLoan'
        validUntil:
          $ref: '#/components/schemas/ISODate'
        offerDate:
          $ref: '#/components/schemas/ISODate'
    LoanQuota:
      type: object
      description: 'DE: Wert und Prozentsatz für die Darlehensquote. <br/> EN: Value and percentage for a loan quota

        '
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/LoanQuotaType'
        lendingValue:
          description: 'DE: Beleihungswert. <br/>

            EN: Lending value.

            '
          $ref: '#/components/schemas/EuroAmount'
        percentage:
          description: 'DE: Beleihungsauslauf. <br/>

            EN: Loan quota percentage.

            '
          $ref: '#/components/schemas/Percentage'
        conditional:
          description: 'DE: Beleihungsauslauf für die Konditionermittlung. <br/>

            EN: Loan quota for condition retrieval.

            '
          $ref: '#/components/schemas/Percentage'
    BaseHouseUtilityUnitGroup:
      type: object
      required:
      - utilization
      properties:
        numberOfUnits:
          type: integer
          format: int32
          description: 'DE: Anzahl der näher zu beschreibenden Wohneinheiten in einer Gruppe. <br/>

            EN: Number of units within a unit group.

            '
        totalArea:
          $ref: '#/components/schemas/SquareMeter'
        vacantArea:
          $ref: '#/components/schemas/SquareMeter'
        smallestArea:
          $ref: '#/components/schemas/SquareMeter'
        commercialUsage:
          $ref: '#/components/schemas/HouseUnitCommercialUsage'
        utilization:
          type: string
          description: 'DE: Nutzung des Ojektes (nicht abschließende Aufzählung), z.B. SELF_OCCUPIED, RENT_OUT. <br/> EN: Open ended enum contains utilization of the property, possible values are SELF_OCCUPIED, RENT_OUT.

            '
          x-extensible-enum:
          - SELF_OCCUPIED
          - RENT_OUT
      discriminator:
        propertyName: utilization
    SubmissionRevokedReasonType:
      type: string
      description: 'DE: Mögliche Gründe für einen Widerruf des Darlehensvertrags <br/> EN: Possible reasons for revocation of the loan agreement

        '
      example: TIME
      x-extensible-enum:
      - TIME
      - COND
      - DOCS
      - NO_OBJECT
      - MAIN
      - AUX
      - WRONG_BID
      - ERROR_USE
      - ERROR_TEC
      - TERMINATION
      - REALLOCATION
      - OTHER
    HouseRentedUnitDetails:
      type: object
      properties:
        rentedPeriod:
          $ref: '#/components/schemas/RentPeriodType'
        rent:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        sustainableRent:
          description: 'DE: Nachhaltige Miete pro qm. <br/>

            EN: Sustainable rent per square meter.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmountPerSquareMeter'
        rentValuation:
          description: 'DE: Mietewert entsprechend einer Infoquelle (z. B. Sprengnetter). <br/> EN: Rent value according to an information source (e.g. Sprengnetter).

            '
          $ref: '#/components/schemas/EvaluationInformation'
    FinancingVenture:
      oneOf:
      - $ref: '#/components/schemas/FinancingVentureBuyNew'
      - $ref: '#/components/schemas/FinancingVentureBuyExisting'
      - $ref: '#/components/schemas/FinancingVentureConstruction'
      - $ref: '#/components/schemas/FinancingVentureDebtRescheduling'
      - $ref: '#/components/schemas/FinancingVentureRenovation'
      - $ref: '#/components/schemas/FinancingVentureOtherCapitalFinancing'
      discriminator:
        propertyName: reason
        mapping:
          BUY_NEW: '#/components/schemas/FinancingVentureBuyNew'
          BUY_EXISTING: '#/components/schemas/FinancingVentureBuyExisting'
          BUILD: '#/components/schemas/FinancingVentureConstruction'
          REFINANCE: '#/components/schemas/FinancingVentureDebtRescheduling'
          RENOVATE: '#/components/schemas/FinancingVentureRenovation'
          RAISE_CAPITAL: '#/components/schemas/FinancingVentureOtherCapitalFinancing'
    ChangeLoanPartnerProcessingUnitCommand:
      description: command to change assigned loan partner processing unit
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        processingUnitId:
          deprecated: true
          description: This is deprecated and will be removed as soon as the services can handle the new field.
          $ref: '#/components/schemas/LoanPartnerProcessingUnitId'
        processingUnit:
          $ref: '#/components/schemas/ProcessingUnit'
        remark:
          type: string
    MaritalStatus:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/MaritalStatusKey'
    OfferId:
      type: object
      required:
      - value
      properties:
        value:
          type: string
        revision:
          type: string
          description: Offer revision that has been currently submitted
    ExistingLoanExpenses:
      type: object
      description: 'Wrapper Type holds a set of periodical expenses associated with existing credits.

        '
      properties:
        credits:
          type: array
          items:
            $ref: '#/components/schemas/DebtExpense'
    MaritalPropertyStatus:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/MaritalPropertyStatusKey'
    ExtendedContractInfo:
      type: object
      description: 'DE: Vertragsnummer mit Referenznummer ID.<br/> EN: Contract number and reference id pair with additional loan details.

        '
      required:
      - contractNumber
      - loanType
      - referenceId
      properties:
        contractNumber:
          type: string
          description: 'DE: Darlehensnummer / Vertragsnummer. <br/> EN: Loan number / contract number.

            '
        referenceId:
          $ref: '#/components/schemas/ContractInfoReferenceId'
        loanType:
          $ref: '#/components/schemas/ContractInfoLoanType'
        loanDetails:
          $ref: '#/components/schemas/LoanDetails'
    ContractInfo:
      type: object
      description: 'DE: Vertragsnummer mit Referenznummer ID.<br/> EN: Contract number and reference id pair.

        '
      required:
      - contractNumber
      - loanType
      - referenceId
      properties:
        contractNumber:
          type: string
          description: 'DE: Darlehensnummer / Vertragsnummer. <br/> EN: Loan number / contract number.

            '
        referenceId:
          $ref: '#/components/schemas/ContractInfoReferenceId'
        loanType:
          $ref: '#/components/schemas/ContractInfoLoanType'
    Company:
      description: 'DE: Informationen zu einem Unternehmen. EN: Information of a company.

        '
      required:
      - companyId
      properties:
        companyId:
          $ref: '#/components/schemas/CompanyId'
        name:
          readOnly: true
          $ref: '#/components/schemas/CompanyName'
    SelfEmployment:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseOccupation'
      properties:
        jobInformation:
          $ref: '#/components/schemas/JobInformation'
        foundationYear:
          description: 'DE: Jahr der Gründung der Unternehmung<br/> EN: Year of the foundation of the enterprise

            '
          example: 1999
          $ref: '#/components/schemas/Year'
        shareHolding:
          $ref: '#/components/schemas/ShareHolding'
        freelancerJobType:
          $ref: '#/components/schemas/FreeLancerJobType'
    SubmissionDataViolationSeverityKey:
      type: string
      x-extensible-enum:
      - INFO
      - WARN
      - ERROR
    ExistingMortgageRef:
      type: object
      description: 'DE: Id und Referenz zu einer bestehenden Hypothek. <br/>

        EN: Id and reference to the existing mortgage.

        '
      required:
      - id
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        id:
          $ref: '#/components/schemas/DebtId'
    CounterOfferAuxiliaryLoan:
      description: 'DE: Information zum Gegenangebot Nachrangdarlehen. <br/>

        EN: Information about the counter offer auxiliary loan.

        '
      type: object
      required:
      - type
      - annuityDetails
      allOf:
      - $ref: '#/components/schemas/BaseCounterOfferLoan'
      properties:
        annuityDetails:
          $ref: '#/components/schemas/CounterOfferAnnuityRateDetails'
    PhoneReachability:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/PhoneReachabilityKey'
    PauseReasonKey:
      type: string
      x-extensible-enum:
      - DOCUMENTS
      - INFOS
      - BY_CUSTOMER
      - ONHOLD
      - EXPERTISE
      - ORIG_CONTR
      - REJ_SOON
      - FIN_APPROV
      - MIN_DOCS
      - OTHER
    DefaultSpecialRealEstateCharacteristics:
      allOf:
      - $ref: '#/components/schemas/BaseSpecialRealEstateCharacteristics'
    BridgingLoanDetails:
      oneOf:
      - $ref: '#/components/schemas/OpenPropertySale'
      - $ref: '#/components/schemas/ClosedPropertySale'
      - $ref: '#/components/schemas/UnavailableEquity'
      - $ref: '#/components/schemas/PublicPreFinancing'
      - $ref: '#/components/schemas/ExistingBuildingSavingPlan'
      discriminator:
        propertyName: reason
        mapping:
          OPEN_PROPERTY_SALE: '#/components/schemas/OpenPropertySale'
          CLOSED_PROPERTY_SALE: '#/components/schemas/ClosedPropertySale'
          UNAVAILABLE: '#/components/schemas/UnavailableEquity'
          PUBLIC_PRE_FINANCE: '#/components/schemas/PublicPreFinancing'
          EXISTING_BUILDING_SAVING_PLAN: '#/components/schemas/ExistingBuildingSavingPlan'
    Address:
      type: object
      required:
      - city
      - country
      properties:
        street:
          type: string
          example: Mainsteet
          description: 'DE: Straßenname (Teil der Adresse). <br/> EN: Street name of the address

            '
        houseNumber:
          type: string
          example: '42'
          description: 'DE: Hausnummer (Teil der Adresse). <br/> EN: House number of the address.

            '
        apartmentNumber:
          type: string
          example: '3'
          description: 'DE: Wohnungsnummer. <br/> EN: Apartment number within the building.

            '
        postalCode:
          type: string
          example: '80807'
          description: 'DE: Postleitzahl (Teil der Adresse). <br/> EN: Postal code of the address.

            '
        city:
          type: string
          example: Munich
          description: 'DE: Stadt (Teil der Adresse). EN: City of the address.

            '
        federalState:
          type: string
          example: DE_BY
          description: 'DE: Bundesland (Teil der Adresse) nach nach ISO 3166-2 (https://en.wikipedia.org/wiki/ISO_3166-2). <br/> EN: Federal state of the address in ISO_3166-2 format (https://en.wikipedia.org/wiki/ISO_3166-2).

            '
        country:
          type: string
          example: DE
          description: 'DE: Länder-Code (Teil der Adresse) nach ISO_3166-1_alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). <br/> EN: Official ISO_3166-1_alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the address.

            '
    BasementExtensionForResidentialUse:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/BasementExtensionForResidentialUseKey'
    FinancialDebt:
      type: object
      required:
      - type
      description: 'DE: Informationen über (finanzielle) Schulden vor Beginn der angefragten Finanzierung. <br/> EN: Financial debts information before the financing process.

        '
      allOf:
      - $ref: '#/components/schemas/BaseFinancialStanding'
      properties:
        liability:
          $ref: '#/components/schemas/LiabilityDebt'
        existingLoans:
          type: array
          description: 'DE: Alle laufenden Schulden aus Darlehen. <br/> EN: Set of current loans debts.

            '
          items:
            $ref: '#/components/schemas/ExistingLoanDebt'
        other:
          $ref: '#/components/schemas/EuroAmount'
    CounterOfferKfwLoan:
      description: 'DE: Information zum Gegenangebot Kfw-Darlehen. <br/>

        EN: Information about the counter offer KFW loan.

        '
      type: object
      required:
      - type
      - program
      - annuityDetails
      allOf:
      - $ref: '#/components/schemas/BaseCounterOfferLoan'
      properties:
        program:
          $ref: '#/components/schemas/KfwProgram'
        annuityDetails:
          $ref: '#/components/schemas/CounterOfferAnnuityRateDetails'
    RenovateEstateFinancing:
      description: 'DE: Finanzierungsrelevante Information zum Umbau / Modernisierung. <br/>

        EN: Financing-relevant information for the refurbishment / modernisation.

        '
      allOf:
      - $ref: '#/components/schemas/BaseOwnEstateFinancingNeed'
    BaseForeignEstateFinancingNeed:
      type: object
      required:
      - reason
      description: 'DE: Finanzierungsbedarf für den Kauf oder Bau einer Immobilie <br/> EN: Financing need for buying or building an estate.

        '
      allOf:
      - $ref: '#/components/schemas/BaseFinancingNeed'
      properties:
        reason:
          type: string
        estateAcquisitionCosts:
          $ref: '#/components/schemas/EstateAcquisitionCosts'
      discriminator:
        propertyName: reason
    SubmissionContractCanceledStatus:
      type: object
      description: 'EN: Status containing information about cancelling the contract

        '
      required:
      - type
      - reason
      - cancellationDate
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        reason:
          $ref: '#/components/schemas/CancelContractReason'
        cancellationDate:
          $ref: '#/components/schemas/ISODate'
    AuxiliaryIncome:
      type: object
      required:
      - income
      description: 'DE: Regelmäßige Nebeneinkünfte. <br/> EN: Periodical auxiliary income.

        '
      properties:
        income:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        since:
          $ref: '#/components/schemas/ISODate'
    KfwCallTypeKey:
      type: string
      description: 'DE: Art der KFW-Reservierung (nicht abschließende Aufzählung), z.B. LIGHT, PLUS. <br/> EN: Open ended enum contains Kfw reservation process call type, possible values are LIGHT, PLUS.

        '
      example: PLUS
      x-extensible-enum:
      - LIGHT
      - PLUS
      - OTHER
    BusinessLineKey:
      type: string
      description: 'DE: Branche der Tätigkeit (nicht abschließende Aufzählung). <br/> EN: Open ended enum contains values for the business line, possible values are AGRICULTURE, CAR_DEALER, CAR_REPAIR, CHURCH, CONSTRUCTION_INDUSTRY, COURIER_SERVICE, DATING_SERVICE, EDUCATION, ENERGY, EROTIC_INDUSTRY, FINANCES, FINANCIAL_SERVICES, FITNESS, GAS_STATION, GASTRONOMY, HANDCRAFT, HEALTH_SERVICE, HOTEL_INDUSTRY, IT_CONSULTING, KIOSK, OTHER, PRODUCTION_AND_INDUSTRY, PUBLIC_SERVICE, REAL_ESTATE, TAXI, TRANSPORT, TRAVEL_AGENCY, WHOLE_AND_RETAIL_SALE.

        '
      example: AGRICULTURE
      x-extensible-enum:
      - AGRICULTURE
      - ADMINISTRATION
      - AUTOMOTIVE
      - CAR_DEALER
      - CAR_REPAIR
      - CHURCH
      - CONSTRUCTION_INDUSTRY
      - CONSULTING_AND_ADVISORY
      - COURIER_SERVICE
      - DATING_SERVICE
      - EDUCATION
      - ENERGY
      - EROTIC_INDUSTRY
      - FINANCES
      - FINANCIAL_SERVICES
      - FITNESS
      - GAS_STATION
      - GASTRONOMY
      - HANDCRAFT
      - HAULIER
      - HEALTH_SERVICE
      - HOTEL_INDUSTRY
      - IT_CONSULTING
      - IT_AND_PROGRAMMING
      - KIOSK
      - PRODUCTION_AND_INDUSTRY
      - PUBLIC_SERVICE
      - REAL_ESTATE
      - TAXI
      - TRANSPORT
      - TRAVEL_AGENCY
      - WHOLE_AND_RETAIL_SALE
      - MINING
      - CHEMICAL_INDUSTRY
      - DIPLOMATIC_SERVICE
      - PRINTING_INDUSTRY
      - FISHING_INDUSTRY
      - WOOD_INDUSTRY
      - IRON_INDUSTRY
      - CAR_MANUFACTURER
      - MILITARY
      - FOOD_INDUSTRY
      - NON_PROFIT_ORGANISATION
      - MEDIA_INDUSTRY
      - SEAFARING
      - LOGISTIC
      - TEXTILE_INDUSTRY
      - TOURISM
      - MANUFACTURING_INDUSTRY
      - PASSENGER_TRANSPORT
      - TEMP_EMPLOYMENT_AGENCY
      - VIDEO_STORE
      - OTHER
    RFC7807Problem:
      type: object
      title: RFC7807Problem
      description: 'DE: Angaben zum zurueckgegebenen Fehler. EN: Holds information on the returned error.

        '
      required:
      - timestamp
      - traceId
      - instance
      - title
      - status
      properties:
        timestamp:
          type: string
          format: date-time
          description: 'DE: Ein UTC-Zeitstempel, der den Fehlerzeitpunkt angibt (https://de.wikipedia.org/wiki/Koordinierte_Weltzeit). EN: A UTC date-time indicating the error timestamp (https://en.wikipedia.org/wiki/Coordinated_Universal_Time).

            '
          example: 2024-06-29 19:22:50+00:00
        type:
          type: string
          format: uri
          description: 'DE: Verknuepfung zum Abruf von mehr Informationen zu dem Fehler. EN: URL referring to more information about the error.

            '
          default: about:blank
        title:
          type: string
          description: 'DE: Kurzbeschreibung des Fehlers. EN: Error short description.

            '
          example: Bad Request
        status:
          type: integer
          format: int32
          description: 'DE: HTTP-Status-Code gemaess Konvention (https://tools.ietf.org/html/rfc2616#section-10). EN: HTTP status code following standared error codes (https://tools.ietf.org/html/rfc2616#section-10).

            '
          example: 400
          minimum: 100
          maximum: 599
        detail:
          type: string
          description: 'DE: Detaillierte Beschreibung des Fehlers. EN: Detailed description for the returned error.

            '
          example: JSON parse error
        traceId:
          type: string
          description: 'DE: Eindeutige Kennung zur Verfolgung der Anfrage. EN: Unique trace id for problematic request.

            '
          example: avx1234asd
        instance:
          type: string
          format: uri
          description: 'DE: Pfad zur betreffenden Resource. EN: Path of requested resource.

            '
          example: http://localhost/resources/123
        violations:
          type: array
          description: 'DE: Abfolge der Verstoesse in der Anfrage. EN: Collection of the invalid content of the request.

            '
          items:
            $ref: '#/components/schemas/Violation'
    AtticDetail:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/AtticDetailKey'
    CommissionInfo:
      type: object
      required:
      - percent
      description: 'DE: Abschließende Information zur Provision. <br/> EN: Complete information about commissions.

        '
      properties:
        percent:
          description: 'DE: Provision in Prozent. <br/>

            EN: Commision in percent.

            '
          $ref: '#/components/schemas/Percentage'
        amount:
          description: 'DE: Provisionsbetrag. <br/>

            EN: Provision amount.

            '
          $ref: '#/components/schemas/EuroAmount'
    FreeLancerJobTypeKey:
      type: string
      description: 'DE: Freiberufliche Tätigkeit des Antragstellers (nicht abschließende Aufzählung). <br/> EN: open ended enum contains alues for the freelancer job types, possible values are CARER, AMBORDERLY, ADVOCATE, APOTHECARY, ARCHITECT, PHYSICIAN, UNDERTAKER, ACCOUNTANT, REVISOR, FED_DP_COMMISSIONER, DECORATOR, DIETICIAN, INTERPRET, ERGOTHERAPIST, NUTRITIONIST, GEOGRAPHER, CONSULTANT, IT_CONSULT, FINANCSERV, PHOTOGRAPH, DESIGNER, MIDWIFE, HEALERMASSEUR, HEALER, HISTORIAN, COMPUTER_SPEC, ENGINEER, INSOLVENCY_ADMIN, JOURNALIST, PHYSIOTHER, ORDERLY, NURSE, MUSICIAN, CONSTRUCTOR, THERAPIST, MASSEUR, PARAMEDIC, NOTARY, OPTICIAN, OPERA_SINGER, HR_ADVISR, PSYCHOLOG, PSYCHOTHER, PHYSTHERAP, INTER_DECORATOR, RADIO_ANNOUNCER, EXPERT, TOWN_PLANER, STRUCT_ENG, TAX_ADVISR, TAX_AGENT, VETERINARY, TRANSLATOR, UNDER_ADVISR, AUDITOR, DENTAL_TECH, DENTIST, FARMER, OTHER.

        '
      example: ARCHITECT
      x-extensible-enum:
      - CARER
      - AMBORDERLY
      - ADVOCATE
      - APOTHECARY
      - ARCHITECT
      - PHYSICIAN
      - UNDERTAKER
      - ACCOUNTANT
      - REVISOR
      - FED_DP_COMMISSIONER
      - DECORATOR
      - DIETICIAN
      - INTERPRET
      - ERGOTHERAPIST
      - NUTRITIONIST
      - GEOGRAPHER
      - CONSULTANT
      - IT_CONSULT
      - FINANCSERV
      - PHOTOGRAPH
      - DESIGNER
      - MIDWIFE
      - HEALERMASSEUR
      - HEALER
      - HISTORIAN
      - HR_CONSULTANT
      - COMPUTER_SPEC
      - ENGINEER
      - INSOLVENCY_ADMIN
      - JOURNALIST
      - PHYSIOTHER
      - ORDERLY
      - NURSE
      - MUSICIAN
      - CONSTRUCTOR
      - THERAPIST
      - MASSEUR
      - PARAMEDIC
      - NOTARY
      - OPTICIAN
      - OPERA_SINGER
      - HR_ADVISR
      - PSYCHOLOG
      - PSYCHOTHER
      - PHYSTHERAP
      - INTER_DECORATOR
      - RADIO_ANNOUNCER
      - REMEDIAL_GYMNAST
      - EXPERT
      - TOWN_PLANER
      - STRUCT_ENG
      - TAX_ADVISR
      - TAX_AGENT
      - VETERINARY
      - TRANSLATOR
      - UNDER_ADVISR
      - AUDITOR
      - DENTAL_TECH
      - DENTIST
      - BROKER
      - FARMER
      - OTHER
    StatSourceKey:
      type: string
      description: 'DE: Infoquelle fuer den aktuellen Marktwert des Gebäudes oder Grundstuecks, z.B. MAP=Bodenrichtwertkarte, GSD, EVAL_COM=Gutachterausschuss, HVB, IMMOSCOUT, IMMOPOOL, LBS_LOCA=LBS_Zweigstelle, PLOETZ, IVD_SPIEGEL, BANK_LOCAL=Bank_vor_Ort, CITY, SPGNET=Sprengnetter, ING=ING_Objektbewertung, OTHER. <br/> EN: Open ended enum contains source for the current market or land value evaluation, possible values are MAP, GSD, EVAL_COM, HVB, IMMOSCOUT, IMMOPOOL, LBS_LOCAL, PLOETZ, IVD_SPIEGEL, BANK_LOCAL, CITY, SPGNET, ING, ON_GEO, VDP_RESEARCH, OTHER.

        '
      example: MAP
      x-extensible-enum:
      - MAP
      - GSD
      - EVAL_COM
      - EXPERT
      - HVB
      - IMMOSCOUT
      - IMMOPOOL
      - LBS_LOCAL
      - PLOETZ
      - IVD_SPIEGEL
      - BANK_LOCAL
      - CITY
      - SPGNET
      - ING
      - OTHER
      - BHW
      - RDM_SPIEGEL
      - ON_GEO
      - VDP_RESEARCH
    BuildingSavingPlanEquity:
      type: object
      required:
      - amount
      - contractNumber
      description: 'DE: Details über vorhandene Bestandsbausparer Guthaben (vor der Finanzierung). <br/>

        EN: details about existing building saving plan equity (before financing).

        '
      properties:
        amount:
          description: 'DE: Bausparsumme. <br/>

            EN: Saving plan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        depositValue:
          $ref: '#/components/schemas/EuroAmount'
        contractingDate:
          description: 'DE: Vertragsbeginn. <br/>

            EN: Contract start date.

            '
          $ref: '#/components/schemas/ISODate'
        duration:
          description: 'DE: Darlehensdauer/Gesamtlaufzeit. <br/>

            EN: Loan duration.

            '
          $ref: '#/components/schemas/Duration'
        allocationDate:
          $ref: '#/components/schemas/ISODate'
        contractNumber:
          type: string
          description: 'DE: Vertragsnummer. <br/> EN: Contract number.

            '
        externalId:
          description: id (projection id) used to identify the product used as a suspended amortization in the bank external system
          type: string
    ProcessingUnit:
      description: 'DE: Informationen zur Einheit des Kreditgebers, welche die Einreichung bearbeitet. EN: Id of the loan partner processing unit.

        '
      required:
      - processingUnit
      properties:
        loanPartnerQueue:
          $ref: '#/components/schemas/LoanPartnerQueue'
        processingUnit:
          description: The current processing unit of a submission. If the processing unit is not provided while creating, the loan partner will be used as processing unit.
          $ref: '#/components/schemas/Company'
    FinancingDetails:
      oneOf:
      - $ref: '#/components/schemas/OwnEstateFinancingDetails'
      - $ref: '#/components/schemas/ForeignEstateFinancingDetails'
      discriminator:
        propertyName: type
        mapping:
          OWN: '#/components/schemas/OwnEstateFinancingDetails'
          FOREIGN: '#/components/schemas/ForeignEstateFinancingDetails'
    OtherCapitalNeededLoan:
      description: 'DE: Details über das Darlehen, welches zur Kapitalbeschaffung benötigt wird. <br/>

        EN: Details about the loan needed for raising capital.

        '
      type: object
      required:
      - amount
      properties:
        amount:
          description: 'DE: Darlehenssumme. <br/>

            EN: Loan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        usage:
          $ref: '#/components/schemas/OtherCapitalNeededLoanUsage'
    ApplicantRelationshipsQuery:
      type: object
      description: 'A wrapper Type to hold a set of possible relationships among applicants involved in the financing application.

        '
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ApplicantRelationship'
    Neighbourhood:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/NeighbourhoodKey'
    MainProduct:
      oneOf:
      - $ref: '#/components/schemas/RegularMainProduct'
      - $ref: '#/components/schemas/BridgingFinancingMainProduct'
      discriminator:
        propertyName: product
        mapping:
          ANNUITAET: '#/components/schemas/RegularMainProduct'
          W_RIESTER: '#/components/schemas/RegularMainProduct'
          ZWIFI: '#/components/schemas/BridgingFinancingMainProduct'
          FLEX_PLUS: '#/components/schemas/RegularMainProduct'
          FLEX: '#/components/schemas/RegularMainProduct'
          FORWARD: '#/components/schemas/RegularMainProduct'
          KOMBI: '#/components/schemas/RegularMainProduct'
          KONSTANT: '#/components/schemas/RegularMainProduct'
          KONST_KOMBI: '#/components/schemas/RegularMainProduct'
          VERSICHER: '#/components/schemas/RegularMainProduct'
          VOLLTILGER: '#/components/schemas/RegularMainProduct'
          OTHER: '#/components/schemas/RegularMainProduct'
    RateDetails:
      oneOf:
      - $ref: '#/components/schemas/AnnuityDetails'
      - $ref: '#/components/schemas/SuspendedAmortizationDetails'
      discriminator:
        propertyName: rateType
        mapping:
          ANNUITY: '#/components/schemas/AnnuityDetails'
          SUSPENDED_AMORTIZATION: '#/components/schemas/SuspendedAmortizationDetails'
    ExistingLoanDebt:
      oneOf:
      - $ref: '#/components/schemas/SimpleLoanDebt'
      - $ref: '#/components/schemas/SolvencyCreditDebt'
      - $ref: '#/components/schemas/ExistingMortgageDebt'
      - $ref: '#/components/schemas/ExistingRealEstateDebt'
      discriminator:
        propertyName: type
        mapping:
          EMPLOYMENT: '#/components/schemas/SimpleLoanDebt'
          PRIVATE: '#/components/schemas/SimpleLoanDebt'
          MORTGAGE_SAVING_PLAN: '#/components/schemas/SimpleLoanDebt'
          OTHER: '#/components/schemas/SimpleLoanDebt'
          PUBLIC: '#/components/schemas/SimpleLoanDebt'
          SOLVENCY: '#/components/schemas/SolvencyCreditDebt'
          EXISTING_MORTGAGE: '#/components/schemas/ExistingMortgageDebt'
          EXISTING_REALESTATE: '#/components/schemas/ExistingRealEstateDebt'
          OPEN_PROPERTY_SALE: '#/components/schemas/SimpleLoanDebt'
    EstateRef:
      type: object
      required:
      - estateId
      description: 'DE: Id und Referenz zu der Immobilie. <br/> EN: Id and Reference to the estate.

        '
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        estateId:
          $ref: '#/components/schemas/EstateId'
    ApplicantRelationships:
      type: object
      description: 'A wrapper Type to hold a set of possible relationships among applicants involved in the financing application.

        '
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        embedded:
          $ref: '#/components/schemas/ApplicantRelationshipsQuery'
    RealEstateEquityItem:
      type: object
      required:
      - estateId
      - equity
      description: 'DE: Informationen zu einem bestimmten Eigenkapital durch Immobilienvermögen. <br/> EN: Details about a specific real estate equity.

        '
      properties:
        estateId:
          $ref: '#/components/schemas/EstateId'
        description:
          type: string
        equity:
          $ref: '#/components/schemas/RealEstateEquityDetails'
        guarantees:
          $ref: '#/components/schemas/RealEstateGuarantees'
    HouseholdCalculation:
      description: 'DE: Information zu der Haushalt Kalkulation <br/>

        EN: Information about the household calculation.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseCalculation'
      properties:
        summary:
          $ref: '#/components/schemas/FinancialStandingSummary'
        details:
          type: array
          items:
            $ref: '#/components/schemas/CalculationDetail'
        financialBurden:
          type: array
          items:
            $ref: '#/components/schemas/FinancialBurdenDetail'
          x-is-plural: true
    PropertiesRegisterInventory:
      oneOf:
      - $ref: '#/components/schemas/OwnershipInventory'
      - $ref: '#/components/schemas/JointOwnershipInventory'
      discriminator:
        propertyName: type
        mapping:
          OWNERSHIP_INVENTORY: '#/components/schemas/OwnershipInventory'
          JOINT_OWNERSHIP_INVENTORY: '#/components/schemas/JointOwnershipInventory'
    CollateralMortgageProperties:
      description: 'DE: Weitere Beleihungsobjekte die als Sicherheit verwendet werden. <br/> EN: Other estates to be pledged as security deposit.

        '
      type: object
      properties:
        estates:
          type: array
          items:
            $ref: '#/components/schemas/EstateRef'
          minItems: 1
    Duration:
      type: object
      title: Duration
      description: 'DE: Gibt einen Zeitraum an. </br> EN: Specifies a duration.

        '
      required:
      - value
      - unit
      properties:
        value:
          type: integer
          format: int32
          description: 'DE: Die Menge der gewaehlten Zeiteinheit. </br> EN: The amount of the selected temporal unit.

            '
        unit:
          type: string
          enum:
          - YEARS
          - MONTHS
          - DAYS
          description: 'DE: Die Zeiteinheit. </br> EN: The temporal unit.

            '
    PlannedModernisationDetails:
      oneOf:
      - $ref: '#/components/schemas/PlannedHeatingModernisationDetails'
      - $ref: '#/components/schemas/DefaultPlannedModernisationDetails'
      discriminator:
        propertyName: modernisationType
        mapping:
          HEATING: '#/components/schemas/PlannedHeatingModernisationDetails'
          DEFAULT: '#/components/schemas/DefaultPlannedModernisationDetails'
    JointOwnershipInventory:
      description: 'DE: Miteigentumsanteil an einem Gründstück/Objekt. <br/> EN: Co-ownership of a property.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BasePropertiesRegisterInventory'
      properties:
        commonPropertyShare:
          description: 'DE: Miteigentumsanteil (https://de.wikipedia.org/wiki/Miteigentumsanteil). EN: Co-ownership share (https://de.wikipedia.org/wiki/Miteigentumsanteil).

            '
          type: number
          format: double
        commonPropertyTotal:
          description: 'DE: Summe der Miteigentumsanteile. EN: Total Co-ownership share.

            '
          type: number
          format: double
        inventoryUnitProperties:
          description: 'DE: Sammlung von Sondereigentümen (https://de.wikipedia.org/wiki/Sondereigentum) die mit diesem Miteigentum verbunden sind. <br/> EN: Collection of special properties (inventory units) associated with this co-ownership.

            '
          type: array
          items:
            $ref: '#/components/schemas/InventorySpecialProperty'
    BuildingSavingPlan:
      description: 'DE: Information zum Bauspardarlehen. <br/>

        EN: Information about the building saving loan.

        '
      type: object
      properties:
        tariff:
          $ref: '#/components/schemas/SavingPlanTariff'
        amount:
          description: 'DE: Bausparsumme. <br/>

            EN: Saving plan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        contractingDate:
          description: 'DE: Vertragsbeginn. <br/>

            EN: Contract start date.

            '
          $ref: '#/components/schemas/ISODate'
        duration:
          description: 'DE: Darlehensdauer/Gesamtlaufzeit. <br/>

            EN: Loan duration.

            '
          $ref: '#/components/schemas/Duration'
        allocationDate:
          $ref: '#/components/schemas/ISODate'
        savingsPhase:
          $ref: '#/components/schemas/SavingsPhase'
        creditPhase:
          $ref: '#/components/schemas/CreditPhase'
        contractSignedWith:
          description: 'DE: Referenz zu den Antragsteller der den Vetrag unterschrieben hat. <br/>

            EN: Reference to the applicant who signed the contract.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        remark:
          type: string
        contractNumber:
          type: string
          readOnly: true
          description: 'DE: Vertragsnummer. <br/> EN: Contract number.

            '
        commission:
          $ref: '#/components/schemas/CommissionInfo'
    CounterOfferAnnuityRateDetails:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseCounterOfferRateDetails'
      properties:
        amortisationRate:
          description: 'DE: Tilgungsrate (Prozent pro Periode). <br/>

            EN: Amortisation rate (percent per period).

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
    SavingsPlanBurdenSpecialPaymentPeriod:
      type: object
      required:
      - from
      - to
      properties:
        from:
          $ref: '#/components/schemas/ISODate'
        to:
          $ref: '#/components/schemas/ISODate'
    FinancialStandingRef:
      type: object
      description: 'A Reference to a specific FinancialStanding.


        This reference consists of a link leads directly to the resource and an Id which could be used to reconstruct the url.

        '
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        financialStandingId:
          $ref: '#/components/schemas/FinancialStandingId'
    PreviousOwnerKey:
      type: string
      description: 'DE: Vorheriger Immobilienbesitzer (nicht abschließende Aufzählung), z.B. THIRD_PERSON, FAMILY_MEMBER. <br/> EN: Open ended enum contains previous owner of the estate, possible values are THIRD_PERSON, FAMILY_MEMBER.

        '
      example: THIRD_PERSON
      x-extensible-enum:
      - THIRD_PERSON
      - FAMILY_MEMBER
    Plot:
      description: 'DE: Zusätzliche Information zu der Immobilie von Typ "PLOT" (Grundstück). <br/>

        EN: Additional information for the estate with the type "PLOT".

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseRealEstate'
      properties:
        rating:
          $ref: '#/components/schemas/LandValueEvaluation'
        marketValue:
          $ref: '#/components/schemas/MarketValueEvaluation'
        landSize:
          description: 'DE: Grundstücksgröße. <br/>

            EN: Property space.

            '
          $ref: '#/components/schemas/SquareMeter'
        originalPurchase:
          $ref: '#/components/schemas/OriginalPurchase'
    FinancingVentureRenovation:
      description: 'DE: Information über das Finanzierungsvorhaben beim Umbau / Modernisierung. <br/>

        EN: Information about the financing venture for refurbishment / modernisation.

        '
      required:
      - financingNeed
      - financingDetails
      allOf:
      - $ref: '#/components/schemas/BaseFinancingVenture'
      properties:
        financingNeed:
          $ref: '#/components/schemas/OwnEstateFinancingNeed'
        financingDetails:
          $ref: '#/components/schemas/FinancingDetails'
    ApartmentFloorKey:
      type: string
      description: 'DE: Lage des Appartments im Gebäude (nicht abschließende Aufzählung), zum Beispiel: BASEMENT=Untergeschoss, GROUND_FLOOR=Erdgeschoss, UPPER_FLOOR=Obergeschoss/Erster Stock, SECOND_FLOOR=Zweiter Stock etc. <br/> EN: open ended enum contains position of the apartment in the building, possible values are BASEMENT, GROUND_FLOOR, UPPER_FLOOR, SECOND_FLOOR, THIRD_FLOOR, FOURTH_FLOOR, FIFTH_FLOOR, SIXTH_FLOOR_OR_HIGHER

        '
      example: BASEMENT
      x-extensible-enum:
      - BASEMENT
      - GROUND_FLOOR
      - UPPER_FLOOR
      - SECOND_FLOOR
      - THIRD_FLOOR
      - FOURTH_FLOOR
      - FIFTH_FLOOR
      - THIRD_FOURTH_OR_FIFTH_FLOOR
      - SIXTH_FLOOR_OR_HIGHER
      - OTHER
    BaseOccupation:
      type: object
      required:
      - type
      properties:
        type:
          description: 'DE: Art der Erwerbstätigkeit. <br/> EN: Type of the occupation.

            '
          $ref: '#/components/schemas/OccupationType'
        crosser:
          type: boolean
          nullable: true
          description: 'DE: WAHR, wenn der Antragsteller Grenzgänger ist. <br/> EN: TRUE, if applicant is cross-border commuter.

            '
        mainEmployment:
          type: boolean
          nullable: true
          description: 'DE: WAHR, wenn es sich bei der Tätigkeit um eine Hauptbeschäftigung handelt. <br/> EN: TRUE, if occupation is main employment

            '
        retirementDate:
          description: 'DE: Voraussichtlicher Renteneintritt. <br/> EN: Expected retirement date.

            '
          $ref: '#/components/schemas/ISODate'
      discriminator:
        propertyName: type
    ContractLimitation:
      type: object
      description: 'DE: Informationen ob der Vertrag befristet ist. <br/> EN: Information about contract limitation.

        '
      required:
      - limited
      properties:
        limited:
          description: 'DE: Wahr, wenn der Vertrag zeitlich befristet ist. <br/> EN: True, if the contract is temporal limited.

            '
          type: boolean
      discriminator:
        propertyName: limited
        mapping:
          true: '#/components/schemas/LimitedContract'
          false: '#/components/schemas/UnlimitedContract'
    FinancingVentureDebtRescheduling:
      description: 'DE: Information über das Finanzierungsvorhaben beim Anschlussfinanzierung / Umschuldung. <br/>

        EN: Information about the financing venture for follow-up financing / rescheduling.

        '
      required:
      - financingNeed
      - financingDetails
      allOf:
      - $ref: '#/components/schemas/BaseFinancingVenture'
      properties:
        financingNeed:
          $ref: '#/components/schemas/OwnEstateFinancingNeed'
        financingDetails:
          $ref: '#/components/schemas/FinancingDetails'
    LoanType:
      type: string
      description: 'DE: Art des Darlehens (nicht abschließende Aufzählung), z.B. MAIN_LOAN, AUXILIARY_LOAN, KFW_PROMOTION_LOAN. <br/> EN: Open ended enum contains possible loan types, possible values are MAIN_LOAN, AUXILIARY_LOAN, KFW_PROMOTION_LOAN.

        '
      example: MAIN_LOAN
      x-extensible-enum:
      - MAIN_LOAN
      - AUXILIARY_LOAN
      - KFW_PROMOTION_LOAN
      - OTHER
    RealEstateRating:
      oneOf:
      - $ref: '#/components/schemas/HouseRating'
      - $ref: '#/components/schemas/DefaultRealEstateRating'
      discriminator:
        propertyName: type
        mapping:
          HOUSE: '#/components/schemas/HouseRating'
          DEFAULT: '#/components/schemas/DefaultRealEstateRating'
    ISODate:
      description: 'DE: Datum, Syntax nach <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339</a><br/> EN: Date according to <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339</a>

        '
      type: string
      format: date
      nullable: true
      example: '2019-12-29'
    CalculationBaseRate:
      type: object
      required:
      - baserateInterest
      properties:
        baserateInterest:
          $ref: '#/components/schemas/RawPercentage'
        baserateIssueDate:
          description: 'DE: Einstandsdatum. <br/>

            EN: Base rate issue date.

            '
          $ref: '#/components/schemas/ISODate'
    CounterOfferRateDetails:
      oneOf:
      - $ref: '#/components/schemas/CounterOfferAnnuityRateDetails'
      - $ref: '#/components/schemas/CounterOfferSuspendedAmortizationRateDetails'
      discriminator:
        propertyName: rateType
        mapping:
          ANNUITY: '#/components/schemas/CounterOfferAnnuityRateDetails'
          SUSPENDED_AMORTIZATION: '#/components/schemas/CounterOfferSuspendedAmortizationRateDetails'
    UserId:
      type: object
      required:
      - value
      description: 'DE: ID des Users. <br/> EN: ID of a user.

        '
      properties:
        value:
          type: string
    RepaymentPlan:
      type: object
      properties:
        loanId:
          $ref: '#/components/schemas/LoanId'
        planTemplate:
          $ref: '#/components/schemas/PlanTemplate'
        loan:
          $ref: '#/components/schemas/LoanPlan'
        buildingSavingPlan:
          $ref: '#/components/schemas/SavingsAndRepayment'
    Processor:
      description: 'DE: Informationen zur Bearbeiter des Kreditgebers, welche die Einreichung bearbeitet. EN: The processor who is working on a submission.

        '
      required:
      - processorId
      properties:
        processorId:
          $ref: '#/components/schemas/ProcessorId'
        processorName:
          readOnly: true
          $ref: '#/components/schemas/ProcessorName'
    SubmissionRejection:
      type: object
      required:
      - reasons
      properties:
        reasons:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/RejectReason'
        remark:
          type: string
    FinancialStandingSummary:
      type: object
      properties:
        totalIncome:
          description: 'DE: Nettoeinkommen

            EN: Total net income

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        totalExpenses:
          description: 'DE: Ausgaben

            EN: Total expenses

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        surplus:
          description: 'DE: Haushaltsüberschus- Restliquidität nach Finanzierung

            EN: Remaining liquidity after financing

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        reserves:
          description: 'DE: Rücklagen

            EN: Total reserves after financing

            '
          $ref: '#/components/schemas/EuroAmount'
        totalLiabilities:
          description: 'DE: Summe Verbindlingkeiten

            EN: Total liabilities

            '
          $ref: '#/components/schemas/EuroAmount'
    RateDetailsType:
      type: string
      description: 'DE: Mögliche Darlehensart (nicht abschließende Aufzählung), z.B. ANNUITY=Annuitätsdarlehen, SUSPENDED_AMORTIZATION=Tilgungsaussetzungsdarlehen. <br/>

        EN: Open ended enum contains possible rates type, possible values are ANNUITY, SUSPENDED_AMORTIZATION.

        example: ANNUITY

        '
      x-extensible-enum:
      - ANNUITY
      - SUSPENDED_AMORTIZATION
    ModernisationScopeKey:
      type: string
      description: 'DE: Umfang der Modernisierung (nicht abschließende Aufzählung), z.B. (COMPLETE=komplett, PARTIAL=teilweise, UNKNOWN=unbekannt). <br/> EN: Open ended enum contains scope of the modernisation, possible values are (COMPLETE, PARTIAL, UNKNOWN).

        '
      example: COMPLETE
      x-extensible-enum:
      - COMPLETE
      - PARTIAL
      - UNKNOWN
    ForeignEstateFinancingNeed:
      oneOf:
      - $ref: '#/components/schemas/BuildEstateFinancing'
      - $ref: '#/components/schemas/BuyExistingEstateFinancing'
      - $ref: '#/components/schemas/BuyNewEstateFinancing'
      discriminator:
        propertyName: reason
        mapping:
          BUILD: '#/components/schemas/BuildEstateFinancing'
          BUY_EXISTING: '#/components/schemas/BuyExistingEstateFinancing'
          BUY_NEW: '#/components/schemas/BuyNewEstateFinancing'
    PlannedModernisations:
      type: object
      description: 'DE: Wertsteigernde Maßnahmen bei der Modernisierung <br/> EN: Value-enhancing renovations

        '
      properties:
        amount:
          description: 'DE: Modernisierungskosten <br/>

            EN: Modernisation costs

            '
          $ref: '#/components/schemas/EuroAmount'
        addedValue:
          description: 'DE: Wert erreicht durch Modernisierungsmaßnahmen <br/>.

            EN: Added value achieved with modernisation

            '
          $ref: '#/components/schemas/EuroAmount'
        description:
          type: string
        energyEfficiency:
          $ref: '#/components/schemas/EnergyEfficiency'
        breakdown:
          description: 'DE: Detailinformation über die geplanten Modernisierungsmaßnahmen <br/>

            EN: Details about planed modernisations

            '
          type: array
          items:
            $ref: '#/components/schemas/PlannedModernisation'
          x-is-plural: true
    CreditLoans:
      type: object
      description: 'A wrapper Type to hold a set of submission credit loans.

        '
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CreditLoanItem'
    ApproveSubmissionCommand:
      description: command to approve a submission during credit decision phase providing information.
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
    LandValueEvaluation:
      type: object
      description: 'DE: Information über den Land Wert des Grundstücks. <br/> EN: Information about land value evaluation.

        '
      required:
      - groundValue
      properties:
        groundValue:
          description: 'DE: Land Wert. <br/>

            EN: Land value.

            '
          $ref: '#/components/schemas/EuroAmount'
        evaluationInformation:
          description: 'DE: Information über die Wertbewertung des Grundstücks. <br/>

            EN: Information about the land value evaluation.

            '
          $ref: '#/components/schemas/EvaluationInformation'
    FinancingApplicationRef:
      type: object
      description: 'A reference to a specific financing application resource.


        This reference consists of a link which leads directly to the resource and an Id which could be used to reconstruct the url.

        '
      required:
      - id
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        id:
          $ref: '#/components/schemas/FinancingApplicationId'
    BuildEstateFinancing:
      description: 'DE: Finanzierungsrelevante Information zu dem Bau der Immobilie. <br/>

        EN: Financing-relevant information for the construction of the property.

        '
      type: object
      required:
      - buildCosts
      allOf:
      - $ref: '#/components/schemas/BaseForeignEstateFinancingNeed'
      properties:
        buildCosts:
          $ref: '#/components/schemas/EstateBuildingCosts'
        completionDate:
          description: 'DE: Geplante Fertigstellung. <br/>

            EN: Planed completion date.

            '
          $ref: '#/components/schemas/ISODate'
    ApplicantRelationshipTypeKey:
      type: string
      description: 'DE: Beziehungsart (nicht abschließende Aufzählung) z.B. (MARRIED=mit Ehepartner/in, REGISTERED_PARTNERSHIP=eingetragenem Lebenspartner/in, PARTNERSHIP=Lebenspartner/in). <br/>

        EN: Open ended enum contains values for relation type, possible values are (MARRIED, REGISTERED_PARTNERSHIP, PARTNERSHIP)

        '
      x-extensible-enum:
      - MARRIED
      - REGISTERED_PARTNERSHIP
      - PARTNERSHIP
      - OTHER
    ContractInfoReferenceId:
      type: object
      description: 'DE: Referenz zu einem Baustein, dessen Vertragsnummer aktualisiert werden soll. EN: Reference to a component whose contract number should be updated.

        '
      properties:
        value:
          type: string
    EstateAdditionalLoanUsageKey:
      type: string
      description: 'DE: Zusätzliche Verwendung der Hypothek (nicht abschließende Aufzählung), z.B. OPERATIONAL_COSTS, REPAY_ANOTHER_LOAN, PREPAYMENT_PENALTY, CONSTRUCTION, RENOVATION, OTHER. <br/> EN: Open ended enum contains possible estate additional loan usages, possible values are OPERATIONAL_COSTS, REPAY_ANOTHER_LOAN, PREPAYMENT_PENALTY, CONSTRUCTION, RENOVATION, OTHER.

        '
      example: OPERATIONAL_COSTS
      x-extensible-enum:
      - OPERATIONAL_COSTS
      - REPAY_ANOTHER_LOAN
      - PREPAYMENT_PENALTY
      - CONSTRUCTION
      - RENOVATION
      - OTHER
    MarketValueEvaluation:
      type: object
      description: 'DE: Information über eine externe Marktbewertung. <br/> EN: Information about external market value evaluation.

        '
      required:
      - marketValue
      properties:
        marketValue:
          description: 'DE: Marktwert der Immobilie. <br/>

            EN: Estate market value.

            '
          $ref: '#/components/schemas/EuroAmount'
        evaluationInformation:
          description: 'DE: Information über die Wertbewertung der Immobilie. <br/>

            EN: Information about the estate value evaluation.

            '
          $ref: '#/components/schemas/EvaluationInformation'
    ForwardExistingMortgage:
      type: object
      description: 'DE: Das Darlehen soll erst nach einer bestimmten Vorlaufzeit ausgezahlt werden. <br/> EN: Loan shall be released.

        '
      properties:
        date:
          $ref: '#/components/schemas/ISODate'
    BrokeragePlatformIdentifierKey:
      type: string
      description: 'DE: Interne Vermittler Quelle, wichtig für ermitteln des Vermittlernummers.</br>

        EN: Advisor company key, used to determine company identifier.

        '
      example: INTERHYP
      x-extensible-enum:
      - INTERHYP
      - PROHYP
      - MLP_HYP
    SystemCommandTrigger:
      type: object
      required:
      - name
      allOf:
      - $ref: '#/components/schemas/BaseCommandTrigger'
      properties:
        name:
          type: string
        description:
          type: string
    BaseSubmissionStatus:
      type: object
      description: 'EN: Basic submission status representation

        '
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/SubmissionStatusType'
        remark:
          description: short comment regarding the status
          type: string
        changedOn:
          description: timestamp as of the status has been set.
          $ref: '#/components/schemas/ISODateTime'
      discriminator:
        propertyName: type
    AreaInfo:
      type: object
      description: 'DE: Information über die gesamte Wohn- und Nutzfläche. <br/> EN: Information about the total residential and useable area.

        '
      properties:
        areaRented:
          description: 'DE: Vermietete Fläche. <br/>

            EN: Rented space.

            '
          $ref: '#/components/schemas/SquareMeter'
        areaTotal:
          description: 'DE: Wohnfläche. <br/>

            EN: Living space.

            '
          $ref: '#/components/schemas/SquareMeter'
        landSize:
          description: 'DE: Grundstücksgröße. <br/>

            EN: Property space.

            '
          $ref: '#/components/schemas/SquareMeter'
        commercialArea:
          description: 'DE: Gewerbliche Fläche. <br/>

            EN: Commercial space.

            '
          $ref: '#/components/schemas/SquareMeter'
        commercialAreaForOwnUse:
          description: 'DE: Gewerbliche Fläche für Eigenbedarf. <br/>

            EN: Commercial space for own use.

            '
          $ref: '#/components/schemas/SquareMeter'
    ExistingRealEstateDebt:
      type: object
      required:
      - estate
      allOf:
      - $ref: '#/components/schemas/BaseExistingLoanDebt'
      properties:
        estate:
          description: 'DE: Referenz zu dem Darlehen gehörenden Immobileie. <br/>

            EN: Reference to the Estate which this Loan is associated with.

            '
          $ref: '#/components/schemas/EstateRef'
        residualDebt:
          description: 'DE: Aktuelle Restschuld. <br/>

            EN: Current remaining debt.

            '
          $ref: '#/components/schemas/EuroAmount'
        repay:
          description: 'DE: Flag ob die Ablösung des Kredites vor der Finanzierung geplant ist. <br/> EN: Flag indicates that the loan is planed to be repayed before the financing.

            '
          type: boolean
          nullable: true
        until:
          $ref: '#/components/schemas/ISODate'
        interestFixDate:
          description: 'DE: Ablauf Sollzinsbindung. <br/>

            EN: Expiry of fixed interest rate.

            '
          $ref: '#/components/schemas/ISODate'
        description:
          type: string
        interestRate:
          description: 'DE: Nominalzins (Sollzins) <br/> EN: Nominal interest rate

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        debitor:
          $ref: '#/components/schemas/Debitor'
        debitInterestCommitment:
          $ref: '#/components/schemas/Duration'
        expectedEndOfTheTerm:
          $ref: '#/components/schemas/ISODate'
        rankingInTheLandRegister:
          type: string
    BuildingSavingPlanInterestRateUpdate:
      description: details of building saving plan interest rate update
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseInterestRateUpdate'
      properties:
        savingPhaseInterestRate:
          $ref: '#/components/schemas/SavingsPlanInterest'
        creditPhaseInterestRate:
          $ref: '#/components/schemas/InterestRate'
    SavingsPhase:
      type: object
      description: Sparphase
      properties:
        timeline:
          $ref: '#/components/schemas/SavingsPlanTimeline'
        savings:
          $ref: '#/components/schemas/SavingsPlanBurden'
        interest:
          $ref: '#/components/schemas/SavingsPlanInterest'
        contractFees:
          $ref: '#/components/schemas/SavingsPlanFees'
        accountBalanceAtAllocation:
          description: 'DE: Bausparguthaben bei Zuteilung. <br/> EN: The account balance at the moment of allocation.

            '
          $ref: '#/components/schemas/EuroAmount'
        currentBalance:
          description: 'DE: Aktuelles Bausparguthaben.

            '
          allOf:
          - $ref: '#/components/schemas/EuroAmount'
    HomePurchaseSavingProvider:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/HomePurchaseSavingProviderKey'
    SubmissionDataViolation:
      description: a specific submission violation
      type: object
      required:
      - description
      properties:
        code:
          type: string
        description:
          type: string
        proposedSolution:
          type: string
        severity:
          $ref: '#/components/schemas/SubmissionDataViolationSeverity'
    ExternalProcessingDetail:
      type: object
      required:
      - reason
      properties:
        reason:
          $ref: '#/components/schemas/ExternalProcessingReason'
    CreditEntry:
      type: object
      required:
      - creditBurden
      - creditInterest
      - fees
      - remainingCreditAmount
      description: The object for a single credit entry regarding the cash flow.
      properties:
        creditBurden:
          description: The credit rate in EUR (Darlehensrate).
          $ref: '#/components/schemas/EuroAmount'
        creditInterest:
          description: The credit interest in EUR (Sollzinsen).
          $ref: '#/components/schemas/EuroAmount'
        fees:
          description: The fees in EUR (Gebühren).
          $ref: '#/components/schemas/EuroAmount'
        remainingCreditAmount:
          description: The remaining credit amount in EUR (Restschuld bei Periodenende).
          $ref: '#/components/schemas/EuroAmount'
    ShortTimeWork:
      type: object
      description: "DE: Kurzarbeit<br/> \nEN: Short time work.\n"
      properties:
        shortTimeWork:
          type: boolean
          default: true
        from:
          description: 'DE: Beginndatum der Kurzarbeit<br/>

            EN: Startdate of short time work

            '
          $ref: '#/components/schemas/ISODate'
        to:
          description: 'DE: Endenndatum der Kurzarbeit<br/>

            EN: End date of short time work

            '
          $ref: '#/components/schemas/ISODate'
    RejectSubmissionCounterOfferReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RejectSubmissionCounterOfferReasonKey'
    SubmissionCounterOfferCommandData:
      type: object
      required:
      - components
      - offerDate
      - remark
      properties:
        components:
          description: 'DE: Tranchen die ein Gegenangebot abbilden. <br/>

            EN: Tranches that are associated with a counter offer.

            '
          type: array
          items:
            $ref: '#/components/schemas/CounterOfferLoan'
          minItems: 1
        validUntil:
          description: 'DE: Ablaufdatum des Angebots. <br/>

            EN: Offer expiration date.

            '
          $ref: '#/components/schemas/ISODateTime'
        offerDate:
          description: 'DE: Angebotsdatum. <br/>

            EN: Offer creation date.

            '
          $ref: '#/components/schemas/ISODate'
        remark:
          type: string
    ModernisationType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ModernisationTypeKey'
    CounterOfferSuspendedAmortizationRateDetails:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseCounterOfferRateDetails'
      properties:
        combinedProduct:
          $ref: '#/components/schemas/CounterOfferSuspendedAmortizationCombinedProduct'
    HouseholdProductCalculation:
      description: 'DE: Information zu der Haushalt Kalkulation <br/>

        EN: Information about the household calculation.

        '
      type: object
      required:
      - type
      - expenses
      - income
      - lender
      - surplus
      allOf:
      - $ref: '#/components/schemas/BaseProductCalculation'
      properties:
        remainingDebtAt:
          $ref: '#/components/schemas/RemainingDebtAt'
        income:
          $ref: '#/components/schemas/HouseholdCalculationCommandIncome'
        expenses:
          $ref: '#/components/schemas/HouseholdCalculationCommandExpenses'
        surplus:
          description: Der Haushaltsueberschuss
          $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        lender:
          type: string
          description: Darlehensgeber
        billType:
          type: string
          description: 'Household Bill Type: DEFAULT: default household bill (usually applicable at the start of the financing), RETIREMENT: household bill to be used for after retirement'
          x-extensible-enum:
          - RETIREMENT
          - DEFAULT
    SubmissionAwaitExternalProcessingStatus:
      type: object
      description: 'EN: Status containing information about external processing

        '
      required:
      - type
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        previousStatus:
          $ref: '#/components/schemas/SubmissionStatus'
        externalProcessing:
          $ref: '#/components/schemas/ExternalProcessing'
    StatSource:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/StatSourceKey'
    LoanConditionGeneralInfo:
      description: 'DE: Allgemeine Information zu den Darlehen (Konditionskalkulation). <br/>

        EN: General loan information (conditions calculation).

        '
      type: object
      properties:
        loanAmount:
          description: 'DE: Gesamter Darlehnsbetrag. <br/>

            EN: Total loan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        loanQuota:
          description: 'DE: Darlehnsquote (Prozentsatz) <br/>

            EN: Loan quota (percentage).

            '
          $ref: '#/components/schemas/Percentage'
        mixedEffectiveRate:
          description: 'DE: Mischzins (effektiv). <br/>

            EN: Mixed effective rate.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        baserateIssueDate:
          description: 'DE: Einstandsdatum. <br/>

            EN: Base rate issue date.

            '
          $ref: '#/components/schemas/ISODate'
        burden:
          description: 'DE: Periodische Rate (z.B. monatliche Rate). <br/>

            EN: Periodical payment amount (e.g. rate per month).

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        paymentTime:
          $ref: '#/components/schemas/PaymentTime'
    EstateItem:
      type: object
      required:
      - estateId
      - type
      description: 'A wrapper that holds basic information about estate.

        '
      properties:
        ref:
          description: 'DE: Id und Referenz zu der Immobilie. <br/> EN: Id and Reference to the estate.

            '
          $ref: '#/components/schemas/EstateRef'
        type:
          description: 'DE: Immobilientyp. <br/> EN: Type of the estate.

            '
          $ref: '#/components/schemas/PropertyType'
        embedded:
          description: 'DE: Vollständige Daten zu der Immobilie. <br/> EN: Complete data about the estate.

            '
          $ref: '#/components/schemas/Estate'
    CounterOfferBuildingSavingLoan:
      description: "DE: Information zum Gegenangebot Bausparer. <br/>\nEN: Information about the counter offer building saving loan.\n    type: object\n"
      required:
      - amount
      - commission
      - creditPhase
      - savingsPhase
      allOf:
      - $ref: '#/components/schemas/BaseCounterOfferSuspendedAmortizationCombinedProduct'
      properties:
        amount:
          description: 'DE: Darlehnsbetrag (per Tranche). <br/>

            EN: Loan amount (for loan component).

            '
          $ref: '#/components/schemas/EuroAmount'
        commission:
          $ref: '#/components/schemas/CommissionInfo'
        creditPhase:
          $ref: '#/components/schemas/CounterOfferBuildingSavingLoanCreditPhase'
        savingsPhase:
          $ref: '#/components/schemas/CounterOfferBuildingSavingLoanSavingsPhase'
    InventorySpecialProperty:
      type: object
      properties:
        number:
          description: 'DE: Nummer des Sondereigentums (z. B. Wohnungsnummer). <br/> EN: Number of the special property (e.g. apartment number).

            '
          type: string
        type:
          $ref: '#/components/schemas/SpecialPropertyType'
    JobProbation:
      type: object
      required:
      - probationPeriodEndDate
      properties:
        probationPeriodEndDate:
          $ref: '#/components/schemas/ISODate'
    ApplicationSubType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ApplicationSubTypeKey'
    SavingsPlanTimeline:
      type: object
      properties:
        startDate:
          description: 'DE: Sparbeginn. <br/> EN: Saving start date.

            '
          $ref: '#/components/schemas/ISODate'
        endDate:
          description: 'DE: Datum letzter Sparbeitrag. <br/> EN: The end date of the savings phase.

            '
          $ref: '#/components/schemas/ISODate'
        duration:
          description: 'DE: Voraussichtliche Anspardauer. <br/>

            EN: Expected saving duration.

            '
          $ref: '#/components/schemas/Duration'
    ParcelAndDistrict:
      description: 'DE: Information über Gemarktung und Flurstück. <br/> EN: Information about the cadastral district and the land parcel.

        '
      required:
      - parcel
      properties:
        district:
          description: 'DE: Gemarkung/Bezirk. <br/> EN: Cadastral district.

            '
          type: string
        corridor:
          description: 'DE: Flur. <br/> EN: Corridor.

            '
          type: string
        parcel:
          description: 'DE: Flurstück. <br/> EN: Land parcel.

            '
          type: string
    SolvencyCreditDebt:
      type: object
      description: 'DE: Raten- und Leasingkredite. <br/> EN: Installment and leasing credits.

        '
      allOf:
      - $ref: '#/components/schemas/BaseExistingLoanDebt'
      properties:
        liabilityType:
          $ref: '#/components/schemas/Liability'
        contractNumber:
          type: string
        residualDebt:
          description: 'DE: Aktuelle Restschuld. <br/>

            EN: Current remaining debt.

            '
          $ref: '#/components/schemas/EuroAmount'
        repay:
          description: 'DE: Flag ob die Ablösung des Kredites vor der Finanzierung geplant ist. <br/> EN: Flag indicates that the loan is planed to be repayed before the financing.

            '
          type: boolean
          nullable: true
        until:
          description: 'DE: Ablauf der Sollzinsbindung. <br/>

            EN: Expiry of the fixed interest rate.

            '
          $ref: '#/components/schemas/ISODate'
        burden:
          description: 'DE: Periodische Rate (z.B. monatliche Rate). <br/>

            EN: Periodical payment amount (e.g. rate per month).

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        debitor:
          $ref: '#/components/schemas/Debitor'
    ContractDeliveredStatus:
      type: object
      description: 'EN: Status containing information about delivered contract

        '
      required:
      - type
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        contractDeliverDate:
          $ref: '#/components/schemas/ISODate'
        contracts:
          type: array
          items:
            $ref: '#/components/schemas/ExtendedContractInfo'
    LoanToValueRatioLendingBreakdown:
      title: LoanToValueRatioLendingBreakdown
      type: object
      required:
      - valuation
      - entries
      properties:
        valuation:
          description: Die Summe der Gesamtwerte, die die Bank ansetzt in Euro
          $ref: '#/components/schemas/RawEuroAmount'
        entries:
          type: array
          items:
            $ref: '#/components/schemas/LoanToValueRatioEntry'
    BuyExistingEstateFinancing:
      description: 'DE: Finanzierungsrelevante Information zu dem Kauf bestehender Immobilie. <br/>

        EN: Financing-relevant information for the purchase of an existing property.

        '
      type: object
      required:
      - purchasePrice
      allOf:
      - $ref: '#/components/schemas/BaseForeignEstateFinancingNeed'
      properties:
        renovationCosts:
          description: 'DE: Summe der durchgeführten wertsteigernden Maßnahmen bei der Renovierung. <br/> EN: Sum of completed value-enhancing refurbishments.

            '
          $ref: '#/components/schemas/EuroAmount'
        plannedModernisations:
          $ref: '#/components/schemas/PlannedModernisations'
        purchasePrice:
          description: 'DE: Kaufpreis der Immobilie. <br/>

            EN: Purchase price of the property.

            '
          $ref: '#/components/schemas/EuroAmount'
        priceDue:
          description: 'DE: Fälligkeit des Kaufpreises. <br/>

            EN: Due date of the purchase price.

            '
          $ref: '#/components/schemas/ISODate'
        notaryDate:
          description: 'DE: Notartermin. <br/>

            EN: Notary date.

            '
          $ref: '#/components/schemas/ISODate'
    SubmissionProcessingPausedStatus:
      type: object
      description: 'EN: Status containing information about pausing the processing

        '
      required:
      - type
      - reason
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        previousStatus:
          $ref: '#/components/schemas/SubmissionStatus'
        reason:
          $ref: '#/components/schemas/PauseReason'
        dueDate:
          $ref: '#/components/schemas/ISODate'
        predictedDaysPost:
          type: integer
          format: int32
    RevokeSubmissionRejectionCommand:
      description: command to revert a rejection of a submission during credit decision phase.
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
    FinancialStandings:
      type: object
      description: 'Wrapper Type holds set of Financial Standings.

        '
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FinancialStandingItem'
        summary:
          $ref: '#/components/schemas/FinancialStandingSummary'
    RefuseSignContractReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RefuseSignContractReasonKey'
    AssignSubmissionLoanPartnerProcessorDetailsCommand:
      description: assign processing using details
      type: object
      required:
      - processor
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        processor:
          $ref: '#/components/schemas/ProcessorDetails'
    RegularPayment:
      description: 'DE: Information über den regulären Zahlungen. <br/>

        EN: Information about regular payment.

        '
      type: object
      properties:
        paymentTime:
          $ref: '#/components/schemas/PaymentTime'
        freePeriod:
          description: 'DE: Tilgungsfreie Anlaufzeit. <br/>

            EN: Amortisation-free period.

            '
          $ref: '#/components/schemas/Duration'
        amount:
          description: 'DE: Rate in der tilgungsfreien Anlaufzeit. <br/>

            EN: Amortisation during amortisation-free period.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        amountAfterFreePeriod:
          description: 'DE: Rate nach Ablauf der tilgungsfreien Anlaufzeit. <br/>

            EN: Rate after amortisation-free period.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    ParkingSpace:
      type: object
      required:
      - type
      description: 'DE: Information über den Parkplatz. <br/> EN: Information about the parking space.

        '
      properties:
        type:
          $ref: '#/components/schemas/ParkingSpaceType'
        pitchNumber:
          description: 'DE: Stellplatznummer. <br/> EN: Parking Space Number.

            '
          type: string
        count:
          description: 'DE: Anzahl Parkplätze von diesem Typ. <br/> EN: Number of parking spaces of this type.

            '
          type: integer
          format: int32
    MainLoanAdditionalInfo:
      type: object
      description: 'DE: Zustzäliche Information zum Hauptdarlehen. <br/> EN: Additional informations for main loan.

        '
      properties:
        conditionDetails:
          type: array
          description: 'DE: Zusätzliche Konditionsdetails für das Hauptdarlehen (Schlüssel-Werte Paar). <br/> EN: Additional condition details for the main loan (key-value pairs).

            '
          items:
            $ref: '#/components/schemas/AdditionalInfo'
        provisionDetails:
          type: array
          description: 'DE: Zusätzliche Provisionsdetails für das Hauptdarlehen (Schlüssel-Werte Paar). <br/> EN: Additional commission (provision) details for the main loan (key-value pairs).

            '
          items:
            $ref: '#/components/schemas/AdditionalInfo'
    LoanConditionInterest:
      description: 'DE: Zusammenfassung von Informationen zu einzelnem Darlehen (Konditionskalkulation). <br/>

        EN: Summary information about single loan (conditions calculation).

        '
      type: object
      required:
      - effectiveRate
      - nominalRate
      properties:
        effectiveRate:
          description: 'DE: Effektiver Zins. <br/>

            EN: Effective interest rate.

            '
          $ref: '#/components/schemas/PeriodicalRawPercentage'
        nominalRate:
          description: 'DE: Sollzins <br/>

            EN: Nominal rate.

            '
          $ref: '#/components/schemas/PeriodicalRawPercentage'
    CreditPhaseTimeline:
      type: object
      properties:
        amortisationStartDate:
          description: 'DE: Tilgungsbeginn. <br/> EN: The date on which the amortisation starts.

            '
          $ref: '#/components/schemas/ISODate'
        amortisationEndDate:
          description: 'DE: Tilgungsende. <br/> EN: The date on which the amortisation end.

            '
          $ref: '#/components/schemas/ISODate'
        duration:
          description: 'DE: Voraussichtliche Kreditsdaur. <br/>

            EN: credit phase duration.

            '
          $ref: '#/components/schemas/Duration'
    Estate:
      oneOf:
      - $ref: '#/components/schemas/Apartment'
      - $ref: '#/components/schemas/House'
      - $ref: '#/components/schemas/Plot'
      discriminator:
        propertyName: type
        mapping:
          APARTMENT: '#/components/schemas/Apartment'
          DETACHED_HOUSE: '#/components/schemas/House'
          SEMI_DETACHED_HOUSE: '#/components/schemas/House'
          TWO_FAMILY_HOUSE: '#/components/schemas/House'
          END_TERRACE_HOUSE: '#/components/schemas/House'
          MID_TERRACE_HOUSE: '#/components/schemas/House'
          APARTMENT_BUILDING: '#/components/schemas/House'
          RESIDENTIAL_AND_COMMERCIAL_BUILDING: '#/components/schemas/House'
          PROPERTY: '#/components/schemas/Plot'
          COMMERCIAL_PROPERTY: '#/components/schemas/Plot'
    StartProcessingSubmissionCommand:
      description: command to start the processing of a submission.
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
    ConstructionCostInvoiceKey:
      type: string
      description: 'DE: Die Instanz, mit welcher die Abrechnung der Baukosten erfolgt. PROPERTY_DEVELOPER = Bautraeger, GENERAL_CONTRACTOR = Generalunternehmer, ARCHITECT = Architekt, INDIVIDUAL_TRADES = Einzelgewerkvergabe <br/> EN: Open ended enum contains the instance to which the construction costs are charged.

        '
      example: MAP
      x-extensible-enum:
      - PROPERTY_DEVELOPER
      - GENERAL_CONTRACTOR
      - ARCHITECT
      - INDIVIDUAL_TRADES
      - UNKNOWN
    BaseSpecialRepayment:
      type: object
      required:
      - type
      description: 'DE: Information zur Sondertilgung. <br/> EN: Special repayment information.

        '
      properties:
        type:
          $ref: '#/components/schemas/SpecialRepaymentType'
      discriminator:
        propertyName: type
    RevokeSubmissionCounterOfferReasonKey:
      type: string
      description: 'DE: Grund für den Entzug, mögliche Werte sind COUNTER_OFFER_EXPIRED=Gegenangebot kann nicht mehr aufrechterhalten werden, READJUST_COUNTER_OFFER=Gegenangebot soll nach Rücksprache nochmal angepasst werden, COUNTER_OFFER_NOT_ACCEPTED=Gegenangebot wird nicht angenommen, OTHER=Nicht aufgeführter Grund EN: Reason for revocation, possible values are COUNTER_OFFER_EXPIRED, READJUST_COUNTER_OFFER, COUNTER_OFFER_NOT_ACCEPTED, OTHER

        '
      example: OTHER
      x-extensible-enum:
      - COUNTER_OFFER_EXPIRED
      - READJUST_COUNTER_OFFER
      - COUNTER_OFFER_NOT_ACCEPTED
      - OTHER
    RemainingDebtAt:
      type: object
      required:
      - date
      - components
      properties:
        date:
          $ref: '#/components/schemas/ISODate'
        components:
          type: array
          items:
            $ref: '#/components/schemas/RemainingDebtAtComponent'
    SavingsPlanBurdenSpecialPayment:
      type: object
      required:
      - period
      - amount
      properties:
        period:
          $ref: '#/components/schemas/SavingsPlanBurdenSpecialPaymentPeriod'
        amount:
          $ref: '#/components/schemas/EuroAmount'
        frequency:
          description: 'DE: Häufigkeit der Zahlungen. <br/> EN: Frequency of payments

            '
          $ref: '#/components/schemas/Cycle'
    PauseSubmissionProcessingCommand:
      description: command to pause processing of the submission
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
        reason:
          $ref: '#/components/schemas/PauseReason'
        dueDate:
          $ref: '#/components/schemas/ISODate'
    EuroAmount:
      description: 'DE: Euro Betrag as double. <br/> EN: Euro amount as double

        '
      type: object
      required:
      - value
      properties:
        value:
          description: 'DE: Betrag. <br/> EN: Value.

            '
          type: number
          format: double
    FinancingStructures:
      description: 'DE: Information über die Struktur der Finanzierung. <br/>

        EN: Information about the financing structure.

        '
      type: object
      properties:
        amount:
          description: 'DE: Darlehensbetrag. <br/>

            EN: Loan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        interest:
          description: 'DE: Effektiver Zins pro Periode. <br/>

            EN: Effective interest per period.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        burden:
          description: 'DE: Periodische Rate (z.B. monatliche Rate). <br/>

            EN: Periodical payment amount (e.g. rate per month).

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        components:
          description: 'DE: Tranchen die eine Finanzierungsangebot abbilden. <br/>

            EN: Tranches that are associated with financing offer.

            '
          type: array
          items:
            $ref: '#/components/schemas/Loan'
          minItems: 1
        residualDebtProtections:
          description: 'DE: Restschuldabsicherungen.

            EN: Residual debt protections.

            '
          $ref: '#/components/schemas/ResidualDebtProtections'
        calculations:
          description: 'DE: Kalkulationen für die Kreditentscheidung

            EN: Calculations for the credit decision

            '
          type: array
          items:
            $ref: '#/components/schemas/ProductCalculation'
        repaymentPlans:
          description: 'DE: Tilgungsplan

            EN: Repayment plan

            '
          $ref: '#/components/schemas/RepaymentPlans'
    ExtendedPeriodicalCreditEntry:
      type: object
      description: The credit entries including markings for special entries.
      allOf:
      - $ref: '#/components/schemas/PeriodicalCreditEntry'
      properties:
        markings:
          type: array
          items:
            $ref: '#/components/schemas/EntryMarking'
    RealEstate:
      description: 'DE: Allgemeine Information zu der Immobilie. <br/>

        EN: General information about the estate.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseRealEstate'
      properties:
        originalPurchase:
          $ref: '#/components/schemas/OriginalPurchase'
        building:
          $ref: '#/components/schemas/Building'
        condition:
          $ref: '#/components/schemas/RealEstatePropertyCondition'
        furnishing:
          $ref: '#/components/schemas/Furnishing'
        parkingSpaces:
          description: 'DE: Stellplätze und Garagen der Immobilie. <br/> EN: Parking spaces and garages of the property.

            '
          type: array
          items:
            $ref: '#/components/schemas/ParkingSpace'
        existingModernisations:
          $ref: '#/components/schemas/ExistingModernisations'
        area:
          $ref: '#/components/schemas/AreaInfo'
        utilization:
          $ref: '#/components/schemas/Utilization'
        rent:
          $ref: '#/components/schemas/RentInfo'
        numberOfRooms:
          description: 'DE: Anzahl der Zimmer für die angegebene Wohnung EN: Number of rooms for declared apartment

            '
          type: number
          format: float
    OrganizationCompany:
      type: object
      properties:
        companyId:
          $ref: '#/components/schemas/CompanyId'
        companyName:
          $ref: '#/components/schemas/CompanyName'
        companyAddress:
          $ref: '#/components/schemas/Address'
        companyContact:
          $ref: '#/components/schemas/Contact'
        regulatoryAuthority:
          $ref: '#/components/schemas/RegulatoryAuthority'
    BuyNewEstateFinancing:
      type: object
      description: 'DE: Finanzierungsrelevante Information zum Kauf der Neubauimmobilie. <br/>

        EN: Financing-relevant information for the purchase of a newly built property.

        '
      required:
      - purchasePrice
      allOf:
      - $ref: '#/components/schemas/BaseForeignEstateFinancingNeed'
      properties:
        optionalEquipment:
          description: 'DE: Kosten für Sonderausstattungen. <br/>

            EN: Special / optional equipment costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        purchasePrice:
          description: 'DE: Kaufpreis des Objekts. <br/>

            EN: Purchase price.

            '
          $ref: '#/components/schemas/EuroAmount'
        priceDue:
          description: 'DE: Fälligkeit des Kaufpreises. <br/>

            EN: Due date of the purchase price.

            '
          $ref: '#/components/schemas/ISODate'
        notaryDate:
          description: 'DE: Notartermin. <br/>

            EN: Notary date.

            '
          $ref: '#/components/schemas/ISODate'
    HandoverReportBinary:
      type: string
      format: binary
    TextSpecialRepayment:
      description: 'DE: Sondertilgung in Textform. <br/>

        EN: Special repayment presented as text.

        '
      type: object
      required:
      - text
      allOf:
      - $ref: '#/components/schemas/BaseSpecialRepayment'
      properties:
        text:
          description: 'DE: Sondertilgung in Textform. <br/> EN: Special repayment in text format.

            '
          type: string
    FreeLancerJobType:
      type: object
      description: 'DE: Art der freiberuflichen Tätigkeit. <br/> EN: Freelancer job type.

        '
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/FreeLancerJobTypeKey'
    OwnEstateFinancingNeed:
      oneOf:
      - $ref: '#/components/schemas/DebtReschedulingFinancing'
      - $ref: '#/components/schemas/OtherCapitalFinancing'
      - $ref: '#/components/schemas/RenovateEstateFinancing'
      discriminator:
        propertyName: reason
        mapping:
          DEBT_RESCHEDULING: '#/components/schemas/DebtReschedulingFinancing'
          OTHER_CAPITAL: '#/components/schemas/OtherCapitalFinancing'
          RENOVATE: '#/components/schemas/RenovateEstateFinancing'
    BaseRealEstate:
      type: object
      required:
      - id
      - type
      properties:
        id:
          $ref: '#/components/schemas/EstateId'
        type:
          $ref: '#/components/schemas/PropertyType'
        address:
          description: 'DE: Adresse der Immobilie. <br/>

            EN: Estate address.

            '
          $ref: '#/components/schemas/Address'
        propertyRegister:
          $ref: '#/components/schemas/PropertyRegister'
        liabilities:
          type: array
          items:
            $ref: '#/components/schemas/PropertyRegister'
        location:
          $ref: '#/components/schemas/PropertyLocation'
        leaseInfo:
          $ref: '#/components/schemas/LeaseInfo'
        existingMortgages:
          type: array
          description: 'DE: Sammlung von Referenzen zu dem existierenden Hypotheken. <br/>

            EN: Reference collection to the existing mortgages associated with this estate.

            '
          items:
            $ref: '#/components/schemas/ExistingMortgageRef'
        description:
          description: 'DE: Immobilienbeschreibung. <br/>

            EN: Estate description.

            '
          type: string
        externalEstateId:
          $ref: '#/components/schemas/ExternalEstateId'
      discriminator:
        propertyName: type
    SavingsPlanInterest:
      type: object
      properties:
        interestRate:
          description: 'DE: Guthabenzinssatz. <br/> EN: interest rate.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        interestAccumulated:
          description: 'DE: Guthabenzinsen insgesamt. <br/> EN: The savings interest accumulated.

            '
          $ref: '#/components/schemas/EuroAmount'
    HomePurchaseSavingProviderKey:
      type: string
      example: OTHER
      description: Home purchase saving plan provider (BHWDISPO - BHW, DEUTDEFF - Deutsche Bank, ALTEDEFA - Alte Leipziger, LBS - LBS, BSWLDE - Wüstenrot, STARTBS - start:bausparkasse)
      x-extensible-enum:
      - BHWDISPO
      - ALTEDEFA
      - DEUTDEFF
      - LBS
      - BSWLDE
      - STARTBS
      - OTHER
    DefaultUnionInfo:
      allOf:
      - $ref: '#/components/schemas/BaseUnionInfo'
    ResumeSubmissionProcessingCommand:
      description: command to resume submission processing
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
    KfwCallType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/KfwCallTypeKey'
    CreateSubmissionCounterOfferCommand:
      type: object
      description: command to create a counter offer for a specific submission providing all needed information during credit decision phase.
      required:
      - data
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        data:
          $ref: '#/components/schemas/SubmissionCounterOfferCommandData'
    SubmissionCounterOfferCreatedStatus:
      type: object
      description: 'EN: Status containing information about counteroffer that was created

        '
      required:
      - type
      - offer
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        offer:
          $ref: '#/components/schemas/SubmissionCounterOffer'
    SavingsPlanFees:
      type: object
      properties:
        accountFee:
          description: 'DE: Kontoführungsgebühr. <br/>

            EN: Account maintenance fee.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        closingFee:
          description: 'DE: Abschlussgebühr für das Produkt. <br/> EN: Acquisition fee for the product.

            '
          $ref: '#/components/schemas/EuroAmount'
        payedFees:
          description: 'DE: Gebühren insgesamt. <br/> EN: The sum of all the fees payed in the savings phase.

            '
          $ref: '#/components/schemas/EuroAmount'
    MarkingName:
      type: string
      x-extensible-enum:
      - FIXED_INTEREST_RATE_END
      - AMORTIZATION_RATE_CHANGED
      - EXTRA_PAYMENT
      - AGIO
    Debitor:
      type: object
      description: 'DE: Darlehensgeber. <br/>

        EN: Information about loan debitor.

        '
      properties:
        bic:
          description: 'DE: BIC-Code des Darlehensgebers. <br/> EN: BIC code of loaner.

            '
          $ref: '#/components/schemas/Bic'
        name:
          description: 'DE: Schuldner. <br/> EN: Debitor.

            '
          type: string
    Income:
      type: object
      required:
      - type
      description: 'DE: Ein Untertyp von "Financial Standing", welcher alle Informationen zu den `Einkünften` beinhaltet. <br/>

        EN: A specific financial standing type holds all information related to periodical `Income` aspects.

        '
      allOf:
      - $ref: '#/components/schemas/BaseFinancialStanding'
      properties:
        regularEmployment:
          $ref: '#/components/schemas/RegularEmploymentIncome'
        selfEmployment:
          $ref: '#/components/schemas/SelfEmploymentIncome'
        auxiliary:
          $ref: '#/components/schemas/AuxiliaryIncome'
        family:
          $ref: '#/components/schemas/FamilyIncome'
        pension:
          description: 'DE: Zusätzliches regelmäßiges Einkommen aus Rente/Pension. <br/> EN: Additional periodical income from pension.

            '
          $ref: '#/components/schemas/PensionIncome'
        pensionEntitlement:
          description: 'DE: Rentenansprüche. <br/> EN: Pension entitlement.

            '
          $ref: '#/components/schemas/PensionIncome'
        capital:
          $ref: '#/components/schemas/CapitalIncome'
        other:
          $ref: '#/components/schemas/OtherIncome'
    RegularEmploymentIncome:
      type: object
      description: 'DE: Informationen über ein regelmäßiges Einkommen aus einem Beschaeftigungsverhaeltnis. <br/> EN: Information about regular employment income.

        '
      properties:
        salary:
          $ref: '#/components/schemas/Salary'
        variable:
          $ref: '#/components/schemas/VariableIncome'
        grossIncomePreviousYear:
          description: 'DE: Bruttoeinkommen des Vorjahres. <br/>

            EN: Gross income of the previous year.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        taxableIncomePastYears:
          description: 'DE: Zu versteuerndes Einkommen vergangener Jahre. <br/>

            EN: Taxable income of previous years.

            '
          type: array
          items:
            $ref: '#/components/schemas/TaxableIncome'
    LoanConditionDetail:
      description: 'DE: Information über einzelnen Darlehen innerhalb des Konditionskalkulations. <br/>

        EN: Information about single loan which is a part of condition calculation.

        '
      type: object
      properties:
        loanId:
          $ref: '#/components/schemas/LoanId'
        loanType:
          $ref: '#/components/schemas/LoanType'
        amount:
          description: 'DE: Darlehensbetrag. <br/>

            EN: Loan amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        payout:
          description: 'DE: Auszahlung (Prozent). <br/>

            EN: Payout  (percent).

            '
          $ref: '#/components/schemas/Percentage'
        maturity:
          description: 'DE: Dauer der Sollzinsbindung. <br/>

            EN: Duration of interest rate maturity.

            '
          $ref: '#/components/schemas/Duration'
        initialAmortisationRate:
          description: 'DE: Initiale Tilgungsrate (Prozent). <br/>

            EN: Initial amortisation rate (percent).

            '
          $ref: '#/components/schemas/Percentage'
        additionalInfo:
          x-is-plural: true
          type: array
          description: 'DE: Information über einzelnen Eintrag innerhalb des Konditionskalkulation. <br/>

            EN: Information about single entry within condition calculation.

            '
          items:
            $ref: '#/components/schemas/AdditionalInfo'
        summary:
          $ref: '#/components/schemas/LoanConditionSummary'
    AnnuityInterestRateUpdate:
      description: details of annuity interest rate update
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseInterestRateUpdate'
      properties:
        baseInterestRate:
          $ref: '#/components/schemas/InterestRate'
        amortizationRate:
          $ref: '#/components/schemas/PeriodicalPercentage'
    Percentage:
      description: 'DE: Prozentsatz als double. <br/> EN: Percentage as double.

        '
      type: object
      required:
      - value
      properties:
        value:
          description: 'DE: Prozentsatz. <br/> EN: Percentage.

            '
          type: number
          format: double
    BuildingSavingsPlan:
      type: object
      description: Savings plan (Sparplan, Summe Sparplan, letzte Periode Sparplan) including marking for special entries.
      required:
      - entries
      - entriesAggregated
      properties:
        entries:
          description: The array of savings entries (Sparplan).
          items:
            $ref: '#/components/schemas/ExtendedPeriodicalSavingsEntry'
          type: array
        entriesAggregated:
          $ref: '#/components/schemas/SavingsEntry'
    Bic:
      type: object
      description: 'DE: BIC <br/> EN: The Business Identifier Code

        '
      required:
      - value
      properties:
        value:
          type: string
          example: INGBDEFF
          pattern: ^[A-Z]{6}[2-9A-Z]{1}[0-9A-Z]{1}([0-9A-Z]{3})?$
    VariableInterestMaturity:
      description: 'DE: Information über die variable Sollzinsbindung. <br/>

        EN: Information about variable interest rate maturity.

        '
      type: object
      required:
      - type
      allOf:
      - $ref: '#/components/schemas/BaseInterestMaturity'
    MainProductType:
      type: string
      description: 'DE: Produkttyp des Darlehens (nicht abschließende Aufzählung), z.B. (ANNUITAET=Annuitätendarlehen, W_RIESTER=Wohnriesterdarlehen, ZWIFI=Zwischenfinanzierung, FLEX_PLUS, FLEX, FORWARD, KOMBI, KONSTANT, KONST_KOMBI, VERSICHER, VOLLTILGER, OTHER) EN: open ended enum contains loan product type, possible values are (ANNUITAET, W_RIESTER, ZWIFI, FLEX_PLUS, FLEX, FORWARD, KOMBI, KONSTANT, KONST_KOMBI, VERSICHER, VOLLTILGER, OTHER)

        '
      example: ANNUITAET
      x-extensible-enum:
      - ANNUITAET
      - W_RIESTER
      - ZWIFI
      - FLEX_PLUS
      - FLEX
      - FORWARD
      - KOMBI
      - KONSTANT
      - KONST_KOMBI
      - VERSICHER
      - VOLLTILGER
      - OTHER
    PrefabricationKey:
      type: string
      description: 'DE: Besonderheiten der Bauart (nicht abschließende Aufzählung), z.B NO_SPECIFICS=keine_Besonderheiten, PREFABRICATED_Fertighaus, BAREBONES_HOUSE_Ausbauhaus, CONSTRUCTION_KIT_Bausatzhaus . <br/> EN: Open ended enum contains special construction design, possible values are NO_SPECIFICS, PREFABRICATED_HOUSE, GROW_HOUSE, SELF_BUILD_HOUSE .

        '
      example: NO_SPECIFICS
      x-extensible-enum:
      - NO_SPECIFICS
      - PREFABRICATED_HOUSE
      - GROW_HOUSE
      - SELF_BUILD_HOUSE
      - OTHER
    PreSubmissionCheckItems:
      description: Collection of performed pre-submission checks
      type: object
      required:
      - preSubmissionChecks
      properties:
        preSubmissionChecks:
          type: array
          items:
            $ref: '#/components/schemas/PreSubmissionCheckItem'
    Calculation:
      oneOf:
      - $ref: '#/components/schemas/HouseholdCalculation'
      - $ref: '#/components/schemas/ConditionCalculation'
      - $ref: '#/components/schemas/LendingValueCalculation'
      discriminator:
        propertyName: type
        mapping:
          HOUSEHOLD: '#/components/schemas/HouseholdCalculation'
          CONDITION: '#/components/schemas/ConditionCalculation'
          LENDING_VALUE: '#/components/schemas/LendingValueCalculation'
    AtticDetailKey:
      type: string
      description: 'DE: Details zum Dachgeschoss (nicht abschließende Aufzählung), z.B DEVELOPED=ausgebaut, UPGRADEABLE=ausbaufähig, NOT_UPGRADEABLE=nicht_ausbaufähig. <br/> EN: open ended enum contains attic details, possible values are DEVELOPED, UPGRADEABLE, NOT_UPGRADEABLE.

        '
      example: DEVELOPED
      x-extensible-enum:
      - DEVELOPED
      - PARTIALLY_DEVELOPED
      - UPGRADEABLE
      - NOT_UPGRADEABLE
      - OTHER
    LoanPartnerProcessingUnitName:
      description: 'DE: Bezeichnung / Name der Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. <br/> EN: Name of the loan partner processing unit.

        '
      type: object
      properties:
        value:
          type: string
    SuspendedAmortizationCombinedProduct:
      oneOf:
      - $ref: '#/components/schemas/SuspendedAmortizationOtherProduct'
      - $ref: '#/components/schemas/SuspendedAmortizationBuildingSavingProduct'
      discriminator:
        propertyName: product
        mapping:
          OTHER: '#/components/schemas/SuspendedAmortizationOtherProduct'
          DT_KAP_LV: '#/components/schemas/SuspendedAmortizationOtherProduct'
          DT_KAP_RV: '#/components/schemas/SuspendedAmortizationOtherProduct'
          BRIT_KAP_LV: '#/components/schemas/SuspendedAmortizationOtherProduct'
          BRIT_KAP_RV: '#/components/schemas/SuspendedAmortizationOtherProduct'
          FONDS_LV: '#/components/schemas/SuspendedAmortizationOtherProduct'
          FONDS_RV: '#/components/schemas/SuspendedAmortizationOtherProduct'
          FONDS_SPAR: '#/components/schemas/SuspendedAmortizationOtherProduct'
          BAU_SPAR: '#/components/schemas/SuspendedAmortizationBuildingSavingProduct'
    AddSubmissionLogbookNoteCommand:
      description: command to add Logbook note for the submission
      type: object
      required:
      - comment
      - isVisibleForSales
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        comment:
          type: string
        isVisibleForSales:
          type: boolean
    CubicMeter:
      type: object
      description: 'DE: Angabe in Kubikmetern. <br/> EN: Specification in cubic metres.

        '
      required:
      - value
      properties:
        value:
          type: number
          format: double
    Prefabrication:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/PrefabricationKey'
    PeriodicalRepaymentEntry:
      type: object
      allOf:
      - $ref: '#/components/schemas/EntryPeriod'
      required:
      - creditBurden
      - creditInterest
      - creditRepayment
      - remainingCreditAmount
      properties:
        creditInterest:
          description: The interest payed in this period (Sollzins)
          $ref: '#/components/schemas/EuroAmount'
        creditRepayment:
          description: The repayment payed in this period (Tilgungsrate)
          $ref: '#/components/schemas/EuroAmount'
        creditBurden:
          description: The credit burden in this period (Darlehensrate)
          $ref: '#/components/schemas/EuroAmount'
        remainingCreditAmount:
          description: The current credit amount (Darlehensstand)
          $ref: '#/components/schemas/EuroAmount'
        repaymentTotal:
          description: The total repayments payed until (and including) the current period
          $ref: '#/components/schemas/EuroAmount'
        interestTotal:
          description: The total interest payed until (and including) the current period
          $ref: '#/components/schemas/EuroAmount'
        burdenTotal:
          description: The total payments payed until (and including) the current period
          $ref: '#/components/schemas/EuroAmount'
        markings:
          type: array
          items:
            $ref: '#/components/schemas/EntryMarking'
    Inhabitants:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/InhabitantsKey'
    ContractInfoLoanType:
      description: 'DE: Type des Loans dessen Vertragsnummer aktualisiert werden soll. <br/>

        EN: Type of loan where the contract number should be updated.

        '
      type: string
      x-extensible-enum:
      - LOAN
      - SUSPENDED_AMORTIZATION_COMBINED_BUILDING_LOAN
      - RESIDUAL_DEBT_PROTECTION_BUILDING_SAVING_PLAN
    CommandTrigger:
      oneOf:
      - $ref: '#/components/schemas/AdvisorCommandTrigger'
      - $ref: '#/components/schemas/LoanPartnerProcessorCommandTrigger'
      - $ref: '#/components/schemas/SystemCommandTrigger'
      discriminator:
        propertyName: type
        mapping:
          ADVISOR: '#/components/schemas/AdvisorCommandTrigger'
          LOAN_PARTNER_PROCESSOR: '#/components/schemas/LoanPartnerProcessorCommandTrigger'
          SYSTEM: '#/components/schemas/SystemCommandTrigger'
    ParentalLeave:
      type: object
      description: "DE: Beschreibt ein (Angestelltes) Beschäftigungsverhältnis das wegen Elternzeit aktuell ruht<br/> \nEN: Describes an employment that is currently paused due to parental leave.\n"
      required:
      - parentalLeaveStartDate
      - parentalLeaveEndDate
      properties:
        parentalLeaveStartDate:
          description: 'DE: Datum des Anfangs der Elternzeit<br/> EN: Startdate of parental leave

            '
          $ref: '#/components/schemas/ISODate'
        parentalLeaveEndDate:
          description: 'DE: Ende der Elternzeit<br/> EN: End date of parental leave

            '
          $ref: '#/components/schemas/ISODate'
    VentureRelevantLoanTypeKey:
      type: string
      description: 'DE: Bestehender Darlehenstyp (nicht abschließende Aufzählung), z.B. EMPLOYMENT=Arbeitgeberdarlehen, PRIVATE=Privatdarlehen, MORTGAGE_SAVING_PLAN=Bauspardarlehen, PUBLIC=Öffentliche Darlehen, OTHER=Sonstige Darlehen. <br/> EN: Open ended enum contains existing loan debt type, possible values are (EMPLOYMENT, PRIVATE, MORTGAGE_SAVING_PLAN, PUBLIC, OTHER)

        '
      example: EMPLOYMENT
      x-extensible-enum:
      - EMPLOYMENT
      - PRIVATE
      - MORTGAGE_SAVING_PLAN
      - PUBLIC
      - OTHER
    AlimonyExpenseDetail:
      type: object
      required:
      - alimonyType
      - amount
      properties:
        alimonyType:
          type: string
          description: 'DE: Typ des Unterhalts<br/> EN: Type of alimony

            '
          x-extensible-enum:
          - CHILD_ALIMONY
          - MARITAL_ALIMONY
          - FAMILY_ALIMONY
          - SEPARATION_ALIMONY
        amount:
          description: 'DE: Unterhaltsausgabe. <br/> EN: Alimony expense

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        endDate:
          description: 'DE: ein Enddatum für die Unterhaltszahlunge<br/>

            EN: an end date for the alimony payment.

            '
          $ref: '#/components/schemas/ISODate'
    SavingsAndRepayment:
      type: object
      description: Defines the savings and the repayment plan for a building savings plan (Bausparer Spar und Tilgungsplan)
      required:
      - savingsPlan
      - repaymentPlan
      properties:
        savingsPlan:
          $ref: '#/components/schemas/BuildingSavingsPlan'
        repaymentPlan:
          $ref: '#/components/schemas/BuildingRepaymentPlan'
    LoanPartnerProcessingUnit:
      type: object
      description: 'DE: Informationen zur Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. <br/> EN: Information about the processing unit of the financing partner.

        '
      required:
      - id
      deprecated: true
      properties:
        id:
          $ref: '#/components/schemas/LoanPartnerProcessingUnitId'
        name:
          $ref: '#/components/schemas/LoanPartnerProcessingUnitName'
        parentUnit:
          description: 'DE: Zeigt die übergeordnete Orginazitioneinheit von der für den Kreditantrag zuständigen Einheit an. <br/>


            > z.B. Hauptsitz und Filiale einer Bank.



            EN: Information about the processing unit hierarchy by establishing a reference to the parent processing unit.


            > i.e. Branch as a processing unit can have Bank as a parent processing unit, etc ...

            '
          $ref: '#/components/schemas/LoanPartnerProcessingUnit'
    DefaultPlannedModernisationDetails:
      allOf:
      - $ref: '#/components/schemas/BasePlannedModernisationDetails'
    Loan:
      oneOf:
      - $ref: '#/components/schemas/MainLoan'
      - $ref: '#/components/schemas/KfwPromotionLoan'
      - $ref: '#/components/schemas/AuxiliaryLoan'
      discriminator:
        propertyName: type
        mapping:
          MAIN_LOAN: '#/components/schemas/MainLoan'
          KFW_PROMOTION_LOAN: '#/components/schemas/KfwPromotionLoan'
          AUXILIARY_LOAN: '#/components/schemas/AuxiliaryLoan'
    LoanQuotaType:
      description: 'DE: Wrapper für Ursprung des Wertes der Darlehensquote <br/> EN: Wrapper for loan quota value types.

        '
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/LoanQuotaTypeKey'
    FinancingOffer:
      description: 'DE: Information über das Finanzierungsangebot. <br/>

        EN: Information about the financing offer (bid).

        '
      type: object
      required:
      - id
      - status
      properties:
        id:
          $ref: '#/components/schemas/OfferId'
        financingConfirmationRequired:
          description: 'DE: Gibt an, ob eine Finanzierungsbestätigung benötigt wird. <br/> EN: Indicates if financing confirmation should be provided

            '
          type: boolean
          nullable: true
        status:
          $ref: '#/components/schemas/FinancingOfferStatus'
        loanQuota:
          $ref: '#/components/schemas/LoanQuota'
        financingNeed:
          $ref: '#/components/schemas/OfferFinancingNeed'
        financingStructures:
          $ref: '#/components/schemas/FinancingStructures'
        validity:
          description: 'DE: Ablaufdatum des Angebots. <br/>

            EN: Offer expiration date.

            '
          $ref: '#/components/schemas/ISODateTime'
        baserateIssueDate:
          description: 'DE: Einstandsdatum. <br/>

            EN: Base rate issue date.

            '
          $ref: '#/components/schemas/ISODate'
        offerDate:
          description: 'DE: Angebotsdatum. <br/>

            EN: Offer creation date.

            '
          $ref: '#/components/schemas/ISODate'
        additionalInfos:
          description: 'DE: Zusätzliche Details für das Angebot (Schlüssel-Werte Paar). <br/>

            EN: Additional offer details (key-value pairs).

            '
          type: array
          items:
            $ref: '#/components/schemas/AdditionalInfo'
    AdditionalApplicants:
      description: 'DE: Nebenantragssteller für das Finanzierungsvorhaben. <br/> EN: Additional applicants for the financing venture.

        '
      type: object
      properties:
        applicants:
          type: array
          items:
            $ref: '#/components/schemas/ApplicantIdRef'
          minItems: 0
    Executive:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseOccupation'
      properties:
        jobInformation:
          $ref: '#/components/schemas/JobInformation'
        contractLimitation:
          $ref: '#/components/schemas/ContractLimitation'
        shareHolding:
          $ref: '#/components/schemas/ShareHolding'
        parentalLeave:
          $ref: '#/components/schemas/ParentalLeave'
    CreditLoan:
      type: object
      description: 'DE: Informationen zur Finanzierungsstruktur. <br/>

        EN: A Credit Loan represents specific financing structure component.

        '
      properties:
        id:
          $ref: '#/components/schemas/CreditLoanId'
        financingLoans:
          type: array
          items:
            $ref: '#/components/schemas/Loan'
          minItems: 1
        handover:
          $ref: '#/components/schemas/Handover'
    SubmissionItem:
      type: object
      description: 'Holds basic information identifying a specific submission resource.

        '
      required:
      - submissionRef
      - submittedAt
      properties:
        submissionRef:
          $ref: '#/components/schemas/SubmissionRef'
        submittedAt:
          description: 'DE: Datum der Einreichung. <br/>

            EN: Date when this submission has been submitted.

            '
          $ref: '#/components/schemas/ISODateTime'
    BasePlannedModernisationDetails:
      type: object
      required:
      - modernisationType
      properties:
        modernisationType:
          type: string
      discriminator:
        propertyName: modernisationType
    CancelContractReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/CancelContractReasonKey'
    CounterOfferBuildingSavingLoanCreditPhase:
      type: object
      required:
      - interestRate
      properties:
        interestRate:
          $ref: '#/components/schemas/InterestRate'
    FinancingOfferItem:
      type: object
      description: 'DE: Referenz zum Finanzierungsangebot. <br/> EN: Reference to the financing offer.

        '
      required:
      - _href
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        embedded:
          description: 'DE: Komplette Information über das Finanzierungsangebot. <br/> EN: Complete information about the financing offer.

            '
          $ref: '#/components/schemas/FinancingOffer'
    EstateId:
      type: object
      required:
      - value
      description: 'DE: ID der Immobilie. <br/> EN: ID of the estate.

        '
      properties:
        value:
          type: string
    LiabilityKey:
      type: string
      example: SMALL_LOAN
      description: "DE: Art des Kredits (\n  CONSUMER_CREDIT=Konsumentenkredit,\n  CAR_CREDIT=Autokredit,\n  LINE_OF_CREDIT=Rahmenkredit,\n  CALL_CREDIT=Abrufkredit,\n  BUSINESS_CREDIT=Geschäftskredit,\n  CREDIT_CARD=Kreditkarte,\n  EMPLOYEE_LOAN=Arbeitgeberdarlehen\n  ZERO_PERCENT_FINANCING=0%-Finanzierung,\n  BALLOON_FINANCING=Ballonfinanzierung,\n  BLANK_MORTGAGE=Blanko-Bauspardarlehen,\n  EDUCATION_LOAN=Bildungskredit,\n  SUBSTITUTE_SECURITY=Ersatzsicherheit,\n  SMALL_LOAN=Kleindarlehen,\n  LEASING_PRIVATE=Leasingprivat,\n  LEASING_BUSINESS=Leasinggeschäft)<br/>\nEN: type of liability\n"
      x-extensible-enum:
      - CONSUMER_CREDIT
      - CAR_CREDIT
      - LINE_OF_CREDIT
      - CALL_CREDIT
      - BUSINESS_CREDIT
      - CREDIT_CARD
      - EMPLOYEE_LOAN
      - ZERO_PERCENT_FINANCING
      - BALLOON_FINANCING
      - BLANK_MORTGAGE
      - EDUCATION_LOAN
      - SUBSTITUTE_SECURITY
      - SMALL_LOAN
      - LEASING_PRIVATE
      - LEASING_BUSINESS
    ResidualDebtProtections:
      type: object
      description: 'A wrapper Type to hold a set of submission residual debt protections.

        '
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResidualDebtProtection'
    InterestMaturityType:
      type: string
      description: 'DE: Art der Sollzinsbindung(nicht abschließende Aufzählung), z.B. FIXED_PERIOD, VARIABLE. <br/> EN: Open ended enum contains types of the interest maturity, possible values are FIXED_PERIOD, VARIABLE.

        '
      example: FIXED_PERIOD
      x-extensible-enum:
      - FIXED_PERIOD
      - VARIABLE
      - OTHER
    OtherEquity:
      type: object
      description: 'DE: Sonstiges Vermögen (vor der Finanzierung). <br/>

        EN: Other assets (before financing).

        '
      properties:
        amount:
          $ref: '#/components/schemas/EuroAmount'
        description:
          type: string
    PreInquires:
      type: object
      required:
      - preInquires
      properties:
        preInquires:
          type: array
          items:
            $ref: '#/components/schemas/PreInquiry'
    SubmissionRevokedReasonKey:
      type: string
      description: 'DE: open ended enum enthält mögliche Gründe für den Widerruf der Anmeldung <br/> EN: open ended enum contains possible submission revocation reasons

        '
      example: TIME
      x-extensible-enum:
      - TIME
      - COND
      - DOCS
      - NO_OBJECT
      - MAIN
      - AUX
      - WRONG_BID
      - ERROR_USE
      - ERROR_TEC
      - TERMINATION
      - REALLOCATION
      - OTHER
    OfferFinancingNeedCost:
      description: 'DE: Kosten verbunden mit der gewünschten Finanzierung. <br/>

        EN: Costs associated with the wanted financing.

        '
      type: object
      properties:
        mortgageProperty:
          description: 'DE: Gesamtkosten Finanzierungsobjekt. <br/>

            EN: Total costs associated with lending object.

            '
          $ref: '#/components/schemas/EuroAmount'
        acquisition:
          description: 'DE: Gesamtkosten relevant zum Erwerb einer Immobilie. <br/>

            EN: Total costs associated with acquisition of a property.

            '
          $ref: '#/components/schemas/EuroAmount'
    RevokeSubmissionCounterOfferReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RevokeSubmissionCounterOfferReasonKey'
    DebtReschedulingFinancing:
      description: 'DE: Finanzierungsrelevante Information zur Anschlussfinanzierung / Umschuldung. <br/>

        EN: Financing-relevant information for the follow-up financing / rescheduling.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseOwnEstateFinancingNeed'
      properties:
        additionalLoan:
          $ref: '#/components/schemas/EstateAdditionalLoan'
    UnionInfoDBB:
      type: object
      description: 'DE: Informationen zum Deutschen Beamten Bund EN: Information regarding German Civil Service Federation

        '
      allOf:
      - $ref: '#/components/schemas/BaseUnionInfo'
      required:
      - singleUnion
      properties:
        singleUnion:
          type: string
          description: 'DE: Einzelgewerkschaft (nur wenn organisation = DBB) <br/>

            EN: single union (only when organisation = DBB)

            '
          x-extensible-enum:
          - BBB
          - BBW
          - BDZ
          - BBH
          - BTE
          - BSBD
          - BDF
          - BDR
          - BVOGD
          - BLBS
          - VLW
          - BVLB
          - DBB_BE
          - DBB_BB
          - DBB_HB
          - DBB_HE
          - DBB_MV
          - DBB_RP
          - DBB_SH
          - DBB_SL
          - DBB_ST
          - DBB_F
          - DBB_S
          - DBB_HH
          - DBB_J
          - DBB_NW
          - DJG
          - DPOLG
          - DSTG
          - DVG
          - DAAV
          - DBSH
          - DGVB
          - DPHV
          - DRB
          - VDSTR
          - FKA_NW
          - FLK_NW
          - FG_BW
          - FWSV
          - GE_NI
          - GDS
          - GDV
          - GDL
          - GKL_BE
          - BTB
          - KEG
          - KOMBA
          - DBVKOM
          - LBB
          - MA_DBB
          - NBB
          - SBB
          - TBB
          - VDB
          - VDL
          - VBE
          - VAB
          - VBB
          - VBOB
          - VBRG
          - VDR
          - VHW
          - VRB
          - VBBA
          - VRFF
          - OTHER
    KfwLoanAdditionalInfo:
      type: object
      description: 'DE: Zustzäliche Information zum KFW Darlehen. <br/> EN: Additional informations for kfw loan.

        '
      properties:
        provisionDetails:
          type: array
          description: 'DE: Zusätzliche Provisionsdetails für das KFW Darlehen (Schlüssel-Werte Paar). <br/> EN: Additional commission (provision) details for the kfw loan (key-value pairs).

            '
          items:
            $ref: '#/components/schemas/AdditionalInfo'
    AuxProductTypeKey:
      type: string
      description: 'DE: Typ des Nachrangdarlehens (nicht abschließende Aufzählung), z.B. DSL_PRIVAT, OYAK_ANKER, HANSEATIC_ALL. <br/> EN: Open ended enum contains auxiliary loan product types, possible values are DSL_PRIVAT, OYAK_ANKER, HANSEATIC_ALL.

        '
      example: HANSEATIC_ALL
      x-extensible-enum:
      - DSL_PRIVAT
      - HANSEATIC_ALL
      - OYAK_ANKER
      - OTHER
    EnergyEfficiency:
      type: object
      description: 'DE: Information bzgl. der Energieeffizienz. <br/> EN: Information the regarding the energy efficency.

        '
      properties:
        energyEfficiencyStandard:
          type: string
          description: 'DE: Energieeffizienz Standard nach KfW<br/> EN: energy efficiency standard according to KfW

            '
          x-extensible-enum:
          - KFW_EFFIZIENZHAUS_40
          - KFW_EFFIZIENZHAUS_40PLUS
          - KFW_EFFIZIENZHAUS_40_MIT_NACHHALTIGKEIT
          - KFW_EFFIZIENZHAUS_55
          - KFW_EFFIZIENZHAUS_55PLUS
          - KFW_EFFIZIENZHAUS_55_MIT_NACHHALTIGKEIT
          - KFW_EFFIZIENZHAUS_70
          - KFW_EFFIZIENZHAUS_85
          - KFW_EFFIZIENZHAUS_100
          - KFW_EFFIZIENZHAUS_DENKMAL
          - OTHER
        energyEfficiencyClass:
          type: string
          description: 'DE: Energieausweis für Wohngebäude<br/> EN: Energy certificate for residential buildings

            '
          x-extensible-enum:
          - A_PLUS
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          - H
          - OTHER
        description:
          type: string
          maxLength: 4000
          description: 'DE: Beschreibung falls OTHER als standard ausgewählt wird<br> EN: description if OTHER is the standard

            '
        renewableEnergyClass:
          type: boolean
          nullable: true
          description: 'DE: Standart gehört zur neuen Erneuerbare-Energien-Klasse<br/> EN: Standard belongs to new renewable-energy-class

            '
        primaryEnergyDemand:
          type: integer
          minimum: 0
          maximum: 100000
          description: 'DE: Primärenergiebedarf (in kWh/m2 pro Jahr)<br/> EN: Primary energy demand (kWh/m2 per year)

            '
        primaryEnergyConsumption:
          type: integer
          minimum: 0
          maximum: 100000
          description: 'DE: Primärenergieverbrauch nach Modernisierung (in kWh/m2 pro Jahr) - nicht relevant bei Grundstücken, sowie bei den Finanzierungsgründen Bau, Kauf Neubau<br/> EN: primary energy consumption after modernisation (kWh/m2 per year) - not relevant for plots of land and financing reasons build, buy new building

            '
        carbondioxideEmissions:
          type: integer
          minimum: 0
          maximum: 100000
          description: 'DE: CO2 Emissionen (in kg/m2 pro Jahr) nach Modernisierung - nicht relevant bei Grundstücken, sowie bei den Finanzierungsgründen Bau, Kauf Neubau<br> EN: Carbondioxide emissions (in kg/m2 per year) after modernisation - not relevant for plots of land and financing reasons build, buy new building

            '
    Household:
      type: object
      description: 'DE: Informationen zum Haushalt. <br/> EN: Information regarding a Household and it''s inhabitants.

        '
      required:
      - applicants
      properties:
        applicants:
          type: array
          description: 'DE: Sammlung von Referenzen zu den Einwohnern die zu diesem Haushalt gehören. <br/>

            EN: Reference to the applicants involved in this household.

            '
          items:
            $ref: '#/components/schemas/ApplicantIdRef'
        carsHousehold:
          type: integer
          format: int32
          description: 'DE: Anzahl PKWs im Haushalt. <br/> EN: Number of cars in household.

            '
        numberOfChildren:
          type: integer
          format: int32
          description: 'DE: Anzahl unterhaltsberechtigter Kinder im Haushalt. <br/> EN: Number of children in household.

            '
        personsHousehold:
          type: integer
          format: int32
          description: 'DE: Anzahl im Haushalt lebender Personen. <br/> EN: Number of persons in the same household.

            '
    SubmissionAdditionalProduct:
      description: a specific submission additional product
      type: object
      required:
      - provider
      - product
      - commissionBase
      properties:
        additionalProductId:
          type: string
        provider:
          $ref: '#/components/schemas/CompanyId'
        product:
          $ref: '#/components/schemas/ProductType'
        applicants:
          type: array
          items:
            $ref: '#/components/schemas/ApplicantId'
          minItems: 1
        policyNumber:
          type: string
        netBurden:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        duration:
          $ref: '#/components/schemas/Duration'
        commissionBase:
          $ref: '#/components/schemas/EuroAmount'
        commission:
          $ref: '#/components/schemas/Percentage'
        approved:
          description: a flag indicates whether the provided additional product has been approved and hence not changeable anymore.
          type: boolean
          nullable: true
    CreditPhaseInterest:
      type: object
      properties:
        interestRate:
          $ref: '#/components/schemas/InterestRate'
        interestPayed:
          description: 'DE: Sollzinsen insgesamt. <br/> EN: Total of credit interest payed.

            '
          $ref: '#/components/schemas/EuroAmount'
    InsuranceBurden:
      type: object
      required:
      - burden
      properties:
        burden:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        minimum:
          description: 'DE: Davon nicht beitragsfrei stellbar. <br/>

            EN: Of which not exempt from contributions.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    FixedInterestMaturity:
      description: 'DE: Information über die Sollzinsbindung mit dem festen Dauer. <br/>

        EN: Information about fixed interest rate maturity.

        '
      type: object
      required:
      - type
      - period
      allOf:
      - $ref: '#/components/schemas/BaseInterestMaturity'
      properties:
        period:
          description: 'DE: Dauer der Sollzinsbindung. <br/>

            EN: Fixed interest rate duration.

            '
          $ref: '#/components/schemas/Duration'
        fixedUntil:
          description: 'DE: Enddatum der Sollzinsbindung. <br/>

            EN: End date of the fixed interest rate.

            '
          $ref: '#/components/schemas/ISODate'
        bulletLoan:
          type: boolean
          description: 'DE: Endfällig. <br/>

            EN: Bullet loan.

            '
    ExistingBuildingSavingPlan:
      type: object
      required:
      - reason
      - contractNumber
      description: 'DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem bald fälligen Bestandsbausparers. <br/> EN: Information about bridging debt associated with a building saving plan that is due soon.

        '
      allOf:
      - $ref: '#/components/schemas/BaseBridgingLoanDetails'
      properties:
        contractNumber:
          type: string
          readOnly: true
          description: 'DE: Vertragsnummer eines bald fälligen Bestandsbausparers Bausparvertrags (components.schemas.BuildingSavingPlanEquity.properties.contractNumber). <br/> EN: Contract number referring to a soon due building saving plan (components.schemas.BuildingSavingPlanEquity.properties.contractNumber).

            '
    BasementDetail:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/BasementDetailKey'
    Child:
      type: object
      description: 'DE: beschreibt ein Kind (Im Umfang der Daten reduzierte Person) <br/> EN: a child is a segment of the data of a person

        '
      required:
      - childId
      - birthDate
      properties:
        childId:
          type: string
          description: 'DE: eindeutiger Schlüssel (ID), der die Person (hier: das Kind) identifiziert <br/> EN: unique id referencing this person

            '
        birthDate:
          description: 'DE: Geburtsdatum des Kindes. <br/> EN: Date of birth of the child

            '
          $ref: '#/components/schemas/ISODate'
        firstName:
          type: string
          maxLength: 100
          description: 'DE: Vorname des Kindes. <br/> EN: First name of the child.

            '
        lastName:
          type: string
          maxLength: 100
          description: 'DE: Nachname der Kindes. <br/> EN: Last name of the child.

            '
        childAllowanceEntitled:
          type: boolean
          nullable: true
          description: 'DE: ist das Kind zum Bezug von Kindergeld berechtigt <br/> EN: flag indicating whether this child is entitled to receive governmental child allowance

            '
    RepaymentEntriesAggregated:
      type: object
      required:
      - burdenTotal
      - interestTotal
      - remainingCreditAmount
      - repaymentTotal
      properties:
        interestTotal:
          description: The sum of payed interests.
          $ref: '#/components/schemas/EuroAmount'
        repaymentTotal:
          description: The sum of payed repayments.
          $ref: '#/components/schemas/EuroAmount'
        burdenTotal:
          description: The sum of payed credit burdens.
          $ref: '#/components/schemas/EuroAmount'
        remainingCreditAmount:
          description: The remaining credit amount at the end of the plan (Restschuld)
          $ref: '#/components/schemas/EuroAmount'
    HouseRating:
      description: 'DE: Bewertung des Hauses (Gebäude und Grundstueck). <br/> EN: Rating of a house (building and property).

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseRealEstateRating'
      properties:
        landValueEvaluation:
          $ref: '#/components/schemas/LandValueEvaluation'
    KfwReservationInfo:
      type: object
      description: 'DE: Zusätzliche Information zur KFW-Darlehensreservierung. <br/> EN: Additional Information about the Kfw Loan reservations

        '
      properties:
        id:
          type: string
          description: 'DE: Identifizierungsnummer einer sofortigen (Kfw) Bestätigung. <br/> EN: Identification nummer for a immediate (Kfw) confirmation.

            '
        callType:
          $ref: '#/components/schemas/KfwCallType'
        conditionReservationDate:
          description: 'DE: Konditionsreservierungsdatum. <br/>

            EN: Condition reservation date.

            '
          $ref: '#/components/schemas/ISODate'
        validity:
          description: 'DE: Ablaufdatum der Kondition. <br/>

            EN: Condition expiry date.

            '
          $ref: '#/components/schemas/ISODate'
    OfferFinancingNeed:
      description: 'DE: Information über den Finanzierungswunsch der finanziert werden sollten. <br/>

        EN: Information about the financing need.

        '
      type: object
      properties:
        amount:
          description: 'DE: Gewünschter Finanzierungsbetrag. <br/>

            EN: Wanted amount to be financed.

            '
          $ref: '#/components/schemas/EuroAmount'
        costs:
          $ref: '#/components/schemas/OfferFinancingNeedCost'
        equity:
          description: 'DE: In die Finanzierung eingebrachtes Eigenkapital. <br/>

            EN: Own equity used for the financing.

            '
          $ref: '#/components/schemas/EuroAmount'
    TaxableIncome:
      type: object
      description: 'DE: Steuerpflichtiges Einkommen für ein bestimmtes Jahr. <br/>

        EN: Taxable income for a specific years.

        '
      required:
      - year
      - taxableIncome
      properties:
        year:
          $ref: '#/components/schemas/Year'
        taxableIncome:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    LoanDetails:
      description: details of the loan to be updated
      type: object
      required:
      - amount
      properties:
        amount:
          $ref: '#/components/schemas/EuroAmount'
        maturity:
          $ref: '#/components/schemas/InterestMaturity'
        interestRateUpdate:
          $ref: '#/components/schemas/InterestRateUpdate'
        specialRepayment:
          $ref: '#/components/schemas/SpecialRepayment'
        commission:
          $ref: '#/components/schemas/CommissionInfo'
    SetSubmissionDataViolationsCommand:
      description: command to indicate submission violations
      type: object
      required:
      - violations
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        violations:
          type: array
          items:
            $ref: '#/components/schemas/SubmissionDataViolation'
          minItems: 1
        remark:
          type: string
    CreditPhase:
      type: object
      description: The credit phase object (Darlehensphase).
      properties:
        amount:
          description: 'DE: Tilgungssumme <br/>

            EN: Loan amount to be amortized.

            '
          $ref: '#/components/schemas/EuroAmount'
        timeline:
          $ref: '#/components/schemas/CreditPhaseTimeline'
        payout:
          $ref: '#/components/schemas/CreditPhasePayout'
        interest:
          $ref: '#/components/schemas/CreditPhaseInterest'
        burden:
          $ref: '#/components/schemas/CreditPhaseBurden'
        residualDebt:
          description: 'DE: Restschuld am Sollzinsbindungsende. <br/>

            EN: remaining debt by the end of the maturity.

            '
          $ref: '#/components/schemas/EuroAmount'
        premium:
          description: 'DE: Agio/ Laufzeitabhängiger Zinsbestandteil, der dem Nennbetrag des Darlehens zugeschlagen wird und damit die Darlehensschuld erhöht. <br/>

            EN: Agio/ term-dependent interest component that is added to the nominal amount of the loan and thus increases the loan debt.

            '
          $ref: '#/components/schemas/EuroAmount'
        youthBonus:
          description: 'DE: Jugendbonus wenn man bei Vertragsabschluss < 26 Jahre ist. <br/>

            EN: youth bonus when one at the contract''s conclusion < 26 Years old.

            '
          $ref: '#/components/schemas/EuroAmount'
    AwaitExternalProcessingSubmissionCommand:
      type: object
      description: command to indicate that the processing will be stopped due to an external process e.g. object valuation etc, and is not related to the submission's quality
      required:
      - externalProcessing
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        externalProcessing:
          $ref: '#/components/schemas/ExternalProcessing'
    LoanPartnerDetails:
      type: object
      description: 'DE: Informationen zum Kreditgeber und der Einheit des Kreditgebers, welche den Kreditantrag bearbeitet. EN: Information about the loan partner and the processing unit of the financing partner.

        '
      required:
      - loanPartner
      - processingUnit
      properties:
        loanPartner:
          $ref: '#/components/schemas/Company'
        processingUnit:
          $ref: '#/components/schemas/ProcessingUnit'
        processor:
          $ref: '#/components/schemas/Processor'
    SpecialRepaymentType:
      type: string
      description: 'DE: Typ der speziellen Rückzahlung (nicht abschließende Aufzählung), z.B. PERCENTAGE, TEXT. <br/>

        EN: Open ended enum contains possible special repayment types, possible values are PERCENTAGE, TEXT.

        '
      example: PERCENTAGE
      x-extensible-enum:
      - PERCENTAGE
      - TEXT
    CompanyId:
      type: object
      required:
      - value
      description: 'DE: ID des Unternehmes. EN: ID of the company.

        '
      properties:
        value:
          type: string
    ResidualDebtId:
      type: object
      description: 'DE: Id der Restschuldabsicherung.

        EN: Id of the residual debt protection.

        '
      properties:
        value:
          type: string
    TitleKey:
      type: string
      description: 'DE: Akademischer Titel des Antragstellers (nicht abschließende Aufzählung, zum Beispiel: DR, PH_D, PD_DR, PROF, PROF_DR). <br/> EN: Open ended enum contains possible title values, possible values are DR, PH_D, PD_DR, PROF, PROF_DR.

        '
      example: PROF_DR
      x-extensible-enum:
      - DR
      - PH_D
      - PD_DR
      - PROF
      - PROF_DR
      - OTHER
    Liability:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/LiabilityKey'
    Person:
      type: object
      required:
      - name
      description: 'DE: Personendaten einer Person. <br/> EN: Personal data of a person.

        '
      properties:
        name:
          description: 'DE: Name der Person. <br/> EN: Name of the person.

            '
          $ref: '#/components/schemas/PersonName'
        birthDate:
          description: 'DE: Geburtsdatum der Person. <br/> EN: Date of birth of the person.

            '
          $ref: '#/components/schemas/ISODate'
        birthPlace:
          type: string
          example: London
          description: 'DE: Geburtsort der Person. <br/> EN: The birth place of the person.

            '
        birthCountry:
          description: 'DE: Geburtsland der Person. <br/> EN: BirthCountry of the person.

            '
          $ref: '#/components/schemas/CountryCode'
    AssignmentForSecurity:
      description: 'DE: Sicherungsabtretung von Vermögen.

        EN: Equity for assignment for security.

        '
      properties:
        realEstateAssignedForSecurity:
          description: 'DE: Sicherungsabtretung von Immobilienvermögen. <br/>

            EN: Other realestate assigned for security.

            '
          $ref: '#/components/schemas/EuroAmount'
        cashAssignedForSecurity:
          description: 'DE: Sicherungsabtretung aus Bankguthaben.<br/>

            EN: Bank balance assigned for security.

            '
          $ref: '#/components/schemas/EuroAmount'
        mortgageSavingAssignedForSecurity:
          description: 'DE: Sicherungsabtretung aus Bausparguthaben.<br/>

            EN: Home savings plans assigned for security.

            '
          $ref: '#/components/schemas/EuroAmount'
        stockForSecurity:
          description: Stock amount for security.
          $ref: '#/components/schemas/EuroAmount'
        lifeInsuranceForSecurity:
          description: Life insurance policies for security.
          $ref: '#/components/schemas/EuroAmount'
    UpdateAdditionalProductsCommand:
      description: Modify additional products
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        additionalProducts:
          type: array
          items:
            $ref: '#/components/schemas/SubmissionAdditionalProduct'
          minItems: 0
    BaseCalculation:
      type: object
      required:
      - type
      - loanType
      - calculationDate
      properties:
        type:
          $ref: '#/components/schemas/CalculationType'
        calculationDate:
          description: 'DE: Datum der Kalkulation. <br/>

            EN: Calculation date.

            '
          $ref: '#/components/schemas/ISODate'
      discriminator:
        propertyName: type
    OtherOccupation:
      type: object
      description: 'DE: Nicht näher spezifizierte Erwerbstätigkeit. <br/> EN: Unspecified Occupation.

        '
      allOf:
      - $ref: '#/components/schemas/BaseOccupation'
      properties:
        shareHolding:
          $ref: '#/components/schemas/ShareHolding'
        jobInformation:
          $ref: '#/components/schemas/JobInformation'
        parentalLeave:
          $ref: '#/components/schemas/ParentalLeave'
    PaymentTime:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/PaymentTimeKey'
    EvaluationInformation:
      type: object
      properties:
        source:
          description: 'DE: Infoquelle des aktuellen Marktwert der Immobilie oder Grundstücks. <br/> EN: Source for the current estate or land value evaluation.

            '
          $ref: '#/components/schemas/StatSource'
        date:
          description: 'DE: Datum der Bewertung. <br/> EN: Date of the evaluation.

            '
          $ref: '#/components/schemas/ISODate'
        contact:
          description: 'DE: Kontaktinformation bei Rückfragen zur Bewertung. <br/> EN: Contact information for the evaluation.

            '
          $ref: '#/components/schemas/EvaluationInformationContactData'
    OccupationType:
      type: string
      description: 'DE: Beschreibung der Beschäftigungsart (nicht abschließende Aufzählung, zum Beispiel: EMPLOYEE = ANGESTELLTE/R, WORKER = ARBEITER/IN, UNEMPLOYED = ARBEITSLOSE/R, OFFICIAL = BEAMTE/R, PARENTAL_LEAVE = ELTERNZEIT, FREELANCER = FREIBERUFLER/IN, MARGINALLY_EMPLOYED = GERINFÜGIG BESCHÄFTIGT, STOCKHOLDER  = GESCHÄFTSF. GESELLSCHAFTER/IN, HOUSE_WIFE_OR_HUSBAND = HAUSMANN/FRAU, INDEPENDENT_GENTLEMAN = PRIVATIER/E, SELF_EMPLOYED_WITH_BALANCING = SELBSTSTÄNDIGE/R (bilanzierend), SELF_EMPLOYED_WITHOUT_BALANCING = SELBSTSTÄNDIGE/R (nicht bil.), PENSIONER = RENTNER/IN oder PENSIONÄR/IN, STUDENT = STUDENT/IN, SOLDIER = SOLDAT/IN, EXECUTIVE = VORSTAND/VORSTÄNDIN). <br/> EN: Open ended enum contains values for the occupation types, possible values are EMPLOYEE, WORKER, UNEMPLOYED, OFFICIAL, PARENTAL_LEAVE, FREELANCER, MARGINALLY_EMPLOYED, STOCKHOLDER, HOUSE_WIFE_OR_HUSBAND, INDEPENDENT_GENTLEMAN, SELF_EMPLOYED_WITH_BALANCING, SELF_EMPLOYED_WITHOUT_BALANCING, PENSIONER, STUDENT, SOLDIER, EXECUTIVE.

        '
      example: EMPLOYEE
      x-extensible-enum:
      - EMPLOYEE
      - WORKER
      - UNEMPLOYED
      - OFFICIAL
      - PARENTAL_LEAVE
      - FREELANCER
      - MARGINALLY_EMPLOYED
      - STOCKHOLDER
      - HOUSE_WIFE_OR_HUSBAND
      - INDEPENDENT_GENTLEMAN
      - SELF_EMPLOYED_WITH_BALANCING
      - SELF_EMPLOYED_WITHOUT_BALANCING
      - PENSIONER
      - STUDENT
      - SOLDIER
      - EXECUTIVE
    FinancingApplicationItem:
      type: object
      required:
      - id
      - _href
      description: 'A wrapper type Holds information about the requested financing application.


        Further details will be delivered in the embedded property if specified.


        Please refer to *Expansion* section for more details.

        '
      properties:
        financingApplicationRef:
          $ref: '#/components/schemas/FinancingApplicationRef'
        embedded:
          $ref: '#/components/schemas/FinancingApplication'
    OriginalPurchase:
      type: object
      properties:
        price:
          description: 'DE: Ursprünglicher Kaufpreis der Immobilie. <br/> EN: Initial property purchase price.

            '
          $ref: '#/components/schemas/EuroAmount'
        year:
          description: 'DE: Jahr des Kaufes / der Fertigstellung. <br/> EN: Year of payment / Year of completion.

            '
          $ref: '#/components/schemas/Year'
    LivingAddress:
      type: object
      required:
      - address
      - fromDate
      description: "DE: Adresse des aktuellen oder eines früheren Wohnorts<br/> \nEN: address of a living place, current or past.\n"
      properties:
        address:
          $ref: '#/components/schemas/Address'
        fromDate:
          description: "DE: Beginn des Gültigkeitszeitraums dieser Adresse (= Einzugsdatum). Aufgrund von Änderungen im Schema kann das Datum den Wert 1970-01-01 enthalten, da kein anderer Wert verfügbar ist.<br/> \nEN: Begin of validity period of this address (= date of moving in). Due to migration may contain EPOCH (1970-01-01) date because no other value is available to be set.\n"
          $ref: '#/components/schemas/ISODate'
        toDate:
          description: "DE: Ende des Gültigkeitszeitraums dieser Adresse (= Auszugsdatum). Wenn leer, dann ist dies noch die aktuelle Adresse. Aufgrund von Änderungen im Schema kann das Datum den Wert 1970-01-01 enthalten, da kein anderer Wert verfügbar ist.<br/> \nEN: End of validity period of this address (= date of moving in). If empty this is the current living address. Due to migration may contain EPOCH (1970-01-01) date because no other value is available to be set.\n"
          $ref: '#/components/schemas/ISODate'
    SuspendedAmortizationOtherProduct:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSuspendedAmortizationCombinedProduct'
    ExistingDebtType:
      type: string
      description: 'DE: Art der Darlehen (nicht abschließende Aufzaehlung EMPLOYMENT, PRIVATE, MORTGAGE_SAVING_PLAN, PUBLIC, OTHER, SOLVENCY, EXISTING_MORTGAGE, OPEN_PROPERTY_SALE, EXISTING_REALESTATE). <br/> EN: Open ended enum contains existing loan debt type, possible values are (EMPLOYMENT, PRIVATE, MORTGAGE_SAVING_PLAN, PUBLIC, OTHER, SOLVENCY, EXISTING_MORTGAGE, OPEN_PROPERTY_SALE, EXISTING_REALESTATE).

        '
      example: EMPLOYMENT
      x-extensible-enum:
      - EMPLOYMENT
      - PRIVATE
      - MORTGAGE_SAVING_PLAN
      - PUBLIC
      - SOLVENCY
      - OTHER
      - EXISTING_MORTGAGE
      - OPEN_PROPERTY_SALE
      - EXISTING_REALESTATE
    SuspendedAmortizationBuildingSavingProduct:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSuspendedAmortizationCombinedProduct'
      properties:
        productDetails:
          description: 'EN: details to the building saving plan being created. Only relevant when the building saving plan will be created during the credit decision process.

            '
          $ref: '#/components/schemas/BuildingSavingPlan'
        productIdentifier:
          type: string
    ParkingSpaceTypeKey:
      type: string
      example: DUPLEX_GARAGE
      x-extensible-enum:
      - OUTSIDE_PARKING_SPACE
      - UNDERGROUND_GARAGE
      - DUPLEX_GARAGE
      - CARPORT_GARAGE
      - SEPARATE_GARAGE
      - DOUBLE_GARAGE
    Margin:
      title: Margin
      type: object
      additionalProperties: false
      required:
      - name
      properties:
        name:
          type: string
          description: Name der Marge
        value:
          description: Wert der Marge in Prozent
          $ref: '#/components/schemas/RawPercentage'
    Calculations:
      description: 'A wrapper Type to hold a set of calculations.

        '
      type: object
      properties:
        calculations:
          type: array
          items:
            $ref: '#/components/schemas/CalculationItem'
    CessionClaim:
      type: object
      description: 'DE: Information zur Abtretung der Grundschuld. <br/>

        EN: Information about the cession of the land charge.

        '
      required:
      - requested
      properties:
        requested:
          description: 'DE: Flag ob eine Abtretung der Grundschuld erwünscht wird. <br/> EN: Flag whether a cession of the land charge is desired

            '
          type: boolean
      discriminator:
        propertyName: requested
        mapping:
          true: '#/components/schemas/CessionClaimRequested'
          false: '#/components/schemas/NoCessionClaim'
    OtherExpense:
      type: object
      required:
      - value
      description: 'DE: Andere (zusätzliche) regelmäßige Ausgaben. <br/> EN: Other periodical expenses.

        '
      properties:
        value:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        description:
          type: string
    EvaluationInformationContactData:
      type: object
      properties:
        description:
          example: Gemeinde Musterstadt
          description: 'DE: Kontaktinformationbeschreibung. <br/> EN: Description about the contact for the evaluation.

            '
          type: string
        phone:
          description: 'DE: Telefonnummer des Ansprechspartner für die Bewertung. <br/> EN: Phone number of the contact person for evaluation.

            '
          type: string
    CounterOfferBuildingSavingLoanSavingsPhase:
      type: object
      required:
      - interestRate
      properties:
        interestRate:
          $ref: '#/components/schemas/PeriodicalPercentage'
    BaseCommandTrigger:
      type: object
      required:
      - type
      properties:
        userId:
          $ref: '#/components/schemas/UserId'
        type:
          type: string
          x-extensible-enum:
          - ADVISOR
          - LOAN_PARTNER_PROCESSOR
          - SYSTEM
      discriminator:
        propertyName: type
    Estates:
      type: object
      description: 'A wrapper type of items which hold the essential estate information.

        '
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EstateItem'
          minItems: 1
    DocumentId:
      required:
      - value
      properties:
        value:
          type: string
          description: 'An Id refers to a specific document resource.

            '
      type: object
      description: 'DE: ID vom Dokument. EN: Id of the document.

        '
    SimpleLoanDebt:
      type: object
      required:
      - until
      - amount
      description: 'DE: Information zu bestehenden Darlehen. <br/> EN: Information about existing debts.

        '
      allOf:
      - $ref: '#/components/schemas/BaseExistingLoanDebt'
      properties:
        amount:
          description: 'DE: Ursprünglicher Darlehenbetrag. <br/>

            EN: Original debt amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        residualDebt:
          description: 'DE: Aktuelle Restschuld. <br/>

            EN: Current remaining debt.

            '
          $ref: '#/components/schemas/EuroAmount'
        interestFixDate:
          description: 'DE: Ablauf Sollzinsbindung. <br/>

            EN: Expiry of fixed interest rate.

            '
          $ref: '#/components/schemas/ISODate'
        description:
          description: 'DE: Beschreibung der bereitgestellten Schuld. EN: Description of the provided debt.

            '
          type: string
        interestRate:
          description: 'DE: Nominalzins (Sollzins) <br/> EN: Nominal interest rate

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
    ModifySubmissionCommand:
      oneOf:
      - $ref: '#/components/schemas/RevokeSubmissionCommand'
      - $ref: '#/components/schemas/AssignSubmissionLoanPartnerProcessorCommand'
      - $ref: '#/components/schemas/AssignSubmissionLoanPartnerProcessorDetailsCommand'
      - $ref: '#/components/schemas/UpdateLoanPartnerDecisionDateCommand'
      - $ref: '#/components/schemas/UpdateSubmissionLoanContractNumberCommand'
      - $ref: '#/components/schemas/ArchiveSubmissionCommand'
      - $ref: '#/components/schemas/UnArchiveSubmissionCommand'
      - $ref: '#/components/schemas/RejectSubmissionCommand'
      - $ref: '#/components/schemas/RevokeSubmissionRejectionCommand'
      - $ref: '#/components/schemas/CreateSubmissionCounterOfferCommand'
      - $ref: '#/components/schemas/DeliverContractSubmissionCommand'
      - $ref: '#/components/schemas/SignContractSubmissionCommand'
      - $ref: '#/components/schemas/AcceptSubmissionCounterOfferCommand'
      - $ref: '#/components/schemas/RejectSubmissionCounterOfferCommand'
      - $ref: '#/components/schemas/RevokeSubmissionCounterOfferCommand'
      - $ref: '#/components/schemas/AwaitExternalProcessingSubmissionCommand'
      - $ref: '#/components/schemas/ApproveSubmissionCommand'
      - $ref: '#/components/schemas/StartProcessingSubmissionCommand'
      - $ref: '#/components/schemas/CancelContractSubmissionCommand'
      - $ref: '#/components/schemas/PauseSubmissionProcessingCommand'
      - $ref: '#/components/schemas/ResumeSubmissionProcessingCommand'
      - $ref: '#/components/schemas/SetSubmissionDataViolationsCommand'
      - $ref: '#/components/schemas/RefuseSignContractCommand'
      - $ref: '#/components/schemas/ChangeLoanPartnerProcessingUnitCommand'
      - $ref: '#/components/schemas/CloseRejectedSubmissionCommand'
      - $ref: '#/components/schemas/UpdateSubmissionContactUserCommand'
      - $ref: '#/components/schemas/AddSubmissionLogbookNoteCommand'
      - $ref: '#/components/schemas/ApproveSubmissionCommissionChangeCommand'
      - $ref: '#/components/schemas/UpdateAdditionalProductsCommand'
      discriminator:
        propertyName: operation
        mapping:
          REVOKE_SUBMISSION: '#/components/schemas/RevokeSubmissionCommand'
          ASSIGN_PROCESSOR: '#/components/schemas/AssignSubmissionLoanPartnerProcessorCommand'
          ASSIGN_FULL_PROCESSOR: '#/components/schemas/AssignSubmissionLoanPartnerProcessorDetailsCommand'
          UPDATE_LOAN_PARTNER_DECISION_DATE: '#/components/schemas/UpdateLoanPartnerDecisionDateCommand'
          UPDATE_LOAN_CONTRACT_NUMBER: '#/components/schemas/UpdateSubmissionLoanContractNumberCommand'
          ARCHIVE_SUBMISSION: '#/components/schemas/ArchiveSubmissionCommand'
          UNARCHIVE_SUBMISSION: '#/components/schemas/UnArchiveSubmissionCommand'
          REJECT_SUBMISSION: '#/components/schemas/RejectSubmissionCommand'
          REVOKE_REJECTION: '#/components/schemas/RevokeSubmissionRejectionCommand'
          COUNTER_OFFER: '#/components/schemas/CreateSubmissionCounterOfferCommand'
          DELIVER_CONTRACT: '#/components/schemas/DeliverContractSubmissionCommand'
          SIGN_CONTRACT: '#/components/schemas/SignContractSubmissionCommand'
          ACCEPT_COUNTER_OFFER: '#/components/schemas/AcceptSubmissionCounterOfferCommand'
          REJECT_COUNTER_OFFER: '#/components/schemas/RejectSubmissionCounterOfferCommand'
          REVOKE_COUNTER_OFFER: '#/components/schemas/RevokeSubmissionCounterOfferCommand'
          AWAIT_EXTERNAL_PROCESSING: '#/components/schemas/AwaitExternalProcessingSubmissionCommand'
          APPROVE_SUBMISSION: '#/components/schemas/ApproveSubmissionCommand'
          START_PROCESSING: '#/components/schemas/StartProcessingSubmissionCommand'
          CANCEL_CONTRACT: '#/components/schemas/CancelContractSubmissionCommand'
          PAUSE_PROCESSING: '#/components/schemas/PauseSubmissionProcessingCommand'
          RESUME_PROCESSING: '#/components/schemas/ResumeSubmissionProcessingCommand'
          SET_SUBMISSION_DATA_VIOLATIONS: '#/components/schemas/SetSubmissionDataViolationsCommand'
          REFUSE_SIGN_CONTRACT: '#/components/schemas/RefuseSignContractCommand'
          CHANGE_LOAN_PARTNER_PROCESSING_UNIT: '#/components/schemas/ChangeLoanPartnerProcessingUnitCommand'
          CLOSE_REJECTED_SUBMISSION: '#/components/schemas/CloseRejectedSubmissionCommand'
          UPDATE_CONTACT_USER: '#/components/schemas/UpdateSubmissionContactUserCommand'
          ADD_SUBMISSION_LOGBOOK_NOTE: '#/components/schemas/AddSubmissionLogbookNoteCommand'
          APPROVE_SUBMISSION_COMMISSION_CHANGE: '#/components/schemas/ApproveSubmissionCommissionChangeCommand'
          UPDATE_ADDITIONAL_PRODUCTS: '#/components/schemas/UpdateAdditionalProductsCommand'
    BankAccount:
      type: object
      description: 'DE: Kontoverbindungsdaten <br/> EN: Bank account data

        '
      required:
      - iban
      - accountOwner
      properties:
        iban:
          description: 'DE: IBAN <br/> EN: The International Bank Account Number

            '
          $ref: '#/components/schemas/Iban'
        accountOwner:
          type: string
          description: 'DE: Name des Kontobesitzers <br/> EN: The name of the account owner

            '
        bic:
          description: 'DE: BIC <br/> EN: The Business Identifier Code

            '
          $ref: '#/components/schemas/Bic'
        bank:
          type: string
          description: 'DE: Name der Bank <br/> EN: The name of the bank

            '
        selectedForPayments:
          type: boolean
          nullable: true
          description: 'DE: Ist das Bankverbindung für alle SEPA-Lastschriften verwenden <br/> EN: Is the bank account used for all SEPA debits

            '
        selectedForPayout:
          type: boolean
          nullable: true
          description: 'DE: Ist Bankverbindung für alle Auszahlungen verwenden <br/> EN: Is the bank account used for all payouts

            '
    BaseSpecialRealEstateCharacteristics:
      type: object
      description: 'DE: Spezielle Nutzung der Immobilie. <br/> EN: Special use of property.

        '
      required:
      - type
      properties:
        type:
          type: string
        careProperty:
          description: 'DE: Betreutes Wohnen. <br/> EN: Assisted living.

            '
          type: boolean
          nullable: true
        holidayProp:
          description: 'DE: Ferienimmobilie. <br/> EN: Holiday property.

            '
          type: boolean
          nullable: true
        luxury:
          description: 'DE: Luxusobjekt. <br/> EN: Luxury estate.

            '
          type: boolean
          nullable: true
        monumentProtection:
          description: 'DE: Objekt unter Denkmalschutz. <br/> EN: Estate under monument protection.

            '
          type: boolean
          nullable: true
        microApartment:
          description: 'DE: Miniapartment. <br/> EN: Micro apartment

            '
          type: boolean
          nullable: true
        tinyHouse:
          description: 'DE: Tiny Haus. <br/> EN: Tiny house

            '
          type: boolean
          nullable: true
        retirementResidence:
          description: 'DE: Seniorenresidenz. <br/> EN: Retirement residence

            '
          type: boolean
          nullable: true
      discriminator:
        propertyName: type
    PreviousOwner:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/PreviousOwnerKey'
    InterestMaturity:
      oneOf:
      - $ref: '#/components/schemas/VariableInterestMaturity'
      - $ref: '#/components/schemas/FixedInterestMaturity'
      discriminator:
        propertyName: type
        mapping:
          VARIABLE: '#/components/schemas/VariableInterestMaturity'
          FIXED_PERIOD: '#/components/schemas/FixedInterestMaturity'
    AssignSubmissionLoanPartnerProcessorCommand:
      description: assign a processor using an id
      type: object
      required:
      - processorId
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        processorId:
          $ref: '#/components/schemas/LoanPartnerProcessorId'
    RawPercentage:
      description: 'DE: Prozentsatz. <br/> EN: Percentage.

        '
      type: object
      required:
      - value
      properties:
        value:
          description: 'DE: Prozentsatz. <br/> EN: Percentage.

            '
          type: number
    BrokeragePlatformIdentifier:
      type: object
      properties:
        key:
          $ref: '#/components/schemas/BrokeragePlatformIdentifierKey'
        value:
          type: string
          description: 'DE: Beratungsunternehmenidentifikator - Vermittlernummer. <br/>

            EN: Advisor company identifier.

            '
    Phone:
      type: object
      required:
      - phoneNumber
      - type
      properties:
        phoneNumber:
          type: string
          description: 'DE: Mobil- oder Festnetztelefonnummer des Antragstellers. <br/> EN: Mobile or landline telephone number of the customer.

            '
          example: +49 160 123456
        type:
          $ref: '#/components/schemas/PhoneType'
        reachable:
          $ref: '#/components/schemas/PhoneReachability'
    SubmissionOverview:
      readOnly: true
      type: object
      description: 'DE: Generelle Informationen ueber den Kreditantrag. <br/> EN: General information about a specific submission.

        '
      properties:
        status:
          $ref: '#/components/schemas/SubmissionStatus'
        submittedAt:
          description: 'DE: Datum der Einreichung. <br/>

            EN: Date when this submission has been submitted.

            '
          $ref: '#/components/schemas/ISODateTime'
        reviewedAt:
          description: 'DE: Datum der Überprüfung. <br/>

            EN: Date when this submission has been reviewed.

            '
          $ref: '#/components/schemas/ISODateTime'
        initialEstimate:
          deprecated: true
          description: '@deprecated: Use field timeline instead.

            '
          $ref: '#/components/schemas/InitialSubmissionEstimate'
        timeline:
          description: 'DE: Zeitplan einer Einreichung. EN: Timeline of a submission.

            '
          $ref: '#/components/schemas/SubmissionTimeline'
        submittedBy:
          description: 'DE: Informationen über den Berater der den Kreditantrag abgesendet hat. <br/>

            EN: Information about the advisor, who has triggered the submission process.

            '
          $ref: '#/components/schemas/Advisor'
        submitter:
          description: 'DE: Informationen über den Berater der den Kreditantrag abgesendet hat. <br/>

            EN: Information about the advisor, who has triggered the submission process.

            '
          $ref: '#/components/schemas/OrganizationUser'
        contactUser:
          description: 'DE: Informationen über den für die Einreichung verantwortlichen Kontaktnutzer. <br/>

            EN: Information about the contact user responsible for the submission.

            '
          $ref: '#/components/schemas/OrganizationUser'
        loanPartner:
          description: This field is deprecated. Please use the 'loanPartnerDetails' instead.
          deprecated: true
          $ref: '#/components/schemas/LoanPartnerProcessingInfo'
        loanPartnerDetails:
          $ref: '#/components/schemas/LoanPartnerDetails'
        additionalFields:
          $ref: '#/components/schemas/AdditionalFields'
        useNewModifyCommandVersion:
          description: Flag indicates whether the usage of the new status interface is required for this submission.
          type: boolean
        useNewUploadVersion:
          description: Flag indicates whether the usage of new upload for documents is required for this submission.
          type: boolean
    FamilyIncome:
      description: 'DE: Zusätzliches regelmäßiges Einkommen durch bzw. für Kinder / Familie. <br/> EN: Additional periodical income for children / family.

        '
      type: object
      properties:
        alimony:
          $ref: '#/components/schemas/AlimonyInfo'
        childAllowance:
          description: 'DE: Kindergeld. <br/>

            EN: Child Allowance.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        parentalAllowance:
          $ref: '#/components/schemas/ParentalAllowanceInfo'
    RentPeriodTypeKey:
      type: string
      description: 'DE: Mietdauer, z.B. befristet, unbefristet oder unvermietet. <br/> EN: Open ended enum contains rent period, possible values are (LIMITED, UNLIMITED, UNRENTED).

        '
      x-extensible-enum:
      - LIMITED
      - UNLIMITED
      - UNRENTED
    NationalityType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/NationalityTypeKey'
    SubmissionRef:
      type: object
      description: 'A reference to a specific submisson resource.


        This reference consists of a link which leads directly to the resource and an Id which could be used to reconstruct the url.

        '
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        id:
          $ref: '#/components/schemas/SubmissionId'
    ConditionProductCalculation:
      description: 'DE: Information über Konditionskalkulation. <br/>

        EN: Information about condition calculation.

        '
      type: object
      required:
      - type
      - details
      - margen
      allOf:
      - $ref: '#/components/schemas/BaseProductCalculation'
      properties:
        details:
          $ref: '#/components/schemas/ConditionCalculationDetails'
        margen:
          $ref: '#/components/schemas/MarginDetails'
        commission:
          x-is-plural: true
          type: array
          items:
            $ref: '#/components/schemas/CommissionCalculationInfo'
    Applicants:
      type: object
      description: 'A wrapper type which holds the essential applicant information.

        '
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ApplicantItem'
          minItems: 1
    PropertyType:
      type: string
      description: 'DE: Art des Gebäudes (nicht abschließende Aufzählung), z.B. APARTMENT=Wohnung, DETACHED_HOUSE=Einfamilienhaus, SEMI_DETACHED_HOUSE=Doppelhaushälfte, TWO_FAMILY_HOUSE=Zweifamilienhaus, END_TERRACE_HOUSE=Reiheneckhaus, MID_TERRACE_HOUSE=Reihenmittelhaus, APARTMENT_BUILDING=Mehrfamilienhaus, RESIDENTIAL_AND_COMMERCIAL_BUILDING=Wohn_und_Geschäftshaus, PROPERTY=nur_Grundstück, COMMERCIAL_PROPERTY=gewerb. Grundstück . <br/> EN: open ended enum contains property type details, possible values are APARTMENT, DETACHED_HOUSE, SEMI_DETACHED_HOUSE, TWO_FAMILY_HOUSE, END_TERRACE_HOUSE, MID_TERRACE_HOUSE, APARTMENT_BUILDING, RESIDENTIAL_AND_COMMERCIAL_BUILDING, PROPERTY, COMMERCIAL_PROPERTY.

        '
      example: APARTMENT
      x-extensible-enum:
      - APARTMENT
      - DETACHED_HOUSE
      - SEMI_DETACHED_HOUSE
      - TWO_FAMILY_HOUSE
      - END_TERRACE_HOUSE
      - MID_TERRACE_HOUSE
      - APARTMENT_BUILDING
      - RESIDENTIAL_AND_COMMERCIAL_BUILDING
      - PROPERTY
      - COMMERCIAL_PROPERTY
    SavingsEntry:
      type: object
      description: The object for a single savings entry regarding the cash flow.
      required:
      - accountBalance
      - fees
      - savingsBurden
      - savingsInterest
      properties:
        savingsBurden:
          description: The savings burden in EUR (Sparrate).
          $ref: '#/components/schemas/EuroAmount'
        capitalFormationSavings:
          description: The capital formation savings in EUR (Vermögenswirksame Leistungen).
          $ref: '#/components/schemas/EuroAmount'
        savingsInterest:
          description: The savings interest in EUR (Guthabenzins).
          $ref: '#/components/schemas/EuroAmount'
        fees:
          description: The fees in EUR (Gebühren).
          $ref: '#/components/schemas/EuroAmount'
        accountBalance:
          description: The account balance in EUR (Kontostand).
          $ref: '#/components/schemas/EuroAmount'
    SchufaRating:
      type: object
      required:
      - type
      description: 'DE: Bewertung der Kreditwürdigkeit des Antragstellers durch die Schufa. <br/> EN: Rating of the credit worthiness by Schufa.

        '
      allOf:
      - $ref: '#/components/schemas/BaseCreditWorthiness'
      properties:
        hasNegativeSchufaEntry:
          type: boolean
          nullable: true
          description: "DE: WAHR, wenn ein negativer Schufa-Krediteintrag vorhanden ist. <br/>\n    EN: TRUE, if there is a negative schufa entry.\n"
        ratingStep:
          type: string
          description: 'DE: Schufa Rating-Stufe zur Kreditwürdigkeit (nicht abschließende Aufzählung, zum Beispiel: A, B, C, D, E, F, G, H, I, J, K, L, M). Mehr Informationen unter: <a href="https://www.meineschufa.de/aktion/faq-scoring">Schufa-Score</a>. <br/> EN: open ended enum contains a rating value of the credit worthiness if any, possible values are A, B, C, D, E, F, G, H, I, J, K, L, M. More information: <a href="https://www.meineschufa.de/aktion/faq-scoring">Schufa-Score</a>.

            '
          example: A
          x-extensible-enum:
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          - H
          - I
          - J
          - K
          - L
          - M
        score:
          type: number
          minimum: 0
          maximum: 100
          format: float
          example: 97.5
          description: 'DE: Schufa Basisscore der Kreditwürdigkeit (zum Beispiel: 97.55 -> sehr geringes Risiko). <br/> EN: Contains a score value of the credit worthiness (e.g. Schufa 97.5 -> very low risk).

            '
    SpecialPropertyTypeKey:
      type: string
      description: 'DE: Sondereigentumstyp (nicht abschließende Aufzählung), z.B. BASEMENT, HOBBY, DRYING_ROOM, ATTIC, OFFICE, APARTMENT, ALL_ROOMS, GARAGE, OUT_PARK, UG_PARK, DUPLEX_PARK, GROUND, TOWNHOUSE_CORNER, TOWNHOUSE_CENTER, SEMIDETACHED_HOUSE. <br/> EN: open ended enum contains unit Property details, possible values are (BASEMENT, HOBBY, DRYING_ROOM, ATTIC, OFFICE, APARTMENT, ALL_ROOMS, GARAGE, OUT_PARK, UG_PARK, DUPLEX_PARK, GROUND, TOWNHOUSE_CORNER, TOWNHOUSE_CENTER, SEMIDETACHED_HOUSE)

        '
      example: BASEMENT
      x-extensible-enum:
      - BASEMENT
      - HOBBY
      - DRYING_ROOM
      - ATTIC
      - OFFICE
      - APARTMENT
      - ALL_ROOMS
      - GARAGE
      - OUT_PARK
      - UG_PARK
      - DUPLEX_PARK
      - GROUND
      - TOWNHOUSE_CORNER
      - TOWNHOUSE_CENTER
      - SEMIDETACHED_HOUSE
      - OTHER
    ApplicantRelationship:
      type: object
      description: 'DE: Beziehung zwischen genau zwei für Antrag relevanten Antragstellern. Wenn dieses Objekt nicht vorhanden ist, dann ist existieren keine Beziehungen. <br/>

        EN: Relationship between exactly 2 applicants involved in the financing application when applicable.


        The absence of this object indicates that no relationship is available.

        '
      required:
      - relationType
      properties:
        applicants:
          description: 'DE: Referenzen zu den in der Beziehung involvierten Antragstellern. <br/>

            EN: Reference to the applicants involved in this relationship.

            '
          type: array
          minItems: 2
          maxItems: 2
          items:
            $ref: '#/components/schemas/ApplicantIdRef'
        relationType:
          $ref: '#/components/schemas/ApplicantRelationshipType'
    PeriodicalPercentage:
      description: 'DE: Periodischer Prozentsatz als double. <br/> EN: Periodical percentage as double.

        '
      type: object
      required:
      - percentage
      - cycle
      properties:
        percentage:
          $ref: '#/components/schemas/Percentage'
        cycle:
          $ref: '#/components/schemas/Cycle'
    LoanPartnerProcessorName:
      description: 'DE: Username, Vor- und Nachname des (Kredit-)Bearbeiters. <br/> EN: Username, first- and lastname of the loan partner processor.

        '
      required:
      - userName
      properties:
        userName:
          type: string
        firstName:
          type: string
        lastName:
          type: string
    Apartment:
      description: 'DE: Zusätzliche Information zu der Immobilie von Typ "APARTMENT" (Wohnung). <br/>

        EN: Additional Information for the estate with the type "APARTMENT".

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/RealEstate'
      properties:
        rating:
          $ref: '#/components/schemas/RealEstateRating'
        numberOfApartmentsPerResidence:
          description: 'DE: Anzahl der Wohnungen im gesamten Wohnhaus. <br/> EN: Total number of apartments within the whole residence building.

            '
          type: integer
          format: int32
        apartmentsPerEntrance:
          description: 'DE: Anzahl der Wohnungen pro Hausaufgang. <br/> EN: Apartments per building entrance (staircase).

            '
          type: integer
          format: int32
        apartmentsPerBuilding:
          description: 'DE: Anzahl der Wohnungen pro Haus. <br/> EN: Apartments per building.

            '
          type: integer
          format: int32
        apartmentsPerDivision:
          description: 'DE: Anzahl Wohnung pro Teilungserklärung. <br/> EN: Apartments per apartment declaration of division.

            '
          type: integer
          format: int32
        apartmentFloor:
          $ref: '#/components/schemas/ApartmentFloor'
        specialCharacteristics:
          $ref: '#/components/schemas/SpecialRealEstateCharacteristics'
    OAuthProblem:
      type: object
      description: Error while Authentication
      required:
      - error
      - error_description
      properties:
        error:
          type: string
          description: Summary of the error type
          example: invalid_token
        error_description:
          type: string
          description: Detailed information about the error
          example: Access token expired
    PreInquiryStatusKey:
      type: string
      description: 'DE: Status des Voranfrage. <br/> EN: Status of the preInquiry.

        '
      x-extensible-enum:
      - CREATED
      - INWORK
      - SUBMITTED
      - ACCEPTED
      - ACCEPTED_WITH_PROPOSAL
      - REJECTED
      - ABORTED
      - TERMINATED
    CountryCode:
      type: object
      description: 'DE: Ländercode nach ISO_3166-1_alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). <br/> EN: Official ISO_3166-1_alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.

        '
      required:
      - value
      properties:
        value:
          type: string
          example: DE
          pattern: ^[A-Z]{2}$
    SignContractSubmissionCommand:
      type: object
      description: command to sign the contract after successful credit decision.
      required:
      - contracts
      - contractSignDate
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        remark:
          type: string
        contracts:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ExtendedContractInfo'
        contractSignDate:
          description: 'DE: Datum der Unterschrift des Vertrages. <br/> EN: Contract sign date.

            '
          $ref: '#/components/schemas/ISODate'
    ResidualDebtProtection:
      oneOf:
      - $ref: '#/components/schemas/ResidualDebtProtectionBuildingSavingPlan'
      discriminator:
        propertyName: type
        mapping:
          BUILDING_SAVING_PLAN: '#/components/schemas/ResidualDebtProtectionBuildingSavingPlan'
    ConditionCalculationDetails:
      description: 'DE: Information über einzelnen Darlehen innerhalb des Konditionskalkulations. <br/>

        EN: Information about single loan which is a part of condition calculation.

        '
      type: object
      required:
      - amount
      - payout
      - maturity
      - baserate
      - paymentTime
      - interestDetails
      properties:
        amount:
          description: 'DE: Darlehensbetrag. <br/>

            EN: Loan amount.

            '
          $ref: '#/components/schemas/RawEuroAmount'
        payout:
          description: 'DE: Auszahlung (Prozent). <br/>

            EN: Payout  (percent).

            '
          $ref: '#/components/schemas/RawPercentage'
        maturity:
          description: 'DE: Dauer der Sollzinsbindung. <br/>

            EN: Duration of interest rate maturity.

            '
          $ref: '#/components/schemas/InterestMaturity'
        baserate:
          $ref: '#/components/schemas/CalculationBaseRate'
        paymentTime:
          $ref: '#/components/schemas/PaymentTime'
        interestDetails:
          $ref: '#/components/schemas/LoanConditionInterest'
    ApproveSubmissionCommissionChangeCommand:
      description: Approve modified commission
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
    HouseUtilityUnits:
      type: object
      description: 'DE: Wohn- und Nutzeinheiten. <br/>

        EN: Residential and utility units.

        '
      properties:
        numberOfUnits:
          type: integer
          format: int32
        unitGroups:
          $ref: '#/components/schemas/HouseUtilityUnitGroups'
    InhabitantsKey:
      type: string
      description: 'DE: Anzahl Einwohner im Ort (nicht abschließende Aufzählung), z.B. UP_TO_1000, UP_TO_10000, UP_TO_50000, UP_TO_100000, UP_TO_200000, UP_TO_500000, UP_TO_1000000, MORE_THEN_1000000. <br/> EN: open ended enum contains umber of inhabitants in the city, possible values are UP_TO_1000, UP_TO_10000, UP_TO_50000, UP_TO_100000, UP_TO_200000, UP_TO_500000, UP_TO_1000000, MORE_THEN_1000000.

        '
      example: UP_TO_1000
      x-extensible-enum:
      - UP_TO_1000
      - UP_TO_10000
      - UP_TO_50000
      - UP_TO_100000
      - UP_TO_200000
      - UP_TO_500000
      - UP_TO_1000000
      - MORE_THEN_1000000
      - OTHER
    RegulatoryAuthorityLegalBasis:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RegulatoryAuthorityLegalBasisKey'
    LoanConditionSummary:
      description: 'DE: Zusammenfassung von Informationen zu einzelnem Darlehen (Konditionskalkulation). <br/>

        EN: Summary information about single loan (conditions calculation).

        '
      type: object
      properties:
        effectiveRate:
          description: 'DE: Effektiver Zins. <br/>

            EN: Effective interest rate.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        nominalRate:
          description: 'DE: Sollzins <br/>

            EN: Nominal rate.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        trueEffectiveRate:
          description: 'DE: Summe effektiver Bestandteile. <br/>

            EN: True effective rate.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        additionalInfo:
          x-is-plural: true
          type: array
          items:
            $ref: '#/components/schemas/AdditionalInfo'
    ConsultationItem:
      type: object
      required:
      - _href
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        embedded:
          $ref: '#/components/schemas/Consultation'
    ApplicantId:
      type: object
      required:
      - value
      properties:
        value:
          description: 'DE: Id des Antragstellers. <br/> EN: Id of the applicant.

            '
          type: string
          example: '1'
    BasementExtensionForResidentialUseKey:
      type: string
      description: 'DE: Details zum Kellerausbau (für Wohnnutzung), z.B DEVELOPED=voll ausgebaut, PARTIALY_DEVELOPED=teilweise ausgebaut, NONE=nicht ausgebaut. <br/> EN: Open ended enum contains basement extension for residential use, possible values are DEVELOPED, PARTIALY_DEVELOPED, NONE.

        '
      example: DEVELOPED
      x-extensible-enum:
      - DEVELOPED
      - PARTIALLY_DEVELOPED
      - NONE
      - OTHER
    LoanPartnerQueueId:
      type: object
      required:
      - value
      description: 'DE: ID der loan parnter queue. <br/> EN: Loan partner queue id.

        '
      properties:
        value:
          type: string
    PlannedHeatingModernisationDetails:
      type: object
      allOf:
      - $ref: '#/components/schemas/BasePlannedModernisationDetails'
      description: 'DE: Information über die geplante Modernisierungen der Heizung. <br/>

        EN: Information about planned heating modernisations.

        '
      required:
      - modernisationType
      - replacingExistingOilHeating
      - newHeatingType
      properties:
        replacingExistingOilHeating:
          type: boolean
          description: 'DE: Wird eine existierende Ölheizung ersetzt Ja - Nein<br/> EN: flag indicating an existing oil heating is replaced

            '
        newHeatingType:
          type: string
          x-extensible-enum:
          - GAS_CONDENSING_HEATING
          - GAS_HYBRID_HEATING
          - SOLAR_THERMAL_HEATING
          - HEAT_PUMP
          - BIOMASS_HEATING
          - HYBRID_HEATING_WITH_RENEWABLE_ENERGY
          - BUILDING_NETWORK_25_PERCENTAGE_RENEWABLE
          - BUILDING_NETWORK_55_PERCENTAGE_RENEWABLE
          - OTHER
          description: 'DE: Typ der neuen Heizungs<br/> EN: type of new heating

            '
        newHeatingDescription:
          type: string
          maxLength: 4000
          description: 'DE: Relevant falls bei newHeatingType OTHER ausgewählt wird<br/> EN: description of new heating if type OTHER is selected

            '
    PropertyRegisterOwner:
      oneOf:
      - $ref: '#/components/schemas/PropertyRegisterOwnerApplicant'
      - $ref: '#/components/schemas/PropertyRegisterOwnerThirdPerson'
      discriminator:
        propertyName: type
        mapping:
          APPLICANT: '#/components/schemas/PropertyRegisterOwnerApplicant'
          THIRD_PERSON: '#/components/schemas/PropertyRegisterOwnerThirdPerson'
    RealEstatePropertyCondition:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RealEstatePropertyConditionKey'
    AdditionalInfo:
      type: object
      description: 'DE: Zusätzliche Information als Schlüssel-Wert Paar. <br/> EN: Additional Information as key-value pairs.

        '
      properties:
        key:
          type: string
        value:
          type: string
    LoanPartnerQueue:
      type: object
      required:
      - id
      description: 'DE: Informationen zur Kredigeber Warteschlange. EN: Information about loan partner queue.

        '
      properties:
        id:
          description: 'DE: ID der Kredigeber Warteschlange. <br/> EN: Loan partner queue id.

            '
          $ref: '#/components/schemas/LoanPartnerQueueId'
        name:
          description: 'DE: Name der Kredigeber Warteschlange. EN: Name of the loan partner queue.

            '
          type: string
        description:
          description: 'DE: Beschreibung der Kreditgeber Warteschlange: EN: Description of the loan partner queue.

            '
          type: string
    CompanyAdvisor:
      type: object
      required:
      - companyAddress
      properties:
        companyName:
          type: string
          description: 'DE: Name der Firma für welche der Berater arbeitet. <br/>

            EN: Name of the advisor company.

            '
        companyAddress:
          description: 'DE: Adresse des Beratungsunternehmens. <br/> EN: Address of the advisory company.

            '
          $ref: '#/components/schemas/Address'
        regulatoryAuthorities:
          $ref: '#/components/schemas/RegulatoryAuthority'
    ConstructionKey:
      type: string
      description: 'DE: Bauweise des Gebäudes (nicht abschließende Aufzählung), z.B. SOLID=Massivbauweise, CONCRETE_SLAB=Plattenbauweise, WOOD_STAND=Holzständerbauweise, WOOD=Holzbauweise, TIMBER_FRAMING=Fachwerkbauweise, LOG_BUILDING=Blockhausbauweise, COB=Lehmbauweise. <br/> EN: open ended enum contains construction of the property, possible values are SOLID, CONCRETE_SLAB, WOOD_STAND, WOOD, TIMBER_FRAMING, LOG_BUILDING, COB, OTHER

        '
      example: SOLID
      x-extensible-enum:
      - SOLID
      - CONCRETE_SLAB
      - WOOD_STAND
      - WOOD
      - TIMBER_FRAMING
      - LOG_BUILDING
      - COB
      - OTHER
    Construction:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ConstructionKey'
    LocalPriceDetails:
      type: object
      description: 'DE: Ortsüblicher Preis pro Quadratmeter Wohnfläche. <br/> EN: Local price per square meter of living space.

        '
      properties:
        value:
          $ref: '#/components/schemas/EuroAmountPerSquareMeter'
        evaluationInformation:
          $ref: '#/components/schemas/EvaluationInformation'
    UpdateSubmissionContactUserCommand:
      description: command to update assigned contact user of the submission
      type: object
      required:
      - userId
      - companyId
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        userId:
          $ref: '#/components/schemas/UserId'
        companyId:
          $ref: '#/components/schemas/CompanyId'
    ConstructionCostInvoice:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ConstructionCostInvoiceKey'
    BasePropertiesRegisterInventory:
      description: 'DE: Grundstück und Eigentum (Eintrag aus dem Bestandsverzeichnis des Grundbuchblattes). <br/> EN: Land and property (Entry from the inventory of the land register sheet).

        '
      type: object
      required:
      - parcelAndDistrict
      - type
      properties:
        type:
          type: string
          x-extensible-enum:
          - OWNERSHIP_INVENTORY
          - JOINT_OWNERSHIP_INVENTORY
        id:
          description: 'DE: Laufende Nummer des Grundstücks. <br/> EN: Serial number of the property.

            '
          $ref: '#/components/schemas/PropertyRegisterInventoryId'
        parcelAndDistrict:
          description: 'DE: Gemarktung und Flurstück. <br/> EN: Cadastral district and land parcel

            '
          $ref: '#/components/schemas/ParcelAndDistrict'
        parcelDesc:
          description: 'DE: Wirschaftsart und Lage. <br/> EN: Economic type and location.

            '
          type: string
        parcelSize:
          description: 'DE: Größe des Flurstücks. <br/> DE: Size of the parcel.

            '
          $ref: '#/components/schemas/SquareMeter'
      discriminator:
        propertyName: type
    ShareHolding:
      description: 'DE: Anteilsquote am Unternehmen. <br/> EN: Shareholding quota of the company.

        '
      type: object
      required:
      - value
      properties:
        value:
          type: number
          format: double
          minimum: 0
          maximum: 100
    FinancialStandingId:
      type: object
      description: 'Id of a specific FinancialStanding.

        '
      required:
      - value
      properties:
        value:
          type: string
    DetailType:
      type: string
      description: 'DE: Kategorie des Kalkulkationwertes (nicht abschließende Aufzählung), z.B. ENTRY, SUB_TOTAL. <br/> EN: Calculated value category - open ended enum contains property type details, possible values are ENTRY, SUB_TOTAL.

        '
      example: ENTRY
      x-extensible-enum:
      - ENTRY
      - SUB_TOTAL
    MainLoan:
      description: 'DE: Information zum Hauptdarlehen. <br/>

        EN: Information about the main loan.

        '
      type: object
      required:
      - product
      allOf:
      - $ref: '#/components/schemas/BaseLoan'
      properties:
        product:
          $ref: '#/components/schemas/MainProduct'
        rateDetails:
          description: 'DE: Detailinformation zu den Raten. <br/>

            EN: Detailed information about the rates.

            '
          $ref: '#/components/schemas/RateDetails'
        additionalInfo:
          $ref: '#/components/schemas/MainLoanAdditionalInfo'
    HousingExpense:
      type: object
      required:
      - currentHousingSituation
      description: 'DE: Informationen zu Wohnungsausgaben. <br/> EN: Information regarding housing expenses.

        '
      properties:
        currentHousingSituation:
          $ref: '#/components/schemas/HousingSituation'
        costs:
          description: 'DE: Derzeitige Wohnkosten <br/>

            EN: Current housing costs.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        costsObsolete:
          type: boolean
          nullable: true
          description: 'DE: Wahr, wenn die Wohnungsausgaben nach der Finanzierung entfallen. <br/> EN: True if accommodation/housing costs are obsolete after financing.

            '
    LoanToValueRatioBreakdown:
      title: LoanToValueRatioBreakdown
      type: object
      required:
      - lendingValueBreakdown
      - loanBreakdown
      - loanToValueRatio
      properties:
        lendingValueBreakdown:
          $ref: '#/components/schemas/LoanToValueRatioLendingBreakdown'
        loanBreakdown:
          $ref: '#/components/schemas/LoanToValueRatioLoanBreakdown'
        loanToValueRatio:
          description: Der Beleihungsauslauf in Prozent
          $ref: '#/components/schemas/RawPercentage'
    UnionInfo:
      oneOf:
      - $ref: '#/components/schemas/DefaultUnionInfo'
      - $ref: '#/components/schemas/UnionInfoDBB'
      discriminator:
        propertyName: organisation
        mapping:
          DBB: '#/components/schemas/UnionInfoDBB'
          VERDI: '#/components/schemas/DefaultUnionInfo'
          IG_BAU: '#/components/schemas/DefaultUnionInfo'
          NGG: '#/components/schemas/DefaultUnionInfo'
          DBWV: '#/components/schemas/DefaultUnionInfo'
          THW_NRW: '#/components/schemas/DefaultUnionInfo'
          OTHER: '#/components/schemas/DefaultUnionInfo'
    BaseSubmissionCommand:
      type: object
      required:
      - operation
      properties:
        trigger:
          $ref: '#/components/schemas/CommandTrigger'
        createdOn:
          $ref: '#/components/schemas/ISODateTime'
        operation:
          type: string
          x-extensible-enum:
          - REVOKE_SUBMISSION
          - ASSIGN_PROCESSOR
          - UPDATE_LOAN_PARTNER_DECISION_DATE
          - UPDATE_LOAN_CONTRACT_NUMBER
          - ARCHIVE_SUBMISSION
          - UNARCHIVE_SUBMISSION
          - REJECT_SUBMISSION
          - REVOKE_REJECTION
          - COUNTER_OFFER
          - ACCEPT_COUNTER_OFFER
          - REJECT_COUNTER_OFFER
          - REVOKE_COUNTER_OFFER
          - DELIVER_CONTRACT
          - SIGN_CONTRACT
          - AWAIT_EXTERNAL_PROCESSING
          - APPROVE_SUBMISSION
          - START_PROCESSING
          - PAUSE_PROCESSING
          - RESUME_PROCESSING
          - SET_SUBMISSION_DATA_VIOLATIONS
          - REFUSE_SIGN_CONTRACT
          - CHANGE_LOAN_PARTNER_PROCESSING_UNIT
          - CLOSE_REJECTED_SUBMISSION
          - ADD_SUBMISSION_LOGBOOK_NOTE
          - APPROVE_SUBMISSION_COMMISSION_CHANGE
          - UPDATE_ADDITIONAL_PRODUCTS
      discriminator:
        propertyName: operation
    BaseFinancingNeed:
      type: object
      required:
      - type
      properties:
        additionalCosts:
          $ref: '#/components/schemas/EstateAdditionalCosts'
        type:
          $ref: '#/components/schemas/FinancingNeedType'
    ParkingSpaceType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ParkingSpaceTypeKey'
    SubmissionDocumentBinary:
      type: string
      format: binary
    OtherCapitalNeededLoanUsageKey:
      type: string
      description: 'DE: Zusätzlicher Kapitalbedarf (nicht abschließende Aufzählung), z.B. OPERATIONAL_COSTS, REPAY_ANOTHER_LOAN, PREPAYMENT_PENALTY, RESIDENTIAL_USE, RENEWABLE_ENERGY, DISBURSMENT_COOWNERS, DISBURSMENT_HEIRS, OTHER, RECONSTRUCTION, BUY, CONSTRUCTION, BUY_CONSTRUCTION, SUPPLEMENTARY_FINANCING. <br/>

        EN: Open ended enum contains other capital needed loan usage, possible values are OPERATIONAL_COSTS, REPAY_ANOTHER_LOAN, PREPAYMENT_PENALTY, RESIDENTIAL_USE, RENEWABLE_ENERGY, DISBURSMENT_COOWNERS, DISBURSMENT_HEIRS, OTHER, RECONSTRUCTION, BUY, CONSTRUCTION, BUY_CONSTRUCTION, SUPPLEMENTARY_FINANCING.

        '
      example: OPERATIONAL_COSTS
      x-extensible-enum:
      - REFINANCE
      - OPERATIONAL_COSTS
      - REPAY_ANOTHER_LOAN
      - PREPAYMENT_PENALTY
      - RESIDENTIAL_USE
      - RENEWABLE_ENERGY
      - DISBURSMENT_COOWNERS
      - DISBURSMENT_HEIRS
      - RECONSTRUCTION
      - BUY
      - CONSTRUCTION
      - BUY_CONSTRUCTION
      - SUPPLEMENTARY_FINANCING
      - OTHER
    EstateVendor:
      description: 'DE: Informationen über den Immobilienverkäufer. <br/> EN: Information about the estate vendor.

        '
      oneOf:
      - $ref: '#/components/schemas/PersonVendor'
      - $ref: '#/components/schemas/CompanyVendor'
      discriminator:
        propertyName: vendorType
        mapping:
          PERSON: '#/components/schemas/PersonVendor'
          COMPANY: '#/components/schemas/CompanyVendor'
    LiabilityDebt:
      type: object
      description: 'DE: Verbindlichkeiten vor Beginn der angefragten Finanzierung. <br/> EN: Liability obligations before the financing process.

        '
      properties:
        guarantee:
          description: 'DE: Bürgschaftsverpflichtungen. <br/>

            EN: Guarantee obligations.

            '
          $ref: '#/components/schemas/EuroAmount'
        other:
          description: 'DE: Sonstige Verbindlichkeiten. <br/>

            EN: Other liabilities.

            '
          $ref: '#/components/schemas/EuroAmount'
        description:
          type: string
    Cycle:
      description: 'DE: Wrapper für Zykluswerte <br/> EN: Wrapper for cycle values.

        '
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/CycleKey'
    ResidualDebtProtectionBuildingSavingPlan:
      allOf:
      - $ref: '#/components/schemas/BaseResidualDebtProtection'
      - type: object
        required:
        - buildingSavingPlan
        properties:
          buildingSavingPlan:
            $ref: '#/components/schemas/BuildingSavingPlan'
    InvestEquity:
      type: object
      description: 'DE: Vermögenswerte, welche (operativ) in die Finanzierung aufgenommen werden sollen. <br/> EN: Operational (venture) assets used in the financing process.

        '
      properties:
        cash:
          description: 'DE: Bankguthaben. <br/>

            EN: Cash amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        mortgageSaving:
          description: 'DE: Bausparguthaben. <br/>

            EN: Mortgage savings.

            '
          $ref: '#/components/schemas/EuroAmount'
        mortgageSavingPlans:
          description: 'DE: Details über Bausparguthaben. <br/>

            EN: Details about Mortgage savings.

            '
          type: array
          items:
            $ref: '#/components/schemas/BuildingSavingPlanInvestEquity'
        otherEstates:
          description: 'DE: Weiteres Immobilienvermögen (Marktwert). <br/>

            EN: Other real estate assets (market value).

            '
          $ref: '#/components/schemas/EuroAmount'
        personalContribution:
          description: 'DE: Eigenleistung ("Muskelhypothek"). <br/>

            EN: Personal contribution.

            '
          $ref: '#/components/schemas/EuroAmount'
        stock:
          description: 'DE: Wertpapiere wie z.B. aktien. <br/>

            EN: Securities e.g. stocks, bonds.

            '
          $ref: '#/components/schemas/EuroAmount'
        depositPaidInAdvance:
          description: 'DE: Bereits geleistete Anzahlung. <br/>

            EN: Deposit already paid in advance.

            '
          $ref: '#/components/schemas/EuroAmount'
        landPaidInAdvance:
          description: 'DE: Bereits geleistete Anzahlung für das Grundstück. <br/>

            EN: Deposit paid in advance for the land.

            '
          $ref: '#/components/schemas/EuroAmount'
        relevantLoans:
          type: array
          description: 'DE: Sammlung von Darlehen die für das Finanzierungsvorhaben relevant sind. <br/>

            EN: Collection of loans relevant for the planed financing venture.

            '
          items:
            $ref: '#/components/schemas/VentureRelevantLoan'
    BusinessLine:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/BusinessLineKey'
    ClosedPropertySale:
      description: 'DE: Information zur Zwischenfinanzierung in Zusammenhang mit einem abgeschlossenen Immobilienverkauf. <br/> EN: Bridging debt associated with a closed property sale.

        '
      allOf:
      - $ref: '#/components/schemas/BaseBridgingLoanDetails'
    UtilizationKey:
      type: string
      description: 'DE: Nutzung des Ojektes (nicht abschließende Aufzählung), z.B. SELF_OCCUPIED, PARTLY_RENT_OUT, RENT_OUT. <br/> EN: Open ended enum contains utilization of the property, possible values are SELF_OCCUPIED, PARTLY_RENT_OUT, RENT_OUT.

        '
      example: SELF_OCCUPIED
      x-extensible-enum:
      - SELF_OCCUPIED
      - PARTLY_RENT_OUT
      - RENT_OUT
    BuildingSavingPlanInvestEquity:
      type: object
      required:
      - contractNumber
      - amount
      properties:
        contractNumber:
          type: string
          description: 'DE: Vertragsnummer (components.schemas.BuildingSavingPlanEquity.properties.contractNumber). <br/> EN: Contract number (components.schemas.BuildingSavingPlanEquity.properties.contractNumber).

            '
        amount:
          $ref: '#/components/schemas/EuroAmount'
    BaseFinancingVenture:
      type: object
      description: 'DE: Vermögenswerte, welche (operativ) in die Finanzierung aufgenommen werden sollen. <br/> EN: Operational (venture) assets used in the financing process.

        '
      required:
      - reason
      - mortgageProperty
      properties:
        reason:
          $ref: '#/components/schemas/FinancingApplicationReason'
        mortgageProperty:
          description: 'DE: Referenz zum Beleihungsobjekt/Finanzierungsobjekt auf das sich das Finanzierungsvorhaben bezieht. <br/> EN: Reference to the financing process related asset / property.

            '
          $ref: '#/components/schemas/EstateRef'
        mainApplicant:
          description: 'DE: Referenz zum Hauptantragssteller auf den sich das Finanzierungsvorhaben bezieht. <br/> EN: Reference to the financing process related main applicant.

            '
          $ref: '#/components/schemas/ApplicantIdRef'
        collateralMortgageProperties:
          $ref: '#/components/schemas/CollateralMortgageProperties'
        additionalApplicants:
          $ref: '#/components/schemas/AdditionalApplicants'
        investEquity:
          $ref: '#/components/schemas/InvestEquity'
        assignmentForSecurity:
          $ref: '#/components/schemas/AssignmentForSecurity'
        utilization:
          $ref: '#/components/schemas/Utilization'
      discriminator:
        propertyName: reason
    TemporaryResidencePermit:
      type: object
      required:
      - expiryDate
      - blueCard
      properties:
        expiryDate:
          description: "DE: Ablaufdatum einer befristeten Aufenthaltserlaubnis (nur wenn eine befristete Aufenthaltserlaubnis vorliegt)<br/> \nEN: expiry date of the residence permit (only if residence permit is temporary)\n"
          $ref: '#/components/schemas/ISODate'
        blueCard:
          type: boolean
          description: "DE: hat die Person eine \"Blue-Card\" <br/> \nEN: does the person have a \"Blue-Card\"\n"
    SubmissionRejectedStatus:
      type: object
      description: 'EN: Status containing information about rejection

        '
      required:
      - type
      - reasons
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatus'
      properties:
        reasons:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/RejectReason'
    BasementDetailKey:
      type: string
      description: 'DE: Details zum Keller (nicht abschließende Aufzählung), z.B DEVELOPED=voll_unterkellert, PARTIALY_DEVELOPED=teil_unterkellert, NONE=nicht_unterkellert. <br/> EN: Open ended enum contains basement details, possible values are DEVELOPED, PARTIALY_DEVELOPED, NONE.

        '
      example: DEVELOPED
      x-extensible-enum:
      - DEVELOPED
      - PARTIALLY_DEVELOPED
      - NONE
      - OTHER
    CompanyName:
      type: object
      properties:
        name:
          type: string
    RentalIncomeItem:
      type: object
      required:
      - estate
      - rent
      description: 'DE: Mieteinnahmen aus einem bestimmten Objekt. <br/> EN: The rental income for a specific real estate.

        '
      properties:
        rent:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        estate:
          description: 'DE: Referenz zum Mietobjekt. <br/>

            EN: Reference to the Estate which the rent is associated with.

            '
          $ref: '#/components/schemas/EstateRef'
    ExistingMortgageDebt:
      type: object
      required:
      - estate
      description: 'DE: Bestehende Hypothek auf die Immobilie. <br/> EN: Existing mortgage of the property.

        '
      allOf:
      - $ref: '#/components/schemas/BaseExistingLoanDebt'
      properties:
        estate:
          description: 'DE: Referenz zu dem Darlehen gehörenden Immobilie. <br/>

            EN: Reference to the Estate which this Loan is associated with.

            '
          $ref: '#/components/schemas/EstateRef'
        amount:
          description: 'DE: Ursprünglicher Darlehenbetrag. <br/>

            EN: Original debt amount.

            '
          $ref: '#/components/schemas/EuroAmount'
        debitor:
          $ref: '#/components/schemas/Debitor'
        payoutDate:
          description: 'DE: Datum der Vollauszahlung. <br/>

            EN: Date of full payment.

            '
          $ref: '#/components/schemas/ISODate'
        contractNumber:
          description: 'DE: Darlehensnummer. <br/> EN: Loan number.

            '
          type: string
        promotionalLoan:
          description: 'DE: Flag ob es sich um einen Förderdarlehen handelt. <br/> EN: Flag indicates whether promotional loan is used.

            '
          type: boolean
          nullable: true
        interestFixDate:
          description: 'DE: Ablauf Sollzinsbindung. <br/>

            EN: Expiry of fixed interest rate.

            '
          $ref: '#/components/schemas/ISODate'
        forward:
          $ref: '#/components/schemas/ForwardExistingMortgage'
        residualDebt:
          description: 'DE: Vrs. Restschuld zum Zinsanpassungstermin. <br/>

            EN: Current remaining debt.

            '
          $ref: '#/components/schemas/EuroAmount'
        collateral:
          description: 'DE: Beleihung. <br/> EN: Collateral.

            '
          type: string
        repay:
          description: 'DE: Gewünschte Ablösung des Darlehens. <br/> EN: Repayment of the loan desired.

            '
          type: boolean
          nullable: true
        propertyRegisterMortgageRef:
          description: 'DE: Referenz zur Laufenden Nummer aus der dritten Abteilung des Grundbuchblattes. <br/> EN: Reference to the serial number in land register from the third section of the land register sheet.

            '
          type: string
        interestRate:
          description: 'DE: Nominalzins (Sollzins) <br/> EN: Nominal interest rate

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        debitInterestCommitment:
          $ref: '#/components/schemas/Duration'
        expectedEndOfTheTerm:
          $ref: '#/components/schemas/ISODate'
        rankingInTheLandRegister:
          type: string
    BonusIncome:
      description: 'DE: Zusätzliches regelmäßiges Einkommen durch Boni/Tantiemen. <br/> EN: Additional periodical bonus income.

        '
      type: object
      properties:
        abroad:
          description: 'DE: Zusätzliches regelmäßiges Einkommen durch Auslandseinsatz. <br/>

            EN: Additional periodical income through assignment abroad.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        performance:
          description: 'DE: Zusätzliches regelmäßiges Einkommen durch Prämien/ Leistungszulage. <br/>

            EN: Additional periodical income through bonuses / performance allowances.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        profitSharing:
          description: 'DE: Zusätzliches regelmäßiges Einkommen durch Tantieme/ Bonus. <br/>

            EN: Additional periodical income through royalty / bonus.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    Building:
      type: object
      description: 'DE: Information über das Gebäude. <br/> EN: Information about the building.

        '
      properties:
        construction:
          $ref: '#/components/schemas/Construction'
        yearOfConstruction:
          description: 'DE: Baujahr. <br/> EN: Year of construction.

            '
          $ref: '#/components/schemas/Year'
        lift:
          description: 'DE: Vorhandener Aufzug. <br/> EN: Existing elevator.

            '
          type: boolean
          nullable: true
        stories:
          description: 'DE: Anzahl der Vollgeschosse (ohne Keller/Dachboden). <br/> EN: Number of floors (without basement/attic).

            '
          type: integer
          format: int32
        buildingVolume:
          description: 'DE: Umbauter Raum. <br/>

            EN: Enclosed space.

            '
          $ref: '#/components/schemas/CubicMeter'
        prefabrication:
          $ref: '#/components/schemas/Prefabrication'
        prefabCertified:
          type: boolean
          nullable: true
          description: 'DE: Gütesiegel. <br/>

            EN: quality seal.

            '
        energyEfficiency:
          $ref: '#/components/schemas/EnergyEfficiency'
    Client:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ClientKey'
    CommandId:
      type: object
      required:
      - value
      properties:
        value:
          type: string
    DocumentMetaData:
      type: object
      deprecated: true
      properties:
        submissionId:
          $ref: '#/components/schemas/SubmissionId'
        documentId:
          $ref: '#/components/schemas/DocumentId'
        documentType:
          type: string
          description: 'A type refers to a specific document resource.

            '
          x-extensible-enum:
          - CONDITION_CALCULATION
          - CONDITION_CALCULATION_KFW
          - HANDOVER_PROTOCOL
          - HOUSEHOLD_CALCULATION
          - MORTGAGE_LENDING_VALUE_CALCULATION
          - REVISED_FUNDING_APPLICATION
          - PROVIDER_COVER_LETTER
          - PROHYP_COVER_LETTER
          - COMMISSION_REQUIREMENT_SHEET
          - PRE_CONTRACTUAL_INFORMATION
          - ADVISORS_SURVEY
          - DSL_FAX_PROLONGATION
          - ING_INFO_SHEET
          - FACT_SHEET
          - DEBT_SERVICE_CALCULATION
          - REALESTATE_VALUATION
          - OBJECT_DATA_SHEET
          - ADDITIONAL_PROPERTY_1_OBJECT_DATA_SHEET
          - ADDITIONAL_PROPERTY_2_OBJECT_DATA_SHEET
          - ADDITIONAL_PROPERTY_3_OBJECT_DATA_SHEET
          - ADDITIONAL_PROPERTY_4_OBJECT_DATA_SHEET
          - ADDITIONAL_PROPERTY_5_OBJECT_DATA_SHEET
          - CHECKLIST_MORTGAGE_ASSIGNMENT
        documentName:
          type: string
          description: 'A name refers to a specific document resource.

            '
        href:
          $ref: '#/components/schemas/ResourceRef'
        createdAt:
          $ref: '#/components/schemas/ISODateTime'
    BaseFinancingDetails:
      description: 'DE: Detailierte Information über das Finanzierungvorhaben. <br/>

        EN: Detailed information about the financing process.

        '
      type: object
      required:
      - type
      properties:
        type:
          type: string
          x-extensible-enum:
          - OWN
          - FOREIGN
        payoutDate:
          description: 'DE: Auszahlungsdatum. <br/>

            EN: Payout date.

            '
          $ref: '#/components/schemas/ISODate'
        desiredDecisionDate:
          description: 'DE: gewünschte Entscheidungsdatum. <br/>

            EN: desired decision date.

            '
          $ref: '#/components/schemas/ISODate'
        amortisationStartDate:
          description: 'DE: Tilgungsbeginn. <br/>

            EN: Start of amortisation.

            '
          $ref: '#/components/schemas/ISODate'
        loanQuota:
          $ref: '#/components/schemas/LoanQuota'
        numberOfPayments:
          type: integer
          format: int32
          description: 'DE: Anzahl Auszahlungen <br/> EN: Number of payments

            '
      discriminator:
        propertyName: type
    RawEuroAmount:
      description: 'DE: Euro Betrag als Zahl. <br/> EN: Euro amount as number

        '
      type: object
      required:
      - value
      properties:
        value:
          description: 'DE: Betrag. <br/> EN: Value.

            '
          type: number
    RejectSubmissionCommand:
      description: command to reject a submission during credit decision phase providing information about the cause of the rejection.
      type: object
      required:
      - rejection
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        rejection:
          $ref: '#/components/schemas/SubmissionRejection'
    SuspendedRepaymentProductType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/SuspendedRepaymentProductTypeKey'
    RealEstatePropertyConditionKey:
      type: string
      description: 'DE: Zustand des Gebäudes (nicht abschließende Aufzählung), z.B. IN_TOTAL_RENOVATION_NEED, IN_EXTENSIVE_MODERNISATION_NEED, IN_RENOVATION_NEED, IN_MODERNISATION_NEED, WELL_KEPT, AS_NEW. <br/> EN: open ended enum contains general condition of the real estate, possible values are IN_TOTAL_RENOVATION_NEED, IN_EXTENSIVE_MODERNISATION_NEED, IN_RENOVATION_NEED, IN_MODERNISATION_NEED, WELL_KEPT, AS_NEW

        '
      example: IN_RENOVATION_NEED
      x-extensible-enum:
      - IN_TOTAL_RENOVATION_NEED
      - IN_EXTENSIVE_MODERNISATION_NEED
      - IN_RENOVATION_NEED
      - IN_MODERNISATION_NEED
      - WELL_KEPT
      - AS_NEW
      - OTHER
    Employment:
      type: object
      description: 'DE: Informationen über das Beschäftigungsverhältnis des Antragstellers. <br/> EN: Information regarding employment data.

        '
      allOf:
      - $ref: '#/components/schemas/BaseOccupation'
      properties:
        jobInformation:
          $ref: '#/components/schemas/JobInformation'
        contractLimitation:
          $ref: '#/components/schemas/ContractLimitation'
        probation:
          $ref: '#/components/schemas/JobProbation'
        parentalLeave:
          $ref: '#/components/schemas/ParentalLeave'
        shortTimeWork:
          $ref: '#/components/schemas/ShortTimeWork'
    RegisterCover:
      description: 'DE: Grundbuchdaten. <br/> EN: General information about the land register sheet.

        '
      type: object
      properties:
        registerCourt:
          description: 'DE: Amtsgericht. <br/> EN: Land registry/local court.

            '
          type: string
        registerCity:
          description: 'DE: Grundbuchbezirk. <br/> EN: City of land register.

            '
          type: string
        registerVolume:
          description: 'DE: Nummer des Bandes. <br/> EN: Number of the volume of the land register.

            '
          type: string
        registerPage:
          description: 'DE: Nummer des Blattes. <br/> EN: Page in the land register.

            '
          type: string
        areaNeedingMeasurement:
          description: "DE: geschätzte Größe der zu vermessenden Teilfläche. <br/> \nEN: estimated size of the area needing measurement\n"
          $ref: '#/components/schemas/SquareMeter'
    Year:
      type: object
      title: Year
      nullable: true
      description: 'DE: Ein Jahr nach ISO-8601-Kalendersystem. EN: A year in the ISO-8601 calendar system.

        '
      required:
      - value
      properties:
        value:
          type: string
          description: 'DE: Das Jahr. EN: The year.

            '
          pattern: ^\d{4}$
          example: '2019'
    HouseUtilityUnitGroupsBreakdown:
      type: object
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/HouseUtilityUnitGroup'
    ExternalProcessing:
      type: object
      description: 'EN: Information regarding the external processing

        '
      required:
      - details
      properties:
        details:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ExternalProcessingDetail'
        estimatedConclusion:
          $ref: '#/components/schemas/ISODate'
        remark:
          type: string
    Households:
      type: object
      description: 'A wrapper Type to hold a set of households associated with the financing application.

        '
      properties:
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        embedded:
          $ref: '#/components/schemas/HouseholdsQuery'
    HouseUtilityRentedUnitGroup:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseHouseUtilityUnitGroup'
      properties:
        rentDetails:
          $ref: '#/components/schemas/HouseRentedUnitDetails'
    Consultation:
      readOnly: true
      type: object
      description: 'DE: Informationen über die Beratung und dazugehörige Empfehlungen. <br/>

        EN: Information about the involved parties in the consultation phase and the associated recommendations.

        '
      required:
      - broker
      properties:
        advisory:
          $ref: '#/components/schemas/AdvisoryDetails'
        broker:
          deprecated: true
          x-replaced-with: advisory.broker
          description: 'DE: Daten des Vermittlers. <br/>

            EN: Information about the main Broker (Interhp, Prohyp, MLP Hyp or Prohyp-WhiteLabel-Partner).

            '
          $ref: '#/components/schemas/Advisor'
        subBroker:
          deprecated: true
          x-replaced-with: advisory.subBrokers
          description: 'DE: Untervermittler des Antrags. <br/>

            EN: Sub advisor.

            '
          $ref: '#/components/schemas/Advisor'
        informers:
          type: array
          deprecated: true
          x-replaced-with: advisory.clientAdvisor
          description: 'DE: Daten des Zuträgers. <br/>

            EN: Information about the involved informer.

            '
          items:
            $ref: '#/components/schemas/Informer'
        recommendation:
          $ref: '#/components/schemas/Recommendation'
        brokerageOrganization:
          type: string
          deprecated: true
          x-replaced-with: advisory.brokeragePlatform.platformIdentifier
          description: 'DE: Beratungsunternehmenidentifikator - Vermittlernummer. <br/>

            EN: Advisor company identifier

            '
    CounterOfferSuspendedAmortizationCombinedProduct:
      oneOf:
      - $ref: '#/components/schemas/CounterOfferBuildingSavingLoan'
      discriminator:
        propertyName: product
        mapping:
          BAU_SPAR: '#/components/schemas/CounterOfferBuildingSavingLoan'
    BrokeragePlatform:
      type: object
      required:
      - company
      properties:
        company:
          $ref: '#/components/schemas/OrganizationCompany'
        platformIdentifier:
          $ref: '#/components/schemas/BrokeragePlatformIdentifier'
    FinancialStanding:
      oneOf:
      - $ref: '#/components/schemas/FinancialEquity'
      - $ref: '#/components/schemas/FinancialDebt'
      - $ref: '#/components/schemas/Income'
      - $ref: '#/components/schemas/Expense'
      discriminator:
        propertyName: type
        mapping:
          EQUITY: '#/components/schemas/FinancialEquity'
          DEBT: '#/components/schemas/FinancialDebt'
          INCOME: '#/components/schemas/Income'
          EXPENSE: '#/components/schemas/Expense'
    HouseholdCalculationCommandExpenses:
      type: object
      required:
      - valuation
      - entries
      properties:
        value:
          description: Der vom Kunden eingetragene Wert
          $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        valuation:
          description: Der von der Bank angesetzte Wert
          $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        entries:
          type: array
          items:
            $ref: '#/components/schemas/HouseholdCalculationCommandEntry'
    BaseMainProduct:
      type: object
      description: 'DE: Information zum Hauptdarlehensprodukt. <br/> EN: Main loan product information.

        '
      required:
      - product
      properties:
        product:
          description: 'DE: Typ des Hauptdarlehensproduktes. <br/>

            EN: Main loan product type.

            '
          $ref: '#/components/schemas/MainProductType'
        productName:
          description: 'DE: Name des Hauptdarlehensproduktes. <br/>

            EN: Main loan product name.

            '
          type: string
      discriminator:
        propertyName: product
    FinancingOfferStatus:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/FinancingOfferStatusKey'
    RealEstateEquity:
      type: object
      required:
      - total
      description: 'DE: Eigenkapital durch Immobilienvermögen. <br/> EN: Real estate equity.

        '
      properties:
        total:
          description: 'DE: Weiteres Immobilienvermögen (Marktwert). <br/>

            EN: Other real estate assets (market value).

            '
          $ref: '#/components/schemas/EuroAmount'
        guarantee:
          description: 'DE: Sicherungsabtretung von Immobilienvermögen.<br/>

            EN: Other realestate for assignment for security.

            @deprecated: Use FinancingVenture.assignmentForSecurity.realEstateAssignedForSecurity instead.

            '
          deprecated: true
          $ref: '#/components/schemas/EuroAmount'
        items:
          type: array
          items:
            $ref: '#/components/schemas/RealEstateEquityItem'
        description:
          type: string
    SpecialPropertyType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/SpecialPropertyTypeKey'
    Applicant:
      type: object
      description: 'DE: Detaillierte Informationen des Antragstellers. <br/> EN: Detailed information about the applicant.

        '
      required:
      - id
      - person
      properties:
        id:
          description: 'DE: Id des Antragsstellers. <br/> EN: Id of the applicant.

            '
          $ref: '#/components/schemas/ApplicantId'
        person:
          description: 'DE: Personendaten des Antragsstellers. <br/> EN: Personal data of the applicant.

            '
          $ref: '#/components/schemas/Person'
        contact:
          description: 'DE: Kontaktdaten des Antragsstellers. <br/> EN: Contact information about the applicant.

            '
          $ref: '#/components/schemas/Contact'
        address:
          description: 'DE: Derzeitige Adresse des Antragstellers. <br/> EN: Current address of the applicant.

            '
          $ref: '#/components/schemas/Address'
        previousAddress:
          deprecated: true
          description: '@deprecated: use the field livingAddresses instead. <br/> DE: Voranschrift. <br/> EN: Previous address of the applicant

            '
          $ref: '#/components/schemas/Address'
        livingAddresses:
          type: array
          description: 'DE: Liste Addressen mit Angaben zum Zeitraum, an denen die Person in den letzten Jahren gewohnt hat. Die aktuelle Adresse ist ebenfalls enthalten. <br/>

            EN: List of addresses the person has lived in over the last years. The current address is also included.

            '
          items:
            $ref: '#/components/schemas/LivingAddress'
        nationalities:
          type: array
          description: 'DE: Nationalitäten des Antragstellers. <br/> EN: Nationalities of the applicant.

            '
          items:
            $ref: '#/components/schemas/Nationality'
        maritalStatus:
          description: 'DE: Familienstand des Antragstellers. <br/> EN: Marital status of the applicant.

            '
          $ref: '#/components/schemas/MaritalStatus'
        maritalPropertyStatus:
          description: 'DE: Beschreibung des ehelichen Güterstandes vom Antragsteller. <br/> EN: Matrimonial property of the applicant.

            '
          $ref: '#/components/schemas/MaritalPropertyStatus'
        creditWorthiness:
          description: 'DE: Informationen über die Kreditwürdigkeit des Antragstellers. <br/> EN: Information regarding credit worthiness of the applicant.

            '
          $ref: '#/components/schemas/CreditWorthiness'
        occupationalActivity:
          deprecated: true
          description: '@Deprecated: this only contains one of possible multiple occupations. Please see ''occupations'' for a complete list. DE: Informationen über die derzeitige Erwerbstätigkeiten des Antragsstellers. <br/> EN: Information about the current occupation of the applicant.

            '
          $ref: '#/components/schemas/Occupation'
        occupations:
          type: array
          description: 'DE: Informationen über alle derzeitigen Erwerbstätigkeiten des Antragsstellers. <br/> EN: Information about all current occupations of the applicant.

            '
          items:
            $ref: '#/components/schemas/Occupation'
        taxId:
          type: string
          description: 'DE: Steueridentifikationsnummer des Antragstellers. <br/> EN: Tax identification number.

            '
        passportID:
          x-skip-camel-case-check: true
          type: string
          example: CY887232L
          description: 'DE: Ausweis Identifikationsnummer. <br/> EN: Id of passport.

            '
        bankAccount:
          description: 'DE: Daten zum Bankaccount des Antragsstellers. <br/> EN: Applicant''s bank details.

            '
          $ref: '#/components/schemas/BankAccount'
        financialStandings:
          description: 'DE: Link um die Daten zur finanziellen Situation des Antragsstellers abzurufen. <br/> EN: A link to retrieve all information about financing situation for a specific applicant.

            '
          $ref: '#/components/schemas/ResourceRef'
        temporaryResidencePermit:
          description: 'DE: Informationen falls die Aufenthaltserlaubnis befristet ist. <br/> EN: Information if the residence permit is temporary.

            '
          $ref: '#/components/schemas/TemporaryResidencePermit'
        unionInfo:
          $ref: '#/components/schemas/UnionInfo'
        mortgageExperience:
          description: 'DE: Hat die Person schon einmal eine Immobilie finanziert? (true = ja, false = nein, null = keine Angabe)<br/> EN: indication, whether the person has taken up a mortgage before (true; false; null = no information)

            '
          type: boolean
          nullable: true
        children:
          type: array
          nullable: false
          description: "DE: Unterhaltspflichtige Kinder der Person. Wenn gemeinsame Kinder mit einem weiteren Antragssteller existieren, werden diese nur einmal aufgeführt. <br/> \nEN: Children of the person that are obligation to pay alimony. If there are common children with one of the additional applicants, they will only be listed once.\n"
          items:
            $ref: '#/components/schemas/Child'
        additionalInfos:
          description: 'DE: Zusätzliche Details für den Antragsteller (Schlüssel-Werte Paar). <br/>

            EN: Additional applicant details (key-value pairs).

            '
          type: array
          items:
            $ref: '#/components/schemas/AdditionalInfo'
    EstateAcquisitionCosts:
      type: object
      description: 'DE: Kosten für den Erwerb der Immobilie. <br/> EN: Estate costs when purchasing a property.

        '
      properties:
        brokerage:
          description: 'DE: Maklercourtage. <br/>

            EN: Broker costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        costsNotary:
          description: 'DE: Notar-/ Grundbuchkosten <br/>

            EN: Notary costs.

            '
          $ref: '#/components/schemas/EuroAmount'
        purchaseTax:
          description: 'DE: Grunderwerbsteuer. <br/>

            EN: Purchase tax.

            '
          $ref: '#/components/schemas/EuroAmount'
    SubmissionOverviewItem:
      type: object
      required:
      - submittedAt
      - _href
      description: 'Holds overview information about the requested Submission.


        Further details will be delivered in the embedded property if specified.


        Please refer to *Expansion* section for more details.

        '
      properties:
        submittedAt:
          description: 'DE: Datum der Einreichung. <br/>

            EN: Date when this submission has been submitted.

            '
          $ref: '#/components/schemas/ISODateTime'
        _href:
          x-skip-camel-case-check: true
          $ref: '#/components/schemas/ResourceRef'
        embedded:
          $ref: '#/components/schemas/SubmissionOverview'
    AcceptSubmissionCounterOfferCommand:
      type: object
      description: command to accept a counter offer.
      required:
      - counterOfferId
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        counterOfferId:
          $ref: '#/components/schemas/SubmissionCounterOfferId'
        remark:
          type: string
    NeighbourhoodKey:
      type: string
      description: 'DE: Umgebung (nicht abschließende Aufzählung), z.B. RESIDENTIAL=reines_Wohngebiet, COMMERCIAL=ueberwiegend_Gewerbegebiet, MIXED=Mischgebiet, INDUSTRIAL=Industriegebiet, OUTSIDE=Einzellage_außerhalb_des_Ortes. <br/> EN: Open ended enum contains neighbourhood details, possible values are RESIDENTIAL, COMMERCIAL, MIXED, INDUSTRIAL, OUTSIDE .

        '
      example: RESIDENTIAL
      x-extensible-enum:
      - RESIDENTIAL
      - COMMERCIAL
      - MIXED
      - INDUSTRIAL
      - OUTSIDE
      - OTHER
    Nationality:
      type: object
      required:
      - country
      - type
      properties:
        country:
          description: 'DE: Staatsangehörigkeit des Antragstellers. <br/> EN: Country of the nationality.

            '
          $ref: '#/components/schemas/CountryCode'
        type:
          $ref: '#/components/schemas/NationalityType'
    EstateAdditionalLoanUsage:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/EstateAdditionalLoanUsageKey'
    UnArchiveSubmissionCommand:
      description: Remove the archived flag from a submission.
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
    SpecialRealEstateCharacteristics:
      oneOf:
      - $ref: '#/components/schemas/SpecialHouseCharacteristics'
      - $ref: '#/components/schemas/DefaultSpecialRealEstateCharacteristics'
      discriminator:
        propertyName: type
        mapping:
          HOUSE: '#/components/schemas/SpecialHouseCharacteristics'
          DEFAULT: '#/components/schemas/DefaultSpecialRealEstateCharacteristics'
    UpdateLoanPartnerDecisionDateCommand:
      description: Update the predicted decision date of a submission.
      type: object
      required:
      - decisionDate
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionCommand'
      properties:
        decisionDate:
          $ref: '#/components/schemas/PredictedLoanPartnerDecisionDate'
    PeriodicalEuroAmount:
      description: 'DE: Euro Betrag in einem bestimmten Zeitraum. <br/> EN: Euro amount for a specific period.

        '
      type: object
      required:
      - amount
      - cycle
      properties:
        amount:
          $ref: '#/components/schemas/EuroAmount'
        cycle:
          $ref: '#/components/schemas/Cycle'
    InterestRate:
      description: 'DE: Information über den Zins. <br/>

        EN: Information about the interest rate.

        '
      type: object
      properties:
        nominal:
          description: 'DE: Nominalzins (Sollzins) in Prozent <br/>

            EN: Nominal interest rate percent per period.

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
        effective:
          description: 'DE: Effektivzins in Prozent. <br/>

            EN: Effective interest rate percent per period. <br/>

            '
          $ref: '#/components/schemas/PeriodicalPercentage'
    SavingsPlanBurden:
      type: object
      properties:
        savingsBurden:
          description: 'DE: Sparrate. <br/> EN: Periodical saving rate.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        additionalSavings:
          description: 'DE: Zusätzlicher Sparbeitrag. <br/> EN: Additional savings.

            '
          $ref: '#/components/schemas/EuroAmount'
        numberOfSavingsBurdens:
          description: 'DE: Anzahl zu zahlender Sparraten. <br/> EN: Number of to be paid saving rates.

            '
          type: integer
          format: int32
        payedRates:
          description: 'DE: Sparbeiträge insgesamt. <br/> EN: The sum of the rates payed in the savings phase.

            '
          $ref: '#/components/schemas/EuroAmount'
        specialPayments:
          type: array
          description: 'DE: Sonderzahlungen. <br/> EN: Special payments.

            '
          items:
            $ref: '#/components/schemas/SavingsPlanBurdenSpecialPayment'
    PeriodicalRawEuroAmount:
      description: 'DE: Euro Betrag in einem bestimmten Zeitraum. <br/> EN: Euro amount for a specific period.

        '
      type: object
      required:
      - amount
      - cycle
      properties:
        amount:
          $ref: '#/components/schemas/RawEuroAmount'
        cycle:
          $ref: '#/components/schemas/Cycle'
    KfwPromotionLoan:
      description: 'DE: Information zum Kfw-Darlehen. <br/>

        EN: Information about the KFW promotion loan.

        '
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseLoan'
      properties:
        program:
          $ref: '#/components/schemas/KfwProgram'
        annuityDetails:
          $ref: '#/components/schemas/AnnuityDetails'
        reservations:
          description: "DE: Sammlung von KFW-Darlehensreservierungen. <br/>\n    EN: Collection of KFW loan reservations.\n"
          type: array
          items:
            $ref: '#/components/schemas/KfwReservationInfo'
        additionalInfo:
          $ref: '#/components/schemas/KfwLoanAdditionalInfo'
    RejectSubmissionCounterOfferReasonKey:
      type: string
      description: 'DE: offenes Enum enthält mögliche Gründe für die Ablehnung eines Gegenangebots, mögliche Werte sind (CONDITION_NOT_ATTRACTIVE_FOR_CUSTOMER = Konditionen waren für den Kunden nicht attraktiv, CUSTOMER_DECIDED_DIFFERENT_PROVIDER=Kunden hat sich für einen anderen Finanzierungspartner (besseres Angebot) entschieden, CONDITION_NOT_FEASIBLE_FOR_CUSTOMER=Bedingung der Bank für den Kunden nicht darstellbar, OTHER=Nicht aufgeführter Grund). EN: open ended enum contains possible counter offer rejection reasons, possible values are (CONDITION_NOT_ATTRACTIVE_FOR_CUSTOMER, CUSTOMER_DECIDED_DIFFERENT_PROVIDER, CONDITION_NOT_FEASIBLE_FOR_CUSTOMER, OTHER).

        '
      example: OTHER
      x-extensible-enum:
      - CONDITION_NOT_ATTRACTIVE_FOR_CUSTOMER
      - CUSTOMER_DECIDED_DIFFERENT_PROVIDER
      - CONDITION_NOT_FEASIBLE_FOR_CUSTOMER
      - OTHER
    OtherIncome:
      type: object
      required:
      - other
      description: 'DE: Anderes (zusätzliches) regelmäßiges Einkommen. <br/> EN: Other periodical income.

        '
      properties:
        other:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        external:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        description:
          type: string
    ClientKey:
      type: string
      description: 'DE: Datenquelle, mögliche Werte: INTERHYP_ASP, COBA_ASP. <br/> EN: Enum representing data origin, possible values are INTERHYP_ASP, COBA_ASP.

        '
      example: INTERHYP_ASP
      x-extensible-enum:
      - INTERHYP_ASP
      - COBA_ASP
    FinancialBurdenDetail:
      description: 'DE: Detailierte Information über den Belastungsplan innerhalb der Haushaltsrechnung.<br/>

        EN: Detailed information about financial burden within household calculation.

        '
      type: object
      properties:
        index:
          description: 'DE: Reihenfolge Index innerhalb Belastungsplan. <br/>

            EN: Order index within financial burden.

            '
          type: integer
        deadline:
          description: 'DE: Stichtag für die Belastung. <br/>

            EN: Burden deadline.

            '
          $ref: '#/components/schemas/ISODate'
        occasion:
          type: string
          description: 'DE: Anlass der Belastung. <br/>

            EN: Burden reason.

            '
        description:
          type: string
          description: 'DE: Beschreibung der Belastung. <br/>

            EN: Burden description.

            '
        deltaLiquidity:
          description: 'DE: Deltaliquidität. <br/>

            EN: Delta liquidity.

            '
          $ref: '#/components/schemas/EuroAmount'
        residualLiquidity:
          description: 'DE: Restliquidität. <br/>

            EN: Residual liquidity.

            '
          $ref: '#/components/schemas/EuroAmount'
    SelfEmploymentIncomeItem:
      type: object
      description: 'DE: Informationen zum Einkommen aus selbständiger Tätigkeit für ein Jahr <br/> EN: Describes the self employment income information for a year.

        '
      properties:
        year:
          type: integer
          format: int32
          description: 'DE: Jahr (lfd/Vorjahr/Vorvorjahr). <br/>

            EN: The balance year.

            '
        netProfit:
          description: 'DE: Persönlicher Nachsteuergewinn. <br/>

            EN: Personal after-tax profit.

            '
          $ref: '#/components/schemas/EuroAmount'
        surplus:
          description: 'DE: Überschuss/Fehlbetrag. <br/>

            EN: Excess / shortfall.

            '
          $ref: '#/components/schemas/EuroAmount'
        deficit:
          $ref: '#/components/schemas/EuroAmount'
        taxes:
          description: 'DE: Steuern. <br/>

            EN: Deducted Taxes.

            '
          $ref: '#/components/schemas/EuroAmount'
    Advisor:
      readOnly: true
      type: object
      description: 'DE: Informationen über den Berater. <br/> EN: Information about the advisor.

        '
      required:
      - advisorCompany
      properties:
        userId:
          $ref: '#/components/schemas/UserId'
        companyId:
          $ref: '#/components/schemas/CompanyId'
        advisorCompany:
          description: 'DE: Die an der Vermittlung beteiligte Firma.. <br/> EN: Company involved in the brokerage process.

            '
          $ref: '#/components/schemas/CompanyAdvisor'
        responsiblePersons:
          description: 'DE: Für die Vermittlung zuständige Personen. <br/> EN: Persons responsible for the brokerage.

            '
          type: array
          items:
            $ref: '#/components/schemas/ResponsiblePerson'
    DefaultRealEstateRating:
      allOf:
      - $ref: '#/components/schemas/BaseRealEstateRating'
      properties:
        localPriceDetails:
          $ref: '#/components/schemas/LocalPriceDetails'
    SavingPlanTariff:
      type: object
      required:
      - id
      - name
      - loanPartner
      properties:
        id:
          description: 'DE: ID der gewählter Bauspartarif. <br/>

            EN: ID of the chosen savings plan tariff.

            '
          example: KF.195
          type: string
        name:
          description: 'DE: Name der gewählter Bauspartarif. <br/>

            EN: Name of the chosen savings plan tariff.

            '
          example: D/Komfort 1,95%
          type: string
        loanPartner:
          deprecated: true
          description: Can be removed after the changes to the loan partner structure have been released
          $ref: '#/components/schemas/LoanPartnerProcessingUnit'
        loanPartnerId:
          $ref: '#/components/schemas/CompanyId'
        variantPrice:
          description: 'DE: einmalig Variantepreis. <br/> EN: costs for variant.

            '
          $ref: '#/components/schemas/EuroAmount'
        magazineCosts:
          description: 'DE: !!!. <br/> EN: The potential costs of the saving plan magazines.

            '
          $ref: '#/components/schemas/PeriodicalEuroAmount'
    PredictedLoanPartnerDecisionDate:
      description: 'DE: Voraussichtliches Entscheidungsdatum des Kreditgebers. <br/> EN: Predicted decision date of the loan partner.

        '
      type: object
      required:
      - date
      properties:
        date:
          $ref: '#/components/schemas/ISODate'
        reason:
          type: string
          description: 'DE: Begründung für das voraussichtliche Entscheidungsdatum. EN: Reason for the predicted decision date.

            '
    SubmissionStatusType:
      type: string
      description: 'DE: Mögliche Status der Einreichung (nicht abschließende Aufzählung), z.B. (REJECTED, CONTRACT_DELIVERED) <br/> EN: Open ended enum contains submission status value, possible values are (REJECTED, CONTRACT_DELIVERED)

        '
      example: REJECTED
      x-extensible-enum:
      - REJECTED
      - CONTRACT_DELIVERED
      - CONTRACT_SIGNED
      - INWORK
      - APPROVED
      - REJECTION_REVOKED
      - AWAIT_EXTERNAL_PROCESSING
      - CREATED
      - SUBMITTED
      - AVAILABLE_FOR_DECISION
      - REVOKED
      - ANONYMIZED
      - COUNTER_OFFER_CREATED
      - COUNTER_OFFER_ACCEPTED
      - COUNTER_OFFER_REJECTED
      - PROCESSING_PAUSED
      - CONTRACT_SIGN_REFUSED
      - CONTRACT_CANCELED
      - CONFIRMED
      - REJECTED_AND_CLOSED
    RejectReasonKey:
      type: string
      x-extensible-enum:
      - OBJ_CRAFT
      - GRND_PRICE
      - BAD_UTILIZE
      - BAD_STATE
      - LUX_HOBBY
      - CREDIT_NEG
      - REL_DEBIT
      - HH_INC_TO_VOL
      - HH_CREDITS
      - HH_NO_DEDUCT
      - HH_HI_INCOME
      - HH_EXPENSES
      - HH_NEG_BAL
      - SCHUFA_NEG
      - SCHUFA_SCOR
      - INTERN_RED
      - FRAME
      - LOW_EQUITY
      - DEBT_RATIO
      - JOB_AMOUNT
      - RENT_RISK
      - PROBATION
      - SHORT_SE
      - SECTION2
      - SECTION3
      - EXIST_CUST
      - MANIPULATE
      - EVIDENCE
      - UNKNOWN
      - CONTRACT
      - OVERALL_CONSTELLATION
      - NEGATIVE_HOUSEHOLD_CALCULATION
      - PROPERTY_VALUATION_LOAN_QUOTA
      - OTHER
    BaseCreditWorthiness:
      type: object
      description: 'DE: Informationen über die Kreditwürdigkeit des Antragstellers (zum Beispiel Schufa Score). <br/> EN: Information regarding credit worthiness (like Schufa-Score).

        '
      required:
      - type
      properties:
        type:
          type: string
          description: 'DE: Art der Ermittlung der Kreditwürdigkeitsbeurteilung (nicht abschließende Aufzählung, zum Beispiel: Schufa). <br/> EN: Open ended enum contains possible Worthiness Ratings, possible values are SCHUFA.

            '
          x-extensible-enum:
          - SCHUFA
      discriminator:
        propertyName: type
    RegularMainProduct:
      allOf:
      - $ref: '#/components/schemas/BaseMainProduct'
    FinancialEquity:
      type: object
      required:
      - type
      description: 'DE: Informationen zum Eigenkapital vor Beginn des Finanzierungsprozesses. <br/> EN: Financial equity information before the financing process.

        '
      allOf:
      - $ref: '#/components/schemas/BaseFinancialStanding'
      properties:
        cash:
          description: 'DE: Bankguthaben (vor der Finanzierung). <br/>

            EN: Bank balance (before financing).

            '
          $ref: '#/components/schemas/EuroAmount'
        stock:
          description: 'DE: Informationen über Wertpapiere (vor der Finanzierung). <br/>

            EN: Stock assets information (before financing).

            '
          $ref: '#/components/schemas/EuroAmount'
        mortgageSaving:
          description: 'DE: gesamt bisher angesparte Bausparguthaben (vor der Finanzierung). <br/>

            EN: total up to date saved home savings plans (before financing).

            '
          $ref: '#/components/schemas/EuroAmount'
        mortgageSavingPlansDetails:
          type: array
          items:
            $ref: '#/components/schemas/BuildingSavingPlanEquity'
        insurance:
          description: 'DE: Informationen zu Rückkaufwerte von Lebens-/Pensionsversicherungen. <br/> EN: Surrender value life-/pension insurance equity.

            '
          $ref: '#/components/schemas/EuroAmount'
        realEstate:
          $ref: '#/components/schemas/RealEstateEquity'
        other:
          $ref: '#/components/schemas/OtherEquity'
    KfwProgramKey:
      type: string
      description: 'DE: KFW-Förderprogramm (nicht abschließende Aufzählung), z.B. Wohneigen, Wohn159, Energie153-40, Energie151, Energie152, Energie167. <br/> EN: Open ended enum contains possible programs for Kfw, i.e. Wohneigen, Wohn159, Energie153-40, Energie151, Energie152, Energie167.

        '
      example: Wohneigen
      x-extensible-enum:
      - Wohneigen
      - Wohn159
      - Energie153-40
      - Energie151
      - Energie152
      - Energie167
      - Eff261
      - Einzel262
      - KFNWohnselbst297
      - KFNWohnselbstQNG297
      - KFNWohnkapital298
      - KFNWohnkapitalQNG298
      - WEPFamilien300
      - WEPFamilienQNG300
      - WEPFamilienJKA308
      - EMKreditPlus
      - EMKredit
      - KNN296WOHN
    ProductType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/ProductTypeKey'
    BaseRateDetails:
      type: object
      required:
      - rateType
      properties:
        rateType:
          $ref: '#/components/schemas/RateDetailsType'
        interestRate:
          $ref: '#/components/schemas/InterestRate'
        payment:
          $ref: '#/components/schemas/RegularPayment'
        residualDebt:
          description: 'DE: Restschuld nach Ablauf der Sollzinsbindung. <br/>

            EN: Remaining debt at the end of fixed interest maturity.

            '
          $ref: '#/components/schemas/EuroAmount'
      discriminator:
        propertyName: rateType
    Basement:
      type: object
      description: 'DE: Information über den Keller. <br/> EN: Information about building basement.

        '
      properties:
        basementDetail:
          $ref: '#/components/schemas/BasementDetail'
        basementExtensionForResidentialUse:
          $ref: '#/components/schemas/BasementExtensionForResidentialUse'
        basementArea:
          description: 'DE: Kellerfläche. <br/>

            EN: Basement space.

            '
          $ref: '#/components/schemas/SquareMeter'
    ExternalEstateId:
      description: 'DE: ID des vorhandenen Objekts im System <br/> EN: ID of existing object in the system

        '
      type: object
      required:
      - value
      properties:
        value:
          type: string
    Violation:
      description: 'DE: Ein Verstoss gegen die Schnittstellenspezifikation. EN: A violation against the API schema.

        '
      type: object
      title: Violation
      properties:
        field:
          type: string
          description: 'DE: Bezeichner des problematischen Felds. EN: Name of the problematic field.

            '
          example: address.city.numberOfInhabitants
        message:
          type: string
          description: 'DE: Beschreibung des Verstosses. EN: Description of the violation.

            '
          example: Must be greater than or equal to 0.
    Paging:
      type: object
      description: 'Cursor-based pagination to improve performance and minimize networks traffic, Pagination is enforced for operations

        that potentially could return a large collection of items.

        '
      properties:
        cursor:
          $ref: '#/components/schemas/Cursor'
        previous:
          type: string
          format: uri
          description: 'A Hyperlink that will return the previous page of data. If not included, this is the first page of data.

            '
        next:
          type: string
          format: uri
          description: 'A Hyperlink that will return the next page of data. If not included, this is the last page of data.



            > The Absence of *next* hyperlink indicates that a query reached the end of the available result.

            '
        first:
          type: string
          format: uri
          description: 'A Hyperlink that will return the first page of data.

            '
        last:
          type: string
          format: uri
          description: 'A Hyperlink that will return the last page of data at this point of time.

            '
        self:
          type: string
          format: uri
          description: 'A Hyperlink that will return the current page of data.

            '
    LoanPartnerProcessorId:
      description: 'DE: ID des (Kredit-)Bearbeiters. <br/> EN: Id of the loan partner processor.

        '
      required:
      - value
      properties:
        value:
          type: string
    LoanPartnerProcessorEmail:
      description: 'DE: E-Mail Adresse des (Kredit-)Bearbeiters. <br/> EN: E-Mail address of the loan partner processor.

        '
      properties:
        email:
          type: string
    JobInformation:
      type: object
      description: 'DE: Stellenbeschreibung der Tätigkeit. <br/> EN: Detailed information about the specified job.

        '
      properties:
        jobDescription:
          type: string
          description: 'DE: Stellenbeschreibung der Tätigkeit. <br/> EN: The description/name of the job.

            '
        businessLine:
          description: 'DE: Branche des Auftraggebers/Arbeitgebers. <br/> EN: Business line of the employer.

            '
          $ref: '#/components/schemas/BusinessLine'
        employer:
          type: string
          description: 'DE: Name des Auftraggebers/Arbeitgebers. <br/> EN: The name of the employer.

            '
        startDate:
          description: 'DE: Beginn des Beschäftigungsverhältnis. <br/> EN: Start date of the employment.

            '
          $ref: '#/components/schemas/ISODate'
    FinancingVentureConstruction:
      description: 'DE: Information über das Finanzierungsvorhaben beim Bau einer Immobilie. <br/>

        EN: Information about the financing venture when building the property.

        '
      required:
      - financingNeed
      - financingDetails
      allOf:
      - $ref: '#/components/schemas/BaseFinancingVenture'
      properties:
        financingNeed:
          $ref: '#/components/schemas/ForeignEstateFinancingNeed'
        financingDetails:
          $ref: '#/components/schemas/FinancingDetails'
        constructionStartDate:
          description: 'DE: Beginn der Bauarbeiten an der Immobilie. <br/>

            EN: Start date of the construction work on the property.

            '
          $ref: '#/components/schemas/ISODate'
    SquareMeter:
      type: object
      description: 'DE: Angabe in Quadratmetern. <br/> EN: Specification in square metres.

        '
      required:
      - value
      properties:
        value:
          type: number
          format: double
    HouseholdCalculationCommandEntry:
      type: object
      required:
      - name
      - valuation
      properties:
        name:
          type: string
          description: Name des Eintrages
        hints:
          type: array
          description: Liste an Hinweißen
          items:
            type: string
        values:
          type: array
          description: Der vom Kunden eingetragene Wert
          items:
            $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        valuation:
          description: Der von der Bank angesetzte Wert
          $ref: '#/components/schemas/PeriodicalRawEuroAmount'
        loanId:
          $ref: '#/components/schemas/LoanId'
    VariableIncome:
      type: object
      description: 'DE: Regelmäßige variable Einkünfte (netto). <br/>

        EN: Regular variable gross income.

        '
      required:
      - amount
      properties:
        amount:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        breakdown:
          $ref: '#/components/schemas/VariableIncomeBreakdown'
    FurnishingKey:
      type: string
      description: 'DE: Beurteilung der Austattung der Immobilie (nicht abschließende Aufzählung). Einflussfaktoren sind z. B. verwendete Böden, etc. <br/> EN: Open ended enum contains property configuration (furnishing) details, possible values are (SIMPLE, GOOD, VERY_GOOD).

        '
      example: SIMPLE
      x-extensible-enum:
      - SIMPLE
      - GOOD
      - VERY_GOOD
      - OTHER
    Expense:
      type: object
      required:
      - type
      description: 'DE: Ein Untertyp von "Financial Standing", welcher alle Informationen zu den `Ausgaben` beinhaltet. <br/>

        EN: A specific financial standing type holds all information related to periodical `Expenses` aspects.

        '
      allOf:
      - $ref: '#/components/schemas/BaseFinancialStanding'
      properties:
        housing:
          $ref: '#/components/schemas/HousingExpense'
        insurance:
          $ref: '#/components/schemas/InsuranceExpense'
        alimony:
          $ref: '#/components/schemas/AlimonyExpense'
        existingLoans:
          $ref: '#/components/schemas/ExistingLoanExpenses'
        other:
          $ref: '#/components/schemas/OtherExpense'
    ParentalAllowanceInfo:
      type: object
      description: 'DE: Informationen über Elterngeld. <br/> EN: Informations regarding parental/child-raising allowance.

        '
      required:
      - parentalAllowance
      properties:
        parentalAllowance:
          $ref: '#/components/schemas/PeriodicalEuroAmount'
        endDate:
          $ref: '#/components/schemas/ISODate'
    FinancingOfferStatusKey:
      description: 'DE: Status des Finanzierungsangebots. <br/>

        EN: Financing offer status.

        '
      type: string
      x-extensible-enum:
      - ACCEPTED
      - REJECTED
    EuroAmountPerSquareMeter:
      description: 'DE: Euro Betrag pro Quadratmeter. <br/> EN: Euro amount per square meter.

        '
      type: object
      required:
      - amount
      properties:
        amount:
          $ref: '#/components/schemas/EuroAmount'
    BaseInterestMaturity:
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/InterestMaturityType'
      discriminator:
        propertyName: type
    PreInquiryStatus:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/PreInquiryStatusKey'
    PeriodicalSavingsEntry:
      type: object
      allOf:
      - $ref: '#/components/schemas/EntryPeriod'
      - $ref: '#/components/schemas/SavingsEntry'
    LoanToValueRatioLoanBreakdown:
      title: LoanToValueRatioLoanBreakdown
      type: object
      required:
      - valuation
      properties:
        valuation:
          description: Die Summe der Gesamtwerte, die die Bank ansetzt in Euro
          $ref: '#/components/schemas/RawEuroAmount'
        entries:
          type: array
          items:
            $ref: '#/components/schemas/LoanToValueRatioEntry'
    LoanQuotaTypeKey:
      type: string
      description: 'DE: Ursprung des Wertes der Darlehensquote (nicht abschließende Aufzählung), z.B. CALCULATED, EXTERNAL. <br/> EN: Open ended enum contains loan quota values, possible values are CALCULATED, EXTERNAL.

        '
      example: CALCULATED
      x-extensible-enum:
      - CALCULATED
      - EXTERNAL
  parameters:
    handover-report-name:
      name: name
      in: path
      required: true
      schema:
        type: string
      description: Document Id for the requested handover report.
      example: MTIzNDU2Ny1QUk9WSURFUl9DT1ZFUl9MRVRURVItUHJvdmlkZXJhbnNjaHJlaWJlbg==
    since:
      name: since
      in: query
      description: 'A UTC date-time value that points to the start of the range of time-based data.


        Defined by date-time - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).'
      required: true
      schema:
        type: string
        format: date-time
        example: 2019-12-29 10:22:50+00:00
    cursor-after:
      name: after
      in: query
      description: Cursor that points to the end of the page of data that has been returned.
      required: false
      schema:
        type: string
    credit-loan-id:
      name: creditLoanId
      in: path
      required: true
      schema:
        type: string
      description: Id for the requested credit loan.
    calculation-type:
      name: calculationType
      in: path
      required: true
      schema:
        type: string
        enum:
        - household
        - condition
        - lending_value
      description: Subtype of the calculation data.
    sbms-sort:
      name: sort
      in: query
      style: form
      required: false
      description: 'To indicate sorting direction, fields may be prefixed with `+` ascending or `-` descending.


        Note: sorting applies only within a single result page when multiple pages are returned.'
      example: ?sort=+submittedAt
      schema:
        type: string
        enum:
        - +submittedAt
        - -submittedAt
    cursor-before:
      name: before
      in: query
      description: Cursor that points to the start of the page of data that has been returned.
      required: false
      schema:
        type: string
    embed:
      name: embed
      in: query
      style: form
      required: false
      schema:
        type: boolean
      description: 'Flag to expand or embed sub-resources in the response resource.


        By default is set to `FALSE` where only a **ref** to the sub-resources will be returned. By set it to `TRUE` the sub-resources content will be embedded in the response which might affect the payload size'
    submission-id:
      name: submissionId
      in: path
      required: true
      schema:
        type: string
      description: Id for the requested submission.
    document-id:
      name: documentId
      in: path
      required: true
      schema:
        type: string
      description: Id for the requested submission document.
    sbms-limit:
      name: limit
      in: query
      description: 'Specifies how many items to return at one time (max 50).


        A query may return fewer than the value of limit due to filtering.'
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 50
        default: 20
    until:
      name: until
      in: query
      description: 'A UTC date-time value that points to the end of the range of time-based data. If not provided, current date-time is used.


        Defined by date-time - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).'
      required: false
      schema:
        type: string
        format: date-time
        example: 2019-12-29 10:22:50+00:00
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT