diff --git a/submission-api-data/submission-api-data.yaml b/submission-api-data/submission-api-data.yaml index 3f95072..aeb616b 100644 --- a/submission-api-data/submission-api-data.yaml +++ b/submission-api-data/submission-api-data.yaml @@ -150,10 +150,6 @@ tags: description: provides endpoints to access submission logbook - name: commands description: provides endpoints to access to commands sent to the submission API -- name: legacy-submission - description: Create legacy submission commands -- name: correspondence - description: access to submission correspondence - name: pre-submission-checks description: provides endpoints for pre-submission resources associated with a specific financing partner @@ -1121,54 +1117,6 @@ paths: application/json: schema: $ref: '#/components/schemas/RFC7807Problem' - /submissions/correspondence: - get: - summary: Delivers all submissions correspondence for a provider - description: Delivers a collection of submission correspondence among involved - submission process parties for a specific provider filtered by the date of - correspondence.
*By Default*, we will return the first *20* matching records. - However, this is not a hard limitation! a parameter called `limit` can be - used to tell the API how many records you want to return all at once *(max - 40)*.
To get further matching records, a parameter called `after` or `before` - can be used to tell the API the start of each page using specified cursor.
- To navigate through the query result, a reference to the following navigations
- are included in the response *(next, prev, first, last, self)*.
- operationId: getSubmissionsCorrespondence
- tags:
- - correspondence
- parameters:
- - $ref: '#/components/parameters/since'
- - $ref: '#/components/parameters/until'
- - $ref: '#/components/parameters/correspondence-type-filter'
- - $ref: '#/components/parameters/sbms-correspondence-limit'
- - $ref: '#/components/parameters/cursor-after'
- - $ref: '#/components/parameters/cursor-before'
- - $ref: '#/components/parameters/embed'
- responses:
- '200':
- description: A paged array of submissions correspondence
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SubmissionCorrespondence'
- '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
@@ -1320,258 +1268,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
- /submissions/{submissionId}/correspondence:
- get:
- summary: Get correspondence for a specific submission
- description: Delivers detailed information about correspondence among involved
- submission process parties associated with a specific submission. By default
- the result will be sorted based on createdAt ascending.
- operationId: getCorrespondenceBySubmissionId
- tags:
- - correspondence
- parameters:
- - $ref: '#/components/parameters/submission-id'
- - $ref: '#/components/parameters/correspondence-type-filter'
- - $ref: '#/components/parameters/sbms-correspondence-sort'
- responses:
- '200':
- description: Submission correspondence are returned
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Correspondence'
- '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'
- post:
- summary: Create new correspondence for a specific submission
- operationId: createSubmissionCorrespondence
- tags:
- - correspondence
- parameters:
- - $ref: '#/components/parameters/submission-id'
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CorrespondenceItem'
- responses:
- '201':
- description: Correspondence was created
- content:
- application/json:
- schema:
- properties:
- id:
- type: string
- headers:
- Location:
- schema:
- type: string
- description: Link to retrieve a specific resource
- example: http://some-domain/some/link/to/somewhere
- '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'
- delete:
- summary: Delete correspondence assocaited with a specific submission
- operationId: deleteSubmissionCorrespondence
- tags:
- - correspondence
- parameters:
- - $ref: '#/components/parameters/submission-id'
- responses:
- '204':
- description: Submission correspondence are deleted
- '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}/correspondence/{itemId}:
- get:
- summary: Get a specific submission correspondence item
- description: Delivers detailed information about a specific submission correspondence
- item.
- operationId: getSubmissionCorrespondenceById
- tags:
- - correspondence
- parameters:
- - $ref: '#/components/parameters/correspondence-item-id'
- - $ref: '#/components/parameters/submission-id'
- responses:
- '200':
- description: Submission corresponcence item is returned
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CorrespondenceItem'
- '401':
- description: Error indicates no access to the required resource.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/OAuthProblem'
- '400':
- description: Error indicates missing or wrong request parameters.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/RFC7807Problem'
- '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'
- delete:
- summary: Delete a specific submission correspondence item
- operationId: deleteSubmissionCorrespondenceById
- tags:
- - correspondence
- parameters:
- - $ref: '#/components/parameters/correspondence-item-id'
- - $ref: '#/components/parameters/submission-id'
- responses:
- '204':
- description: Submission correspondence item is deleted
- '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'
- put:
- summary: Override a specific submission correspondence item
- operationId: overrideSubmissionCorrespondenceById
- tags:
- - correspondence
- parameters:
- - $ref: '#/components/parameters/correspondence-item-id'
- - $ref: '#/components/parameters/submission-id'
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CorrespondenceItem'
- responses:
- '204':
- description: Submission correspondence item is updated
- '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}/credit-loans/{creditLoanId}:
get:
summary: Get a specific credit loan
@@ -1857,104 +1553,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RFC7807Problem'
- /submissions/{submissionId}/legacy-commands:
- post:
- deprecated: true
- summary: Endpoint for legacy submission commands.
- description: |
- This endpoint gives a possibility to modify an existing submission asynchronously by creating a legacy command to perform this operation, as a result a *command id* shall be returned. @deprecated: This endpoint is for internal uses. The endpoint will reach end of life in further minor releases.
- operationId: modifySubmissionLegacy
- tags:
- - legacy-submission
- parameters:
- - $ref: '#/components/parameters/submission-id'
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ModifySubmissionLegacyCommand'
- responses:
- '201':
- description: Reference to the created resource.
- headers:
- Location:
- schema:
- type: string
- description: |
- DE: Link zu einer spezifischen Ressource
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}/legacy-documents:
- post:
- deprecated: true
- summary: Endpoint for uploading submission document using its metadata.
- description: |
- @deprecated: This Endpoint is for internal uses and legacy document handling. The Endpoint will reach End Of Life in further minor releases.
- operationId: uploadSubmissionDocument
- tags:
- - legacy-submission
- parameters:
- - $ref: '#/components/parameters/submission-id'
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UploadSubmissionDocumentLegacyCommand'
- responses:
- '201':
- description: Reference to the created resource.
- headers:
- Location:
- schema:
- type: string
- description: |
- DE: Link zu einer spezifischen Ressource
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}/logbook:
get:
summary: Get submission logbook entries
@@ -2187,24 +1785,6 @@ components:
schema:
type: string
description: Id of the requested command
- correspondence-item-id:
- name: itemId
- in: path
- required: true
- schema:
- type: string
- description: Id for the requested submission correspondence item.
- correspondence-type-filter:
- name: correspondenceType
- in: query
- required: false
- schema:
- type: string
- enum:
- - message
- - note
- description: query parameter to restrict submissions associated with the provided
- correspondence type.
credit-loan-id:
name: creditLoanId
in: path
@@ -2309,36 +1889,6 @@ components:
schema:
type: string
description: Id for the requested pre submission check id.
- sbms-correspondence-limit:
- name: limit
- in: query
- description: Specifies how many items to return at one time (max 40).
A
- query may return fewer than the value of limit due to filtering.
- required: false
- schema:
- type: integer
- format: int32
- minimum: 1
- maximum: 40
- default: 20
- sbms-correspondence-sort:
- name: sort
- in: query
- style: form
- required: false
- description: Comma-separated list of fields to define the sort order.
To
- indicate sorting direction, fields may be prefixed with `+` ascending or `-`
- descending.
**e.g.** /correspondence?sort=+createdAt
***Note***
- sorting applies only within a single result page when multiple pages are returned.
-
- example: sort=+createdAt
- schema:
- type: array
- items:
- type: string
- enum:
- - +createdAt
- - -createdAt
sbms-limit:
name: limit
in: query
@@ -2409,21 +1959,9 @@ components:
- $ref: '#/components/schemas/BaseSubmissionCommand'
properties:
counterOfferId:
- $ref: '#/components/schemas/SubmissionCounterOfferId'
- remark:
- type: string
- AcceptSubmissionLegacyStatus:
- description: Accept submission command
- type: object
- required:
- - sendContractDate
- allOf:
- - $ref: '#/components/schemas/BaseChangeSubmissionStatusLegacyCommandData'
- properties:
- sendContractDate:
- $ref: '#/components/schemas/ISODate'
- loans:
- $ref: '#/components/schemas/LegacyStatusLoans'
+ $ref: '#/components/schemas/SubmissionCounterOfferId'
+ remark:
+ type: string
AcceptedCounterOfferLogbookEntryDetails:
type: object
description: Accepted counter offer submission logbook entry details
@@ -2434,13 +1972,6 @@ components:
properties:
id:
$ref: '#/components/schemas/SubmissionCounterOfferId'
- AcknowledgeSubmissionEditingLegacyCommand:
- type: object
- description: |
- This command is only used for internal purposes!
- This command is intended to acknowledge changes made during editing.
- allOf:
- - $ref: '#/components/schemas/BaseSubmissionLegacyCommand'
AddSubmissionLogbookNoteCommand:
description: command to add Logbook note for the submission
type: object
@@ -3053,19 +2584,6 @@ components:
DE: Gewerbliche Fläche für Eigenbedarf.
EN: Commercial space for own use.
$ref: '#/components/schemas/SquareMeter'
- AssignLoanPartnerProcessorLegacyCommand:
- description: |
- This command is only used for internal purposes!
- This command is intended to assign a processor to an existing submission.
- type: object
- allOf:
- - $ref: '#/components/schemas/BaseSubmissionLegacyCommand'
- properties:
- processor:
- deprecated: true
- $ref: '#/components/schemas/LoanPartnerProcessingInfo'
- loanPartnerDetails:
- $ref: '#/components/schemas/LoanPartnerDetails'
AssignProcessorLogbookEntry:
type: object
description: |
@@ -3295,22 +2813,6 @@ components:
$ref: '#/components/schemas/ISODate'
discriminator:
propertyName: type
- BaseChangeSubmissionStatusLegacyCommandData:
- type: object
- description: Change submission command
- required:
- - status
- properties:
- remark:
- type: string
- changedOn:
- $ref: '#/components/schemas/ISODateTime'
- origin:
- $ref: '#/components/schemas/LegacyStatusChangeOrigin'
- status:
- $ref: '#/components/schemas/LegacyStatusType'
- discriminator:
- propertyName: status
BaseCommandTrigger:
type: object
required:
@@ -3326,21 +2828,6 @@ components:
- SYSTEM
discriminator:
propertyName: type
- BaseCorrespondenceItem:
- type: object
- required:
- - type
- properties:
- type:
- $ref: '#/components/schemas/SubmissionCorrespondenceType'
- id:
- type: string
- createdAt:
- $ref: '#/components/schemas/ISODateTime'
- author:
- type: string
- discriminator:
- propertyName: type
BaseCounterOfferLoan:
type: object
description: |
@@ -4076,26 +3563,6 @@ components:
- APPROVE_SUBMISSION_COMMISSION_CHANGE
discriminator:
propertyName: operation
- BaseSubmissionLegacyCommand:
- type: object
- required:
- - operation
- properties:
- trigger:
- $ref: '#/components/schemas/CommandTrigger'
- createdOn:
- $ref: '#/components/schemas/ISODateTime'
- operation:
- type: string
- x-extensible-enum:
- - CHANGE_STATUS
- - UPDATE_CREDIT_LOANS
- - ACKNOWLEDGE_EDITING_CHANGES
- - ASSIGN_PROCESSOR
- - REVOKE
- - UPDATE_ADVISOR_CONTACT
- discriminator:
- propertyName: operation
BaseSubmissionStatus:
type: object
description: |
@@ -4765,15 +4232,6 @@ components:
type: string
cancellationDate:
$ref: '#/components/schemas/ISODate'
- CancelSubmissionLegacyStatus:
- type: object
- required:
- - cancelContractDate
- allOf:
- - $ref: '#/components/schemas/BaseChangeSubmissionStatusLegacyCommandData'
- properties:
- cancelContractDate:
- $ref: '#/components/schemas/ISODate'
CapitalIncome:
type: object
description: |
@@ -4873,37 +4331,6 @@ components:
$ref: '#/components/schemas/ProcessingUnit'
remark:
type: string
- ChangeSubmissionStatusLegacyCommand:
- type: object
- required:
- - status
- description: |
- This command is only used for internal purposes!
- This command is intended to change the submission status
- allOf:
- - $ref: '#/components/schemas/BaseSubmissionLegacyCommand'
- properties:
- data:
- $ref: '#/components/schemas/ChangeSubmissionStatusLegacyCommandData'
- ChangeSubmissionStatusLegacyCommandData:
- oneOf:
- - $ref: '#/components/schemas/AcceptSubmissionLegacyStatus'
- - $ref: '#/components/schemas/CancelSubmissionLegacyStatus'
- - $ref: '#/components/schemas/ContractSignSubmissionLegacyStatus'
- - $ref: '#/components/schemas/InworkSubmissionLegacyStatus'
- - $ref: '#/components/schemas/OnholdSubmissionLegacyStatus'
- - $ref: '#/components/schemas/RejectSubmissionLegacyStatus'
- - $ref: '#/components/schemas/ConfirmSubmissionLegacyStatus'
- discriminator:
- propertyName: status
- mapping:
- ACCEPT: '#/components/schemas/AcceptSubmissionLegacyStatus'
- CANCEL: '#/components/schemas/CancelSubmissionLegacyStatus'
- CONTRACT_SIGN: '#/components/schemas/ContractSignSubmissionLegacyStatus'
- INWORK: '#/components/schemas/InworkSubmissionLegacyStatus'
- ONHOLD: '#/components/schemas/OnholdSubmissionLegacyStatus'
- REJECT: '#/components/schemas/RejectSubmissionLegacyStatus'
- CONFIRM: '#/components/schemas/ConfirmSubmissionLegacyStatus'
Child:
type: object
description: |
@@ -5223,20 +4650,6 @@ components:
type: array
items:
$ref: '#/components/schemas/CommissionCalculationInfo'
- ConfirmSubmissionLegacyStatus:
- type: object
- required:
- - confirmedAt
- - loans
- allOf:
- - $ref: '#/components/schemas/BaseChangeSubmissionStatusLegacyCommandData'
- properties:
- signContractDate:
- $ref: '#/components/schemas/ISODate'
- confirmedAt:
- $ref: '#/components/schemas/ISODateTime'
- loans:
- $ref: '#/components/schemas/LegacyStatusLoans'
ConfirmedSubmissionStatus:
type: object
description: |
@@ -5467,17 +4880,6 @@ components:
$ref: '#/components/schemas/RefuseSignContractReason'
remark:
type: string
- ContractSignSubmissionLegacyStatus:
- type: object
- required:
- - signContractDate
- allOf:
- - $ref: '#/components/schemas/BaseChangeSubmissionStatusLegacyCommandData'
- properties:
- signContractDate:
- $ref: '#/components/schemas/ISODate'
- loans:
- $ref: '#/components/schemas/LegacyStatusLoans'
ContractSignedStatus:
type: object
description: |
@@ -5504,22 +4906,6 @@ components:
type: array
items:
$ref: '#/components/schemas/ExtendedContractInfo'
- Correspondence:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/CorrespondenceItem'
- CorrespondenceItem:
- oneOf:
- - $ref: '#/components/schemas/SubmissionMessage'
- - $ref: '#/components/schemas/SubmissionNote'
- discriminator:
- propertyName: type
- mapping:
- MESSAGE: '#/components/schemas/SubmissionMessage'
- NOTE: '#/components/schemas/SubmissionNote'
CounterOfferAnnuityRateDetails:
type: object
allOf:
@@ -6105,14 +5491,6 @@ components:
- DAYS
description: |
DE: Die Zeiteinheit. EN: The temporal unit.
- EmbeddedSubmissionCorrespondence:
- type: object
- properties:
- correspondence:
- type: array
- items:
- $ref: '#/components/schemas/CorrespondenceItem'
- x-is-plural: true
Employment:
type: object
description: |
@@ -8290,10 +7668,6 @@ components:
EN: Collection of loans relevant for the planed financing venture.
items:
$ref: '#/components/schemas/VentureRelevantLoan'
- InworkSubmissionLegacyStatus:
- type: object
- allOf:
- - $ref: '#/components/schemas/BaseChangeSubmissionStatusLegacyCommandData'
JobInformation:
type: object
description: |
@@ -8538,90 +7912,6 @@ components:
mapping:
true: '#/components/schemas/LeaseHold'
false: '#/components/schemas/NoLeaseHold'
- LegacyOnHoldReason:
- type: object
- required:
- - key
- properties:
- key:
- $ref: '#/components/schemas/LegacyOnHoldReasonKey'
- LegacyOnHoldReasonKey:
- type: string
- x-extensible-enum:
- - DOCUMENTS
- - INFOS
- - BY_CUSTOMER
- - ONHOLD
- - EXPERTISE
- - ORIG_CONTR
- - REJ_SOON
- - FIN_APPROV
- - MIN_DOCS
- LegacyStatusChangeKey:
- type: string
- description: |
- EN: Source system that can trigger legacy status change, possible values are PARTNER_PORTAL, LEGACY_IHK.
- x-extensible-enum:
- - PARTNER_PORTAL
- - LEGACY_IHK
- LegacyStatusChangeOrigin:
- type: object
- required:
- - key
- properties:
- key:
- $ref: '#/components/schemas/LegacyStatusChangeKey'
- LegacyStatusLoan:
- type: object
- properties:
- seq:
- type: integer
- format: int32
- loanId:
- $ref: '#/components/schemas/LoanId'
- creditLoanId:
- $ref: '#/components/schemas/CreditLoanId'
- contractNumber:
- type: string
- amount:
- $ref: '#/components/schemas/EuroAmount'
- maturity:
- $ref: '#/components/schemas/InterestMaturity'
- nominalRate:
- $ref: '#/components/schemas/PeriodicalPercentage'
- amortisation:
- $ref: '#/components/schemas/PeriodicalPercentage'
- effectiveRate:
- $ref: '#/components/schemas/PeriodicalPercentage'
- fixedUntil:
- $ref: '#/components/schemas/ISODate'
- sotiDesc:
- type: string
- sotiPercentage:
- $ref: '#/components/schemas/PeriodicalPercentage'
- commission:
- $ref: '#/components/schemas/Percentage'
- commissionAmount:
- $ref: '#/components/schemas/EuroAmount'
- kfwProduct:
- type: string
- LegacyStatusLoans:
- type: object
- properties:
- items:
- type: array
- minItems: 1
- items:
- $ref: '#/components/schemas/LegacyStatusLoan'
- LegacyStatusType:
- type: string
- x-extensible-enum:
- - ACCEPT
- - CANCEL
- - CONTRACT_SIGN
- - INWORK
- - ONHOLD
- - REJECT
LendingValueCalculation:
description: |
DE: Information zu der Kalkulation
@@ -9551,23 +8841,6 @@ components:
UPDATE_CONTACT_USER: '#/components/schemas/UpdateSubmissionContactUserCommand'
ADD_SUBMISSION_LOGBOOK_NOTE: '#/components/schemas/AddSubmissionLogbookNoteCommand'
APPROVE_SUBMISSION_COMMISSION_CHANGE: '#/components/schemas/ApproveSubmissionCommissionChangeCommand'
- ModifySubmissionLegacyCommand:
- oneOf:
- - $ref: '#/components/schemas/ChangeSubmissionStatusLegacyCommand'
- - $ref: '#/components/schemas/UpdateSubmissionCreditLoansLegacyCommand'
- - $ref: '#/components/schemas/AcknowledgeSubmissionEditingLegacyCommand'
- - $ref: '#/components/schemas/AssignLoanPartnerProcessorLegacyCommand'
- - $ref: '#/components/schemas/RevokeSubmissionLegacyCommand'
- - $ref: '#/components/schemas/UpdateAdvisorContactLegacyCommand'
- discriminator:
- propertyName: operation
- mapping:
- CHANGE_STATUS: '#/components/schemas/ChangeSubmissionStatusLegacyCommand'
- UPDATE_CREDIT_LOANS: '#/components/schemas/UpdateSubmissionCreditLoansLegacyCommand'
- ACKNOWLEDGE_EDITING_CHANGES: '#/components/schemas/AcknowledgeSubmissionEditingLegacyCommand'
- ASSIGN_PROCESSOR: '#/components/schemas/AssignLoanPartnerProcessorLegacyCommand'
- REVOKE: '#/components/schemas/RevokeSubmissionLegacyCommand'
- UPDATE_ADVISOR_CONTACT: '#/components/schemas/UpdateAdvisorContactLegacyCommand'
Nationality:
type: object
required:
@@ -9741,22 +9014,6 @@ components:
revision:
type: string
description: Offer revision that has been currently submitted
- OnholdSubmissionLegacyStatus:
- type: object
- required:
- - predictedOffHoldDate
- - predictedDaysPost
- - onHoldReason
- allOf:
- - $ref: '#/components/schemas/BaseChangeSubmissionStatusLegacyCommandData'
- properties:
- predictedOffHoldDate:
- $ref: '#/components/schemas/ISODate'
- predictedDaysPost:
- type: integer
- format: int32
- onHoldReason:
- $ref: '#/components/schemas/LegacyOnHoldReason'
OpenPropertySale:
type: object
description: |
@@ -11551,17 +10808,6 @@ components:
- CUSTOMER_DECIDED_DIFFERENT_PROVIDER
- CONDITION_NOT_FEASIBLE_FOR_CUSTOMER
- OTHER
- RejectSubmissionLegacyStatus:
- type: object
- required:
- - rejectReason
- allOf:
- - $ref: '#/components/schemas/BaseChangeSubmissionStatusLegacyCommandData'
- properties:
- rejectSolution:
- type: string
- rejectReason:
- $ref: '#/components/schemas/RejectReason'
RejectSubmissionStatusChangedLogbookEntryDetails:
type: object
allOf:
@@ -11838,24 +11084,6 @@ components:
- READJUST_COUNTER_OFFER
- COUNTER_OFFER_NOT_ACCEPTED
- OTHER
- RevokeSubmissionLegacyCommand:
- description: This command is only used for internal purposes!
- type: object
- required:
- - reason
- - revokedOn
- allOf:
- - $ref: '#/components/schemas/BaseSubmissionLegacyCommand'
- properties:
- reason:
- type: string
- reasonDescription:
- type: string
- remark:
- type: string
- revokedOn:
- type: string
- format: date-time
RevokeSubmissionRejectionCommand:
description: command to revert a rejection of a submission during credit decision
phase.
@@ -12571,38 +11799,6 @@ components:
properties:
refuseReason:
$ref: '#/components/schemas/RefuseSignContractReason'
- SubmissionCorrespondence:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/SubmissionCorrespondenceItem'
- paging:
- $ref: '#/components/schemas/Paging'
- SubmissionCorrespondenceItem:
- type: object
- properties:
- submission:
- $ref: '#/components/schemas/SubmissionRef'
- correspondence:
- $ref: '#/components/schemas/SubmissionCorrespondenceRef'
- SubmissionCorrespondenceRef:
- type: object
- properties:
- _href:
- x-skip-camel-case-check: true
- $ref: '#/components/schemas/ResourceRef'
- embedded:
- $ref: '#/components/schemas/EmbeddedSubmissionCorrespondence'
- SubmissionCorrespondenceType:
- type: string
- description: |
- DE: Art der Korrespondenz (nicht abschließende Aufzählung), z.B. (MESSAGE, NOTE).
EN: Open ended enum contains correspondence types, possible values are (MESSAGE, NOTE).
- example: MESSAGE
- x-extensible-enum:
- - MESSAGE
- - NOTE
SubmissionCounterOffer:
type: object
properties:
@@ -12812,28 +12008,6 @@ components:
SUBMISSION_LOAN_PARTNER_DOCUMENT_UPDATED: '#/components/schemas/SubmissionLoanPartnerDocumentLogbookEntry'
SUBMISSION_LOAN_PARTNER_DOCUMENT_DELETED: '#/components/schemas/SubmissionLoanPartnerDocumentLogbookEntry'
LOAN_PARTNER_PROCESSING_UNIT_CHANGED: '#/components/schemas/LoanPartnerProcessingUnitChangedLogbookEntry'
- SubmissionMessage:
- type: object
- description: |
- DE: Enthält Nachrichten, die sich auf eine bestimmte Einreichung beziehen. Die Nachrichten richten sich an einen bestimmten Empfänger.
EN: Contains messages related to a specific submission. Messages target a certain recipient.
- allOf:
- - $ref: '#/components/schemas/BaseCorrespondenceItem'
- properties:
- to:
- type: string
- text:
- type: string
- SubmissionNote:
- type: object
- description: |
- DE: Enthält Notizen in Bezug auf eine bestimmte Einreichung.
EN: Contains notes related to a specific submission
- allOf:
- - $ref: '#/components/schemas/BaseCorrespondenceItem'
- properties:
- category:
- type: string
- text:
- type: string
SubmissionOverview:
readOnly: true
type: object
@@ -13529,19 +12703,6 @@ components:
DE: Laufzeit des Tilgungssurrogats.
EN: Duration of the repayment surrogate product.
$ref: '#/components/schemas/Duration'
- UpdateAdvisorContactLegacyCommand:
- writeOnly: true
- description: |
- This command is only used for internal purposes!
- This command is intended to assign a currently active advisor to an existing submission.
- type: object
- required:
- - advisorContact
- allOf:
- - $ref: '#/components/schemas/BaseSubmissionLegacyCommand'
- properties:
- advisorContact:
- $ref: '#/components/schemas/Advisor'
UpdateLoanPartnerDecisionDateCommand:
description: Update the predicted decision date of a submission.
type: object
@@ -13565,18 +12726,6 @@ components:
$ref: '#/components/schemas/UserId'
companyId:
$ref: '#/components/schemas/CompanyId'
- UpdateSubmissionCreditLoansLegacyCommand:
- type: object
- required:
- - loans
- description: |
- This command is only used for internal purposes!
- This command is intended to change the submission credit loans
- allOf:
- - $ref: '#/components/schemas/BaseSubmissionLegacyCommand'
- properties:
- loans:
- $ref: '#/components/schemas/LegacyStatusLoans'
UpdateSubmissionLoanContractNumberCommand:
description: Update the contract number of a loan of a submission.
type: object
@@ -13594,32 +12743,6 @@ components:
description: |
DE: Optionale Informationen über den Auslöser der Aktion.
EN: Optional information about the trigger of the command.
$ref: '#/components/schemas/PersonName'
- UploadSubmissionDocumentLegacyCommand:
- type: object
- required:
- - mediaId
- - type
- - uploadedAt
- - name
- properties:
- trigger:
- $ref: '#/components/schemas/CommandTrigger'
- mediaId:
- type: string
- type:
- $ref: '#/components/schemas/UploadedDocumentType'
- uploadedAt:
- $ref: '#/components/schemas/ISODateTime'
- name:
- type: string
- label:
- type: string
- uploadedBy:
- description: Can be removed after the changes have been released.
- deprecated: true
- $ref: '#/components/schemas/LoanPartnerProcessingInfo'
- createdBy:
- $ref: '#/components/schemas/ProcessorId'
UploadedDocumentType:
type: object
required: