Interhyp logbook API

openapi: 3.0.2
info:
  title: Interhyp Submission commands logbook 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: logbook
  description: provides endpoints to access submission logbook
paths:
  /submissions/{submissionId}/logbook:
    get:
      summary: Get submission logbook entries
      description: Delivers detailed information about logbook entries associated with a specific submission.
      operationId: getLogbookBySubmissionId
      tags:
      - logbook
      parameters:
      - $ref: '#/components/parameters/submission-id'
      responses:
        '200':
          description: Submission logbook entries are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionLogbook'
        '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'
components:
  schemas:
    DefaultLogbookEntry:
      allOf:
      - $ref: '#/components/schemas/BaseLogbookEntry'
    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'
    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'
    UploadedDocumentTypeKey:
      type: string
      example: CONTRACT
      x-extensible-enum:
      - CONTRACT
      - CONTRACT_ADDENDA
      - LAND_REGISTER_EXTRACT
      - PAYOUT_REQUIREMENT
      - OTHER
    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
    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.

            '
    InterestMaturity:
      oneOf:
      - $ref: '#/components/schemas/VariableInterestMaturity'
      - $ref: '#/components/schemas/FixedInterestMaturity'
      discriminator:
        propertyName: type
        mapping:
          VARIABLE: '#/components/schemas/VariableInterestMaturity'
          FIXED_PERIOD: '#/components/schemas/FixedInterestMaturity'
    AssignProcessorLogbookEntry:
      type: object
      description: 'DE: Ein Logbucheintrag mit Informationen zu dem neu zugewiesenen Bearbeiter. <br/> EN: A logbook entry holds information about assigning a loan partner processor to the submission.

        '
      allOf:
      - $ref: '#/components/schemas/BaseLogbookEntry'
      properties:
        assignedTo:
          $ref: '#/components/schemas/UserData'
    AcceptedCounterOfferLogbookEntryDetails:
      type: object
      description: Accepted counter offer submission logbook entry details
      required:
      - id
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatusChangedLogbookEntryDetails'
      properties:
        id:
          $ref: '#/components/schemas/SubmissionCounterOfferId'
    RefuseSignContractReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RefuseSignContractReasonKey'
    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
    Title:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/TitleKey'
    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'
    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'
    LoanId:
      type: object
      description: 'DE: ID des Darlehens. <br/> EN: Loan identifier.

        '
      properties:
        value:
          type: string
    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'
    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'
    PauseReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/PauseReasonKey'
    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'
    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'
    SubmissionStatusChangedLogbookEntry:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseLogbookEntry'
      properties:
        details:
          $ref: '#/components/schemas/SubmissionStatusChangedLogbookEntryDetails'
    BaseSpecialRepayment:
      type: object
      required:
      - type
      description: 'DE: Information zur Sondertilgung. <br/> EN: Special repayment information.

        '
      properties:
        type:
          $ref: '#/components/schemas/SpecialRepaymentType'
      discriminator:
        propertyName: type
    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
    LogbookEntryType:
      type: string
      description: 'DE: Art des Logbookentry (nicht abschließende Aufzählung), z.B. (SUBMISSION_CREATED, SUBMISSION_EDITED, DECISION_DATE_UPDATED, UPLOADED_DOCUMENT, STATUS). <br/> EN: open ended enum contains possible logbook entry types, possible values are (SUBMISSION_CREATED, SUBMISSION_EDITED, DECISION_DATE_UPDATED, UPLOADED_DOCUMENT, STATUS).

        '
      example: UPLOADED_DOCUMENT
      x-extensible-enum:
      - SUBMISSION_CREATED
      - SUBMISSION_EDITED
      - SUBMISSION_MIGRATED
      - SUBMISSION_CREDIT_LOANS_UPDATED
      - LOAN_PARTNER_PROCESSOR_ASSIGNED
      - UPLOADED_DOCUMENT
      - DECISION_DATE_UPDATED
      - STATUS
      - SUBMISSION_COUNTER_OFFER_REVOKED
      - SUBMISSION_STATUS_CHANGED
      - CONTACT_ADVISOR_UPDATED
      - LOAN_CONTRACT_NUMBER_UPDATED
      - SUBMISSION_DATA_VIOLATIONS_SET
      - SUBMISSION_REVOKED
      - SUBMISSION_LOAN_PARTNER_DOCUMENT_CREATED
      - SUBMISSION_LOAN_PARTNER_DOCUMENT_UPDATED
      - SUBMISSION_LOAN_PARTNER_DOCUMENT_DELETED
      - LOAN_PARTNER_PROCESSING_UNIT_CHANGED
      - SUBMISSION_NOTE_ADDED
    DefaultSubmissionStatusChangedLogbookEntryDetails:
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatusChangedLogbookEntryDetails'
    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
    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'
    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
    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'
    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'
    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
    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
    InterestRateUpdate:
      oneOf:
      - $ref: '#/components/schemas/AnnuityInterestRateUpdate'
      - $ref: '#/components/schemas/BuildingSavingPlanInterestRateUpdate'
      discriminator:
        propertyName: rateUpdateType
        mapping:
          ANNUITY: '#/components/schemas/AnnuityInterestRateUpdate'
          BUILDING_SAVING_PLAN: '#/components/schemas/BuildingSavingPlanInterestRateUpdate'
    DecisionDateLogbookEntry:
      type: object
      description: 'DE: Ein Logbucheintrag mit Informationen zu dem geänderten Entscheidungsdatum. <br/> EN: A logbook entry holds information about updating submission decision date.

        '
      allOf:
      - $ref: '#/components/schemas/BaseLogbookEntry'
      properties:
        newDecisionDate:
          $ref: '#/components/schemas/ISODate'
    SubmissionAdditionalProductsUpdatedLogbookEntryDetails:
      type: object
      properties:
        updatedProducts:
          type: array
          items:
            $ref: '#/components/schemas/SubmissionAdditionalProduct'
          minItems: 0
        originalProducts:
          type: array
          items:
            $ref: '#/components/schemas/SubmissionAdditionalProduct'
          minItems: 0
    BaseLogbookEntry:
      type: object
      required:
      - id
      - type
      description: 'DE: Informationen zu einem Logbucheintrag. <br/>

        EN: Holds information about a logbook entry.

        '
      properties:
        id:
          $ref: '#/components/schemas/LogbookEntryId'
        type:
          $ref: '#/components/schemas/LogbookEntryType'
        createdAt:
          description: 'DE: Ein UTC Zeitstempel wann die mit dem Logbucheintrag verknüpfte Aktion ausgelöst wurde. <br/> EN: A UTC date-time indicates when the event associated to the logbook entry took place.

            '
          $ref: '#/components/schemas/ISODateTime'
        createdBy:
          description: 'DE: Der Nutzer, welcher die Aktion ausgelöst hat, die zu dem Logbucheintrag führt. <br/> EN: User who triggered the event associated to the logbook entry.

            '
          $ref: '#/components/schemas/UserData'
        remark:
          type: string
      discriminator:
        propertyName: type
    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
    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
    DebtId:
      type: object
      description: 'DE: ID der Verbindlichkeit. <br/>

        EN: ID of the associated Debt.

        '
      required:
      - value
      properties:
        value:
          type: string
    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'
    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.

            '
    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
    RejectedCounterOfferLogbookEntryDetails:
      type: object
      required:
      - id
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatusChangedLogbookEntryDetails'
      properties:
        id:
          $ref: '#/components/schemas/SubmissionCounterOfferId'
        reason:
          $ref: '#/components/schemas/RejectSubmissionCounterOfferReason'
    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'
    ContractCanceledStatusLogbookEntryDetails:
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseSubmissionStatusChangedLogbookEntryDetails'
      properties:
        reason:
          $ref: '#/components/schemas/CancelContractReason'
        cancellationDate:
          $ref: '#/components/schemas/ISODate'
    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
    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'
    RejectReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/RejectReasonKey'
    ApplicantId:
      type: object
      required:
      - value
      properties:
        value:
          description: 'DE: Id des Antragstellers. <br/> EN: Id of the applicant.

            '
          type: string
          example: '1'
    LoanPartnerQueueId:
      type: object
      required:
      - value
      description: 'DE: ID der loan parnter queue. <br/> EN: Loan partner queue id.

        '
      properties:
        value:
          type: string
    LogbookEntryId:
      type: object
      properties:
        value:
          type: string
    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
    AuxProductType:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/AuxProductTypeKey'
    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
    SubmissionRevokedReason:
      type: object
      required:
      - key
      properties:
        key:
          $ref: '#/components/schemas/SubmissionRevokedReasonKey'
    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
    CreditLoanId:
      type: object
      description: 'DE: Id der Finanzierungsstruktur. <br/> EN: Credit Loan identifier.

        '
      required:
      - value
      properties:
        value:
          type: string
    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
    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
    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'
    SubmissionLogbookEntry:
      oneOf:
      - $ref: '#/components/schemas/DefaultLogbookEntry'
      - $ref: '#/components/schemas/AssignProcessorLogbookEntry'
      - $ref: '#/components/schemas/DocumentLogbookEntry'
      

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