Interhyp submissions API

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/SuspendedAmortizationCombinedPro

# --- truncated at 32 KB (396 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/interhyp/refs/heads/main/openapi/interhyp-submissions-api-openapi.yml