openapi: 3.2.0
info:
  title: Fenergo Financial Analysis API
  version: '1.0'
  description: 'Operations tagged FinancialAnalysis across 2 of this provider''s published API definitions: fenergo-financialanalysiscommand-v1-0-openapi.json, fenergo-financialanalysisquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /financialanalysiscommand
- url: /financialanalysisquery
security:
- Bearer: []
tags:
- name: FinancialAnalysis
paths:
  /api/financialanalysis:
    post:
      tags:
      - FinancialAnalysis
      summary: Create a new Financial Analysis Set
      description: 'Creates a new Financial Analysis Set for an entity. The request must contain entity id and entity type.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: CreateFinancialAnalysisSet
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Create Financial Analysis Set request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinancialAnalysisSetDtoServiceRequest'
      responses:
        '202':
          description: Success. Financial Analysis Set created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisSetDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/joint:
    post:
      tags:
      - FinancialAnalysis
      summary: Initialize a new Joint Financial Analysis
      description: 'Initialize a new Joint Financial Analysis for a pair of entities. The request must contain entity id and entity type.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: InitializeJointFinancialAnalysis
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Initialize Joint Financial Analysis request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JointFinancialAnalysisInitializeRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Joint Financial Analysis Initialized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JointFinancialAnalysisInitializeResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{setId}/version:
    post:
      tags:
      - FinancialAnalysis
      summary: Create a new Financial Analysis Version and Financial Analysis Schema
      description: 'This method creates a new Financial Analysis Version based on the previous completed version.


        It also generates the Financial Analysis Schema based on the input and save it to s3.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: CreateFinancialAnalysisVersion
      parameters:
      - name: setId
        in: path
        description: Financial Analysis Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ServiceRequest with the schema snapshot data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveSchemaDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisVersionDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Financial Analysis Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{setId}/{id}:
    put:
      tags:
      - FinancialAnalysis
      summary: Update a Financial Analysis Version
      description: 'This method updates an existing Financial Analysis Version.


        Only Financial Analysis Version with draft status can be updated.


        Only Financial Analysis Version that satisfied non-mandatory validation rules can be updated.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: UpdateFinancialAnalysisVersion
      parameters:
      - name: setId
        in: path
        description: Financial Analysis Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: Financial Analysis Version Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Financial Analysis Version data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinancialAnalysisVersionDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisVersionDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Financial Analysis with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{setId}/{id}/scenario:
    put:
      tags:
      - FinancialAnalysis
      summary: Update a Financial Analysis Version's Scenario
      description: 'This method updates an existing Financial Analysis Version''s Scenario.


        Only Financial Analysis Version with draft status can be updated.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: UpdateScenarios
      parameters:
      - name: setId
        in: path
        description: Financial Analysis Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: Financial Analysis Version Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Financial Analysis Scenario data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScenarioVersionDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioVersionDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Financial Analysis Scenario with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{setId}/{id}/summary:
    put:
      tags:
      - FinancialAnalysis
      summary: Update a Financial Analysis Version's Summary
      description: 'This method updates an existing Financial Analysis Version''s Summary.


        Only Financial Analysis Version with draft status can be updated.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: UpdateSummary
      parameters:
      - name: setId
        in: path
        description: Financial Analysis Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: Financial Analysis Version Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Financial Analysis Summary data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SummaryVersionDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummaryVersionDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Financial Analysis Summary with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{setId}/status:
    put:
      tags:
      - FinancialAnalysis
      summary: Update a Financial Analysis Set status
      description: 'This method updates an existing Financial Analysis set status.


        Only Financial Analysis sets with draft status can be updated.


        Only Rejected status will be accepted


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: UpdateFinancialAnalysisStatus
      parameters:
      - name: setId
        in: path
        description: Financial Analysis Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: 'Status body: Rejected, Waived and Draft'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StatusDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Financial Analysis Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{setId}/{id}/status:
    put:
      tags:
      - FinancialAnalysis
      summary: Update a Financial Analysis Version status
      description: 'This endpoint is obsolete and was terminated on 2025-01-01. This endpoint is obsolete, use Update a Financial Analysis Set status endpoint instead.


        This method updates an existing Financial Analysis Version status.


        Only Financial Analysis Version with draft status can be updated.


        Only Financial Analysis Version that satisfied validation rules can be completed.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: putApiFinancialanalysisBySetIdByIdStatus
      parameters:
      - name: setId
        in: path
        description: Financial Analysis Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: Financial Analysis Version Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: 'Status body: Draft, Completed, Rejected, Verified'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StatusDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Financial Analysis Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      deprecated: true
      x-operation-id-source: normalized
      x-operation-id-original: UpdateFinancialAnalysisStatus
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{setId}/version/{id}/reviewstatus:
    put:
      tags:
      - FinancialAnalysis
      summary: Update a Financial Analysis Version External Review Status
      description: 'This method updates an existing Financial Analysis Version External Review Status.


        Only Financial Analysis Version with draft review status can be updated.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: UpdateFinancialAnalysisReviewStatus
      parameters:
      - name: setId
        in: path
        description: Financial Analysis Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: Financial Analysis Version Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: 'Status body: Pending, Approved'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalReviewStatusDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalReviewStatusDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Financial Analysis Set with given ID does not exists
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{journeyId}/{taskId}/complete:
    put:
      tags:
      - FinancialAnalysis
      summary: Complete all financial analysis sets by task id
      description: 'This method will complete all related parties, financial analysis versions and allocation versions for current task.


        All related parties which have open financial versions will be completed.


        Only versions with draft status can be updated.


        Only if all versions satisfy validation rules, they can be completed.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: CompleteAllFinancialAnalysisVersions
      parameters:
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: There are no financial analysis set for current task.
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/{setId}/{id}/schema:
    put:
      tags:
      - FinancialAnalysis
      summary: Update a Financial Analysis Schema
      description: 'This method generates Financial Analysis Schema based on the input and policy configuration.


        It updates or creates Financial Analysis Schema associated to the Set and Version Id in s3.


        Required permissions:

        Following permissions are required: FinancialAnalysisEdit'
      operationId: UpdateSchema
      parameters:
      - name: setId
        in: path
        description: Financial Analysis Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: Financial Analysis Version Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Update Financial Analysis Schema request Fenergo.Nebula.FinancialAnalysis.Command.Application.Dto.RetrieveSchemaDto
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveSchemaDtoServiceRequest'
      responses:
        '202':
          description: Success. Financial Analysis Schema updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisSchemaDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysiscommand
  /api/financialanalysis/set/entity/{entityId}/lite:
    get:
      tags:
      - FinancialAnalysis
      summary: Get all Financial Analysis Sets by Entity Id without Version data
      description: 'This method returns the list of Financial Analysis Set linked to the entity.


        Required permissions:

        Following permissions are required: FinancialAnalysisAccess'
      operationId: GetFinancialAnalysisSetByEntityId
      parameters:
      - name: entityId
        in: path
        description: The id of the entity that linked to the Financial Analysis Sets
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. A list of Financial Analysis Set Lite Dto is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisSetLiteDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. There is no Financial Analysis for specified entity
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysisquery
  /api/financialanalysis/set/entity/{entityId}/journey/{journeyId}/task/{taskId}:
    get:
      tags:
      - FinancialAnalysis
      summary: Get the latest Financial Analysis Version by Entity, Journey, Task Id
      description: 'This method returns the latest Financial Analysis Version linked to the task.


        Required permissions:

        Following permissions are required: FinancialAnalysisAccess'
      operationId: GetFinancialAnalysisSetByEntityJourneyTaskId
      parameters:
      - name: entityId
        in: path
        description: The id of the entity that linked to the Financial Analysis Sets
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. A Financial Analysis Version is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisSetDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Financial Analysis with given ids does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysisquery
  /api/financialanalysis/set/journey/{journeyId}/task/{taskId}:
    get:
      tags:
      - FinancialAnalysis
      summary: Get Financial Analysis Sets by Journey, Task Id
      description: 'This method returns the Active Financial Analysis Sets in the scope of current task


        Required permissions:

        Following permissions are required: FinancialAnalysisAccess'
      operationId: GetFinancialAnalysisSetsByJourneyTaskId
      parameters:
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. Financial Analysis Sets are returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisSetLiteDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Financial Analysis Sets with given ids do not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysisquery
  /api/financialanalysis/set/{setId}:
    get:
      tags:
      - FinancialAnalysis
      summary: Get a Financial Analysis Set of specified Id with all Version data
      description: 'This method returns the Financial Analysis Set of specified Id with all Financial Analysis Versions.


        Required permissions:

        Following permissions are required: FinancialAnalysisAccess'
      operationId: GetFinancialAnalysisSetById
      parameters:
      - name: setId
        in: path
        description: The Id of the Financial Analysis Set
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. A Financial Analysis Set is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisVersionsLiteDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Financial Analysis Set with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysisquery
  /api/financialanalysis/{id}:
    get:
      tags:
      - FinancialAnalysis
      summary: Get a Financial Analysis Version of specified Id
      description: 'This method returns the Financial Analysis Version of specified Id.


        Required permissions:

        Following permissions are required: FinancialAnalysisAccess'
      operationId: GetFinancialAnalysisVersionById
      parameters:
      - name: id
        in: path
        description: The id of the Financial Analysis Version to retrieve
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. A Financial Analysis Version Dto is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisVersionDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Financial Analysis Version with given id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysisquery
  /api/financialanalysis/version/{versionId}/scenario:
    get:
      tags:
      - FinancialAnalysis
      summary: Get a Financial Analysis Scenario By Financial Analysis Version Id
      description: 'This method returns the Scenario of specified Financial Analysis Version Id.


        Required permissions:

        Following permissions are required: FinancialAnalysisAccess'
      operationId: GetScenario
      parameters:
      - name: versionId
        in: path
        description: The id of the Financial Analysis Version
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. A Scenario Version Dto is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioVersionDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Financial Analysis Scenario with the Version Id not found.
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysisquery
  /api/financialanalysis/version/{versionId}/summary:
    get:
      tags:
      - FinancialAnalysis
      summary: Get a Financial Analysis Summary By Financial Analysis Version Id
      description: 'This method returns the Summary of specified Financial Analysis Version Id.


        Required permissions:

        Following permissions are required: FinancialAnalysisAccess'
      operationId: GetSummary
      parameters:
      - name: versionId
        in: path
        description: The id of the Financial Analysis Version
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. A Summary Version Dto is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummaryVersionDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Financial Analysis Summary with the Version Id not found.
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysisquery
  /api/financialanalysis/set/{setId}/version/{versionId}/schema:
    get:
      tags:
      - FinancialAnalysis
      summary: Get a Financial Analysis Schema by Set, Version Id
      description: 'This method returns the Financial Analysis Schema of specified Financial Analysis Set and Version Id.


        Required permissions:

        Following permissions are required: FinancialAnalysisAccess'
      operationId: GetSchema
      parameters:
      - name: setId
        in: path
        description: The Id of the Financial Analysis Set
        required: true
        schema:
          type: string
          format: uuid
      - name: versionId
        in: path
        description: The id of the Financial Analysis Version
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. A Financial Analysis Schema Dto is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialAnalysisSchemaDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Financial Analysis Set or Version with given Id does not exist
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /financialanalysisquery
components:
  schemas:
    ScenarioVersionDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ScenarioVersionDto'
      additionalProperties: false
    SummaryVersionDto:
      type: object
      properties:
        setId:
          type: string
          description: Financial Analysis Set GUiD
          format: uuid
          example: a4309731-77df-4e72-98e7-0d314b7a5151
        id:
          type: string
          description: Financial Analysis Version GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        summaryGroups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryGroupDto'
          description: List of summary groups which belong to the financial analysis version
        summaryCommentaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommentaryGroupDto'
          description: List of commentary groups which contains the commentary fields
      additionalProperties: false
    CollectionMinimumCountRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
          description: Validation rule active flag
          example: true
        staticRule:
          $ref: '#/components/schemas/CollectionMinimumCountRuleDto2'
      additionalProperties: false
      description: Represent the configuration of the validation rule
    DataFieldDto:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Property name
          example: firstName
        propertyType:
          type:
          - string
          - 'null'
          description: Property type
          example: text
        propertyTypeId:
          type:
          - string
          - 'null'
          description: Property type id
          format: uuid
          example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
      additionalProperties: false
      description: Request DTO representing data field metadata
    ScenarioColumnDefinitionDto:
      type: object
      properties:
        id:
          type: string
          description: Id of scenario
          format: uuid
          example: 3cea3da2-c268-466b-b2bd-4a0d8f08576a
        name:
          type:
          - string
          - 'null'
          description: Name of scenario
          example: Scenario 1
        groupId:
          type:
          - string
          - 'null'
          description: Unique Group Id of the column
          example: Scenario 1
        readOnly:
          type: boolean
          description: Read Only Column
          example: false
        order:
          type: integer
          description: Order of the column
          format: int32
          example: 1
        source:
          type:
          - string
          - 'null'
          description: Source of the column
          example: Manual
        providerId:
          type:
          - string
          - 'null'
          description: Financial Import Provider Id if column is imported from provider
          format: uuid
          example: 1cea3d12-c268-466b-b2bd-4a0d8f08576a
      additionalProperties: false
      description: Financial Analysis Period
    FinancialGroupSchema:
      type: object
      properties:
        dataGroupId:
          type:
          - string
          - 'null'
          description: The UiD of the root data group
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        dataGroupVersion:
          type:
          - integer
          - 'null'
          description: Data group version number
          format: int32
          example: 1
        primaryDatakey:
          type:
          - string
          - 'null'
          description: Data group Primary datakey which is used by the dropdown
          example: assetType
        id:
          type:
          - string
          - 'null'
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        name:
          type:
          - string
          - 'null'
          description: Group name
          example: Income
        dataField:
          $ref: '#/components/schemas/DataFieldDto'
        order:
          type:
          - number
          - 'null'
          description: Order
          format: double
          example: 1
        validationRule:
          $ref: '#/components/schemas/ValidationRuleDto'
        validationRulesV2:
          $ref: '#/components/schemas/DataValidationRulesDto'
        periodSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PeriodSchema'
          description: Period schemas that contain periods information
      additionalProperties: false
      description: Model that contains fields related to financial analysis and are mapped from policy requirement dto
    FinancialAnalysisSchemaDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FinancialAnalysisSchemaDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ExternalReviewStatusDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExternalReviewStatusDto'
      additionalProperties: false
    EmptyRuleDtoConditionalValidationRuleDto:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
          description: Validation rule active flag
          example: true
        staticRule:
          $ref: '#/components/schemas/EmptyRuleDto'
      additionalProperties: false
      description: Represent the configuration of the validation rule
    FinancialAnalysisVersionDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FinancialAnalysisVersionDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ScenarioValueDto:
      type: object
      properties:
        id:
          type: string
          description: Id of Column
          format: uuid
          example: 3cea3da2-c268-466b-b2bd-4a0d8f08576a
        value:
          type:
          - string
          - 'null'
          description: Value
          example: Earthquake
      additionalProperties: false
      description: Value of a scenario item for a specific column
    CollectionMaximumCountRuleDtoValidationRuleDto:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
          description: Validation rule active flag
          example: true
        staticRule:
          $ref: '#/components/schemas/CollectionMaximumCountRuleDto2'
      additionalProperties: false
      description: Represent the configuration of the validation rule
    PropertyDto:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/PropertyType'
        discriminator:
          $ref: '#/components/schemas/PropertyType'
        isValid:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    FinancialAnalysisVersionDto:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis Version GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        setId:
          type: string
          description: Financial Analysis Set GUiD
          format: uuid
          example: a4309731-77df-4e72-98e7-0d314b7a5151
        description:
          type:
          - string
          - 'null'
          description: Financial Analysis description
          example: Home loan application
        status:
          type:
          - string
          - 'null'
          description: Financial Analysis Status
          example: Draft
        financialGroups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialGroupDto'
          description: List of financial groups which defines the financial analysis
        financialCommentaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommentaryGroupDto'
          description: List of commentary groups which contains the commentary fields
        lastUpdatedDateTime:
          type: string
          description: Last time it was updated (Read-only)
          format: date-time
          example: '2022-12-12T15:55:00.000Z'
        createdDateTime:
          type: string
          description: Date time it was created (Read-only)
          format: date-time
          example: '2020-12-12T15:55:00.000Z'
        externalReviewStatus:
          type:
          - string
          - 'null'
          description: External Review Status for this Version
          example: Pending
      additionalProperties: false
      description: Financial Analysis Version representation
    SinglePropertyDto:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/PropertyType'
        discriminator:
          $ref: '#/components/schemas/PropertyType'
        isValid:
          type:
          - boolean
          - 'null'
        value:
          type:
          - string
          - 'null'
        valueId:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationDataDto:
      type: object
      properties:
        isMandatory:
          $ref: '#/components/schemas/BasicRuleDto'
        collectionMinimumCount:
          $ref: '#/components/schemas/CollectionMinimumCountRuleDto'
        collectionMaximumCount:
          $ref: '#/components/schemas/CollectionMaximumCountRuleDto'
      additionalProperties: false
      description: Request DTO representing validation data metadata
    SummaryGroupDto:
      type: object
      properties:
        id:
          type: string
          description: Summary Group Id
          format: uuid
          example: a01beaaa-a9fc-4d25-971b-b4add3c6050c
        actualGroupId:
          type:
          - string
          - 'null'
          description: Actual Group Id
          example: ''
        scenarioGroupId:
          type:
          - string
          - 'null'
          description: Scenario Group Id
          example: ''
        name:
          type:
          - string
          - 'null'
          description: Summary Group Name
          example: FA Income
        type:
          type:
          - string
          - 'null'
          description: Summary Group Type
          example: Income
        summaryItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryItemDto'
          description: List of Summary Items
        calculationSummaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ColumnSummaryDto'
          description: List of calculation of summary periods value
        summaryColumnDefinitions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryColumnDefinitionDto'
          description: List of periods captured in this Summary Group
      additionalProperties: false
    ScenarioSchema:
      type: object
      properties:
        scenarioGroupSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioGroupSchema'
          description: Scenario schemas that contain scenario's data groups information
        scenarioCommentarySchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioGroupSchema'
          description: Schemas that contain scenario's commentary information
        scenarioLookupSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LookupSchema'
          description: Lookup schemas that contain data groups and associated lookups information
      additionalProperties: false
    JointFinancialAnalysisInitializeResponseDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JointFinancialAnalysisInitializeResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StatusDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/StatusDto'
      additionalProperties: false
    FinancialAnalysisVersionDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FinancialAnalysisVersionDto'
      additionalProperties: false
    FinancialAnalysisSetDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FinancialAnalysisSetDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    FinancialGroupDto:
      type: object
      properties:
        id:
          type: string
          description: Financial Group Id
          format: uuid
          example: 51209731-77df-4e72-98e7-0d314b7a5151
        name:
          type:
          - string
          - 'null'
          description: Financial Group Name
          example: Personal Income
        type:
          type:
          - string
          - 'null'
          description: Financial Group Type
          example: Income
        financialItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialItemDto'
          description: List of Financial Items
        calculationSummaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CalculationSummaryDto'
          description: List of calculation of summary periods value
        periods:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PeriodDto'
          description: List of periods captured in this Financial Group
      additionalProperties: false
      description: Financial Group
    CollectionMaximumCountRuleDto2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
          description: Validation rule error message
          example: Validation error occurred
        requiredTypesMaxCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
          description: Dictionary of required Primary Data Group Field values with maximum count
          example:
            Registered: 1
        overallMaximumCount:
          type:
          - integer
          - 'null'
          description: Overall maximum count
          format: int32
          example: 1
      additionalProperties: false
      description: Request DTO representing collection maximum count validation rule metadata
    RetrieveSchemaDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/RetrieveSchemaDto'
      additionalProperties: false
    JointFinancialAnalysisSetDto:
      type: object
      properties:
        id:
          type: string
          description: Joint Financial Analysis Set GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        entitiesList:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JointEntityDto'
          description: Entities which joint financial analysis set belongs
        entityType:
          type:
          - string
          - 'null'
          description: Joint Financial Analysis Entity Type
          example: Company
        journeyId:
          type: string
          description: Journey Id which joint financial analysis belongs
          format: uuid
          example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4
        taskId:
          type: string
          description: Task Id which joint financial analysis belongs
          format: uuid
          example: 2c3c8433-efc3-493b-9b14-70b7681c7342
        status:
          type:
          - string
          - 'null'
          description: Joint Financial Analysis Set Status
          example: Draft
      additionalProperties: false
      description: Joint Financial Analysis Set representation
    ScenarioVersionDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ScenarioVersionDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    SummaryColumnDefinitionDto:
      type: object
      properties:
        id:
          type: string
          description: Summary Column Identifier GUiD
          format: uuid
          example: 3cea3da2-c268-466b-b2bd-4a0d8f08576a
        name:
          type:
          - string
          - 'null'
          description: Unique Summary column name
          example: FY2022
        type:
          type:
          - string
          - 'null'
          description: Column Type Actual, Scenario or Summary
          example: Summary
        originColumnId:
          type:
          - string
          - 'null'
          description: Origin Column Identifier from Actual or Scenario
          example: ''
      additionalProperties: false
    FinancialAnalysisSetDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/FinancialAnalysisSetDto'
      additionalProperties: false
    CalculationSummaryDto:
      type: object
      properties:
        periodName:
          type:
          - string
          - 'null'
          description: Calculated period id
        value:
          type:
          - string
          - 'null'
          description: Calculated value
      additionalProperties: false
      description: Summary of a financial group by period
    PeriodReferenceDto:
      type: object
      properties:
        periodName:
          type:
          - string
          - 'null'
          description: Period unique name
          example: FY2022
        value:
          type:
          - string
          - 'null'
          description: Financial Item Value
          example: '15500'
      additionalProperties: false
      description: Value of a financial item for a specific period
    CollectionMaximumCountRuleDto:
      type: object
      properties:
        active:
          type: boolean
          description: Validation rule active flag
          example: true
        message:
          type:
          - string
          - 'null'
          description: Validation rule error message
          example: Validation error occurred
        requiredTypesMaxCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
          description: Dictionary of required Primary Data Group Field values with maximum count
          example:
            Registered: 1
        overallMaximumCount:
          type:
          - integer
          - 'null'
          description: Overall maximum count
          format: int32
          example: 1
      additionalProperties: false
      description: Request DTO representing collection maximum count validation rule metadata
    JointFinancialAnalysisInitializeRequestDto:
      type: object
      properties:
        journeyId:
          type: string
          description: Journey Id which joint financial analysis belongs
          format: uuid
          example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4
        taskId:
          type: string
          description: Task Id which joint financial analysis belongs
          format: uuid
          example: 2c3c8433-efc3-493b-9b14-70b7681c7342
        entitiesList:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JointEntityDto'
          description: List of entities that joint financial analysis set belongs to
        retrieveSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RetrieveSchemaDto'
          description: List of requests for retrieving FA schemas
        isExternalReviewRequired:
          type: boolean
          description: Is External Review Required
      additionalProperties: false
      description: Request for initializing joint Financial Analysis representation
    ScenarioVersionDto:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis Version GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        setId:
          type: string
          description: Financial Analysis Set GUiD
          format: uuid
          example: a4309731-77df-4e72-98e7-0d314b7a5151
        scenarioGroups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioGroupDto'
          description: List of scenario groups which belong to the financial analysis version
        scenarioCommentaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommentaryGroupDto'
          description: List of commentary groups which contains the commentary fields
      additionalProperties: false
      description: Financial Analysis Scenario representation
    PeriodDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Unique name of a period
          example: FY2022
        startDate:
          type: string
          description: Period Starting Date Time
          format: date-time
          example: '2020-01-01T00:00:00'
        endDate:
          type: string
          description: Period End Date Time
          format: date-time
          example: '2021-12-31T23:59:59'
      additionalProperties: false
      description: Financial Analysis Period
    ScenarioGroupSchema:
      type: object
      properties:
        dataGroupId:
          type:
          - string
          - 'null'
          description: The UiD of the root data group
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        dataGroupVersion:
          type:
          - integer
          - 'null'
          description: Data group version number
          format: int32
          example: 1
        primaryDatakey:
          type:
          - string
          - 'null'
          description: Data group Primary datakey which is used by the dropdown
          example: assetType
        id:
          type:
          - string
          - 'null'
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        name:
          type:
          - string
          - 'null'
          description: Group name
          example: Income
        dataField:
          $ref: '#/components/schemas/DataFieldDto'
        order:
          type:
          - number
          - 'null'
          description: Order
          format: double
          example: 1
        validationRule:
          $ref: '#/components/schemas/ValidationRuleDto'
        validationRulesV2:
          $ref: '#/components/schemas/DataValidationRulesDto'
        financialAnalysisConfiguration:
          $ref: '#/components/schemas/FinancialAnalysisConfiguration'
      additionalProperties: false
      description: Model that contains fields related to financial analysis scenario schema
    BasicRuleDto:
      type: object
      properties:
        active:
          type: boolean
          description: Validation rule active flag
          example: true
        message:
          type:
          - string
          - 'null'
          description: Validation rule error message
          example: Validation error occurred
      additionalProperties: false
      description: Request DTO representing basic validation rule metadata
    StatusDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/StatusDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    BasicRuleDtoConditionalValidationRuleDto:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
          description: Validation rule active flag
          example: true
        staticRule:
          $ref: '#/components/schemas/BasicRuleDto2'
      additionalProperties: false
      description: Represent the configuration of the validation rule
    ScenarioItemDto:
      type: object
      properties:
        id:
          type: string
          description: Scenario Item GUiD
          format: uuid
          example: 88009731-77df-4e72-98e7-0d314b7a5151
        foreignId:
          type:
          - string
          - 'null'
          description: Scenario Item Foreign Id if it is cloned from other item
          example: ''
        dataKey:
          type:
          - string
          - 'null'
          description: Scenario Item DataKey
          example: disasterType
        value:
          type:
          - string
          - 'null'
          description: Scenario Item Value
          example: Disaster Type
        source:
          type:
          - string
          - 'null'
          description: Source of the model
          example: Manual
        providerId:
          type:
          - string
          - 'null'
          description: Financial Import Provider Id
          format: uuid
          example: ''
        providerItemId:
          type:
          - string
          - 'null'
          description: Import Item Id from the provider
          example: ''
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto'
          description: Properties of a Scenario Item
        scenarioValues:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioValueDto'
          description: Value of the Scenario Item per scenario
      additionalProperties: false
      description: Scenario Item
    FinancialItemDto:
      type: object
      properties:
        id:
          type: string
          description: Financial Item GUiD
          format: uuid
          example: 88009731-77df-4e72-98e7-0d314b7a5151
        dataKey:
          type:
          - string
          - 'null'
          description: Financial Item DataKey
          example: IncomeType
        value:
          type:
          - string
          - 'null'
          description: Financial Item Value
          example: Salary
        providerId:
          type:
          - string
          - 'null'
          description: Guid of import provider
          format: uuid
          example: 88009731-77df-4e72-98e7-0d314b7a5151
        source:
          type:
          - string
          - 'null'
          description: Source of the model
          example: Manual
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto'
          description: Properties of a Financial Item
        periodReferences:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PeriodReferenceDto'
          description: Value of the Financial Item per period
      additionalProperties: false
      description: Financial Item
    ExternalReviewStatusDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ExternalReviewStatusDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    BasicRuleDto2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
          description: Validation rule error message
          example: Validation error occurred
      additionalProperties: false
      description: Request DTO representing basic validation rule metadata
    DataValidationRulesDto:
      type: object
      properties:
        mandatory:
          $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto'
        collectionMinimumCount:
          $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto'
        collectionMaximumCount:
          $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto'
        readOnly:
          $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto'
      additionalProperties: false
      description: Request DTO representing validation rule metadata
    JointFinancialAnalysisInitializeRequestDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JointFinancialAnalysisInitializeRequestDto'
      additionalProperties: false
    RetrieveSchemaDto:
      type: object
      properties:
        entityType:
          type:
          - string
          - 'null'
          description: Type of entity
          example: Individual
        targetEntity:
          type:
          - string
          - 'null'
          description: Target entity
          example: Client
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto'
          description: Jurisdictions of the requirement in specific version. Null versionId will get the latest.
        categories:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of requirement for actual category e.g. ["Basic Details", "Enrich Details"]
        scenarioCategories:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of requirement for scenario category e.g. ["Scenario"]
        summaryCategories:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of requirement for summary category e.g. ["Summary"]
        entityDataProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Entity data properties used for condition evaluation
        dealProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Deal properties used for condition evaluation
        requirementSetId:
          type:
          - string
          - 'null'
          description: Deal Requirement Set
        requirementVersion:
          type: integer
          description: Deal Requirement version number
          format: int32
        isCurrentEntityPartOfJoint:
          type: boolean
          description: Is Current Entity Part Of Joint
      additionalProperties: false
    ExternalReviewStatusDto:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          description: Financial Analysis Version External Review Status
          example: Pending, Approved
      additionalProperties: false
    EmptyRuleDto:
      type: object
      additionalProperties: false
    FinancialAnalysisConfiguration:
      type: object
      properties:
        minimumColumns:
          type:
          - integer
          - 'null'
          description: Minimum number of period columns, used for group validation
          format: int32
        maximumColumns:
          type:
          - integer
          - 'null'
          description: Maximum number of period columns, used for group validation
          format: int32
      additionalProperties: false
      description: Model that contains information from Financial Analysis Configuration for the schema to use, mainly for validation
    SummaryGroupSchema:
      type: object
      properties:
        dataGroupId:
          type:
          - string
          - 'null'
          description: The UiD of the root data group
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        dataGroupVersion:
          type:
          - integer
          - 'null'
          description: Data group version number
          format: int32
          example: 1
        primaryDatakey:
          type:
          - string
          - 'null'
          description: Data group Primary datakey which is used by the dropdown
          example: assetType
        id:
          type:
          - string
          - 'null'
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        name:
          type:
          - string
          - 'null'
          description: Group name
          example: Income
        dataField:
          $ref: '#/components/schemas/DataFieldDto'
        order:
          type:
          - number
          - 'null'
          description: Order
          format: double
          example: 1
        validationRule:
          $ref: '#/components/schemas/ValidationRuleDto'
        validationRulesV2:
          $ref: '#/components/schemas/DataValidationRulesDto'
      additionalProperties: false
      description: Model that contains fields related to financial analysis summary schema
    VersionedJurisdictionDto:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 254428e9-d232-4738-81c9-151409b296a3
      additionalProperties: false
      description: Defines the jurisdiction requirement for the financial analysis
    CollectionMinimumCountRuleDto:
      type: object
      properties:
        active:
          type: boolean
          description: Validation rule active flag
          example: true
        message:
          type:
          - string
          - 'null'
          description: Validation rule error message
          example: Validation error occurred
        requiredTypesMinCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
          description: Dictionary of required Primary Data Group Field values with minimum count
          example:
            Registered: 1
        overallMinimumCount:
          type:
          - integer
          - 'null'
          description: Overall minimum count
          format: int32
          example: 1
      additionalProperties: false
      description: Request DTO representing collection minumim count validation rule metadata
    FinancialAnalysisSchemaDto:
      type: object
      properties:
        financialGroupSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialGroupSchema'
          description: Financial group schemas that contain data groups information
        financialCommentarySchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialGroupSchema'
          description: Schemas that contain commentary information
        lookupSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LookupSchema'
          description: Lookup schemas that contain data groups and associated lookups information
        scenarioSchema:
          $ref: '#/components/schemas/ScenarioSchema'
        summarySchema:
          $ref: '#/components/schemas/SummarySchema'
      additionalProperties: false
      description: Model that contains information to build financial analysis schema
    SummaryVersionDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SummaryVersionDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    SummaryVersionDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SummaryVersionDto'
      additionalProperties: false
    ValidationRuleDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The UiD of the validation rule
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        setId:
          type:
          - string
          - 'null'
          description: The UiD of the requirement set/data group
          format: uuid
          example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3
        propertyId:
          type:
          - string
          - 'null'
          description: The UiD of the requirement/data group field
          format: uuid
          example: 450df9bf-b2d3-48cf-ab8d-481c69b74373
        propertyName:
          type:
          - string
          - 'null'
          description: Requirement/data group field property name
          example: firstName
        friendlyName:
          type:
          - string
          - 'null'
          description: Requirement/data group field friendly Name
          example: First Name
        validationType:
          type:
          - string
          - 'null'
          description: Validation type
          example: text
        validationData:
          $ref: '#/components/schemas/ValidationDataDto'
      additionalProperties: false
      description: Request DTO representing validation rule metadata
    CommentaryGroupDto:
      type: object
      properties:
        id:
          type: string
          description: Commentary Group Id
          format: uuid
          example: c031699e-f5a2-4382-a4f6-9f2b3cd3ed4d
        name:
          type:
          - string
          - 'null'
          description: Commentary Group Name
          example: Commentary
        type:
          type:
          - string
          - 'null'
          description: Commentary Group Type
          example: commentary
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto'
          description: Commentary Fields
      additionalProperties: false
    SummarySchema:
      type: object
      properties:
        summaryGroupSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryGroupSchema'
          description: Summary schemas that contain summary's data groups information
        summaryCommentarySchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryGroupSchema'
          description: Schemas that contain summary's commentary information
        summaryLookupSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LookupSchema'
          description: Lookup schemas that contain data groups and associated lookups information
      additionalProperties: false
    PeriodSchema:
      type: object
      properties:
        configurationId:
          type:
          - string
          - 'null'
          description: Financial period configuration Id
          example: 30475116-518b-4c8d-b7ae-e5453104682a
        configurationVersion:
          type:
          - integer
          - 'null'
          description: Financial period configuration version number
          format: int32
        orderFromCurrentPeriod:
          type: integer
          description: Year difference from current period, 0 represents current period
          format: int32
          example: 1
        name:
          type:
          - string
          - 'null'
          description: Name of the period
          example: FY2022
        startDate:
          type: string
          description: Start time of the period
          format: date-time
        endDate:
          type: string
          description: End time of the period
          format: date-time
        readOnly:
          type: boolean
          description: Indicates whether the period column is read-only or not
      additionalProperties: false
      description: Model that contains information to build period schema
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    LookupSchema:
      type: object
      properties:
        lookupId:
          type: string
          description: Lookup id of the Primary DataKey
          format: uuid
          example: 30475116-518b-4c8d-b7ae-e5453104682a
        lookupVersion:
          type:
          - integer
          - 'null'
          description: Lookup version number
          format: int32
        linkLookupId:
          type:
          - string
          - 'null'
          description: Link lookup id of the Primary DataKey
          format: uuid
          example: 30475116-518b-4c8d-b7ae-e5453104682a
        linkLookupVersion:
          type:
          - integer
          - 'null'
          description: Link lookup version number
          format: int32
        validationDataGroupId:
          type:
          - string
          - 'null'
          description: Validations Data group id
        validationDataGroupVersion:
          type:
          - integer
          - 'null'
          description: Validations Data group version number
          format: int32
        dataGroupDataKey:
          type:
          - string
          - 'null'
          description: Data key of the data group
          example: asset
        primaryDatakey:
          type:
          - string
          - 'null'
          description: Primary field data key of the data group
          example: country
      additionalProperties: false
      description: Model that contains information to build lookup schema
    PropertyType:
      enum:
      - Single
      - Custom
      - Collection
      type: string
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    CollectionMinimumCountRuleDto2:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
          description: Validation rule error message
          example: Validation error occurred
        requiredTypesMinCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
          description: Dictionary of required Primary Data Group Field values with minimum count
          example:
            Registered: 1
        overallMinimumCount:
          type:
          - integer
          - 'null'
          description: Overall minimum count
          format: int32
          example: 1
      additionalProperties: false
      description: Request DTO representing collection minimum count validation rule metadata
    JointEntityDto:
      type: object
      properties:
        entityId:
          type: string
          description: Entity Id which financial analysis Set belongs
          format: uuid
          example: 54953531-77df-4e72-98e7-0d314b7a5151
        entityType:
          type:
          - string
          - 'null'
          description: Entity Type
          example: Company
      additionalProperties: false
      description: Entity of Financial Analysis
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    FinancialAnalysisSetDto:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis Set GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        entityId:
          type: string
          description: Entity Id which financial analysis Set belongs
          format: uuid
          example: 54953531-77df-4e72-98e7-0d314b7a5151
        entityType:
          type:
          - string
          - 'null'
          description: Financial Analysis Entity Type
          example: Company
        journeyId:
          type: string
          description: Journey Id which financial analysis belongs
          format: uuid
          example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4
        taskId:
          type: string
          description: Task Id which financial analysis belongs
          format: uuid
          example: 2c3c8433-efc3-493b-9b14-70b7681c7342
        status:
          type:
          - string
          - 'null'
          description: Financial Analysis Set Status
          example: Draft
        isExternalReviewRequired:
          type: boolean
          description: Is External Review Required for Financial Analysis Set
          example: false
      additionalProperties: false
      description: Financial Analysis Set representation
    ColumnSummaryDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Id of the column
        value:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Summary of a financial group by column
    JointFinancialAnalysisInitializeResponseDto:
      type: object
      properties:
        financialAnalysisSet:
          $ref: '#/components/schemas/JointFinancialAnalysisSetDto'
        financialAnalysisVersion:
          $ref: '#/components/schemas/FinancialAnalysisVersionDto'
        financialAnalysisSchema:
          $ref: '#/components/schemas/FinancialAnalysisSchemaDto'
      additionalProperties: false
      description: Response for initializing joint Financial Analysis representation
    SummaryItemDto:
      type: object
      properties:
        id:
          type: string
          description: Summary Item GUiD
          format: uuid
          example: 9cc44cb8-d783-4823-beca-da236e0c10b4
        actualItemId:
          type:
          - string
          - 'null'
          description: Referenced Actual Item Id
          example: ''
        scenarioItemId:
          type:
          - string
          - 'null'
          description: Referenced Scenario Item Id
          example: ''
        dataKey:
          type:
          - string
          - 'null'
          description: Summary Item DataKey
          example: incomeType
        value:
          type:
          - string
          - 'null'
          description: Summary Item Value
          example: Bonus
        source:
          type:
          - string
          - 'null'
          description: Source of the summary Item
          example: Manual
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto'
          description: Properties of a Summary Item
        summaryValues:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryValueDto'
          description: Value of the Summary Item per period
      additionalProperties: false
    ScenarioGroupDto:
      type: object
      properties:
        id:
          type: string
          description: Scenario Group Id
          format: uuid
          example: 51209731-77df-4e72-98e7-0d314b7a5151
        name:
          type:
          - string
          - 'null'
          description: Scenario Group Name
          example: Natural Disaster
        type:
          type:
          - string
          - 'null'
          description: Scenario Group Type
          example: Manual
        scenarioItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioItemDto'
          description: List of Scenario Items
        scenarioColumnDefinitions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioColumnDefinitionDto'
          description: List of scenarios  captured in this Scenario Group
        calculationSummaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CalculationSummaryDto'
          description: List of calculation of summary per column
      additionalProperties: false
    StatusDto:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          description: Status of Financial Analysis Version
          example: Draft
      additionalProperties: false
    SummaryValueDto:
      type: object
      properties:
        id:
          type: string
          description: Id of Summary Column
          format: uuid
          example: 3cea3da2-c268-466b-b2bd-4a0d8f08576a
        value:
          type:
          - string
          - 'null'
          description: Value
          example: '2000'
      additionalProperties: false
    SummaryVersionDto_2:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis Version GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        summaryGroups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryGroupDto_2'
          description: List of summary groups which belong to the financial analysis version
        summaryCommentaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommentaryGroupDto'
          description: List of commentary groups which contains the commentary fields
      additionalProperties: false
    CollectionMinimumCountRuleDtoValidationRuleDto_2:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
          description: Validation rule active flag
          example: true
        staticRule:
          allOf:
          - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2'
          description: Static validation rule always applied when active
      additionalProperties: false
      description: Represent the configuration of the validation rule
    ScenarioColumnDefinitionDto_2:
      type: object
      properties:
        id:
          type: string
          description: Scenario Definition Id
          format: uuid
          example: e9ed602b-e38f-4b20-8ef4-9dcce57058ec
        name:
          type:
          - string
          - 'null'
          description: Scenario Definition Name
          example: Scenario 1
        groupId:
          type:
          - string
          - 'null'
          description: Unique Group Id of the column
          example: Scenario 1
        readOnly:
          type: boolean
          description: Read Only Column
          example: 2020
        order:
          type: integer
          description: Order of the column
          format: int32
          example: 1
        source:
          type:
          - string
          - 'null'
          description: Source of the column
          example: Manual
        providerId:
          type:
          - string
          - 'null'
          description: Financial Import Provider Id if column is imported from provider
          format: uuid
          example: ''
      additionalProperties: false
    FinancialAnalysisSchemaDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FinancialAnalysisSchemaDto_2'
          description: Model that contains information to build financial analysis schema
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    FinancialGroupSchema_2:
      type: object
      properties:
        dataGroupId:
          type:
          - string
          - 'null'
          description: The UiD of the root data group
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        dataGroupVersion:
          type:
          - integer
          - 'null'
          description: Data group version number
          format: int32
          example: 1
        primaryDatakey:
          type:
          - string
          - 'null'
          description: Data group Primary datakey which is used by the dropdown
          example: assetType
        id:
          type:
          - string
          - 'null'
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        name:
          type:
          - string
          - 'null'
          description: Group name
          example: Income
        dataField:
          allOf:
          - $ref: '#/components/schemas/DataFieldDto'
          description: Data Field
        order:
          type:
          - number
          - 'null'
          description: Order
          format: double
          example: 1
        validationRule:
          allOf:
          - $ref: '#/components/schemas/ValidationRuleDto_2'
          description: Validation Rule
        validationRulesV2:
          allOf:
          - $ref: '#/components/schemas/DataValidationRulesDto_2'
          description: Validation Rules V2
        periodSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PeriodSchema'
          description: Period schemas that contain periods information
      additionalProperties: false
      description: Model that contains fields related to financial analysis and are mapped from policy requirement dto
    VersionLiteDto:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis GUiD
          format: uuid
          example: 55509731-77df-4e72-98e7-0d314b7a5151
        financialAnalysisSetId:
          type: string
          description: Financial Analysis GUiD
          format: uuid
          example: 1239731-77df-4e72-98e7-0d314b7a5151
        description:
          type:
          - string
          - 'null'
          description: Financial Analysis description
          example: Home loan application
        status:
          type:
          - string
          - 'null'
          description: Financial Analysis Status
          example: Draft
        externalReviewStatus:
          type:
          - string
          - 'null'
          description: External Review Status for this Version
          example: Pending
        createdDateTime:
          type: string
          description: Date time it was created (Read-only)
          format: date-time
          example: '2020-12-12T15:55:00.000Z'
        lastUpdatedTime:
          type: string
          description: Last time it was updated (Read-only)
          format: date-time
          example: '2022-12-12T15:55:00.000Z'
        versionNumber:
          type: integer
          description: Financial Analysis Version
          format: int32
          example: 1
      additionalProperties: false
      description: FinancialAnalysisVersions representation
    EmptyRuleDtoConditionalValidationRuleDto_2:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
          description: Validation rule active flag
          example: true
        staticRule:
          allOf:
          - $ref: '#/components/schemas/EmptyRuleDto'
          description: Static validation rule always applied when active
      additionalProperties: false
      description: Represent the configuration of the validation rule
    FinancialAnalysisVersionDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FinancialAnalysisVersionDto_2'
          description: Financial Analysis Version representation
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ScenarioValueDto_2:
      type: object
      properties:
        id:
          type: string
          description: "    Scenario Definition Id    \n///"
          format: uuid
          example: e9ed602b-e38f-4b20-8ef4-9dcce57058ec
        value:
          type:
          - string
          - 'null'
          description: Scenario Value
          example: Earthquake
      additionalProperties: false
      description: Value of a scenario item for a specific scenario
    ImportRecordDto:
      type: object
      properties:
        providerId:
          type: string
          description: Import Provider Id
          format: uuid
        importId:
          type: string
          description: Financial Import Id
          format: uuid
        importUpdatedOn:
          type:
          - string
          - 'null'
          description: Updated time or the import
          format: date-time
      additionalProperties: false
    CollectionMaximumCountRuleDtoValidationRuleDto_2:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
          description: Validation rule active flag
          example: true
        staticRule:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2'
          description: Static validation rule always applied when active
      additionalProperties: false
      description: Represent the configuration of the validation rule
    FinancialAnalysisSetLiteDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialAnalysisSetLiteDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    FinancialAnalysisVersionDto_2:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis Version GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        setId:
          type: string
          description: Financial Analysis Set GUiD
          format: uuid
          example: a4309731-77df-4e72-98e7-0d314b7a5151
        description:
          type:
          - string
          - 'null'
          description: Financial Analysis description
          example: Home loan application
        status:
          type:
          - string
          - 'null'
          description: Financial Analysis Status
          example: Draft
        externalReviewStatus:
          type:
          - string
          - 'null'
          description: External Review Status for this Version
          example: Pending
        financialGroups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialGroupDto_2'
          description: List of financial groups which defines the financial analysis
        financialCommentaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommentaryGroupDto'
          description: List of Commentary Groups that capture the commentary for the financial analysis
        createdDateTime:
          type: string
          description: Date time it was created (Read-only)
          format: date-time
          example: '2020-12-12T15:55:00.000Z'
        lastUpdatedDateTime:
          type: string
          description: Last time it was updated (Read-only)
          format: date-time
          example: '2022-12-12T15:55:00.000Z'
        versionNumber:
          type: integer
          description: Financial Analysis Version
          format: int32
          example: 1
        importRecords:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImportRecordDto'
          description: Import applied to financial analysis version logs
      additionalProperties: false
      description: Financial Analysis Version representation
    SinglePropertyDto_2:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        discriminator:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        isValid:
          type:
          - boolean
          - 'null'
        value:
          type:
          - string
          - 'null'
        valueId:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationDataDto_2:
      type: object
      properties:
        isMandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
          description: Mandatory Rule - does not allow empty value
        collectionMinimumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMinimumCountRuleDto'
          description: Validation rule that allows to set minimum count requirements for collection
        collectionMaximumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRuleDto'
          description: Validation rule that allows to set maximum count requirements for collection
      additionalProperties: false
      description: Request DTO representing validation data metadata
    SummaryGroupDto_2:
      type: object
      properties:
        id:
          type: string
          description: Summary Group Id
          format: uuid
          example: c59e9893-1741-4dd8-bb99-3975c7f30c7d
        actualGroupId:
          type:
          - string
          - 'null'
          description: Actual Group Id
          example: 89c524db-1bac-4432-b8d5-f6704e16fa6a
        scenarioGroupId:
          type:
          - string
          - 'null'
          description: Scenario Group Id
          example: c3d79d3e-8d4f-42b9-8fac-09d2243d605c
        name:
          type:
          - string
          - 'null'
          description: Summary Group Name
          example: Natural Disaster
        type:
          type:
          - string
          - 'null'
          description: Summary Group Type
          example: Manual
        summaryItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryItemDto_2'
          description: List of Summary Items
        calculationSummaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ColumnSummaryDto_2'
          description: List of calculation of summary periods value
        summaryColumnDefinitions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryColumnDefinitionDto_2'
          description: List of periods captured in this Summary
      additionalProperties: false
    FinancialGroupDto_2:
      type: object
      properties:
        id:
          type: string
          description: Financial Group Id
          format: uuid
          example: 51209731-77df-4e72-98e7-0d314b7a5151
        name:
          type:
          - string
          - 'null'
          description: Financial Group Name
          example: Personal Income
        type:
          type:
          - string
          - 'null'
          description: Financial Group Type
          example: Income
        financialItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialItemDto_2'
          description: List of Financial Items
        calculationSummaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CalculationSummaryDto'
          description: List of calculation of summary periods value
        periods:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PeriodDto'
          description: List of periods captured in this Financial Analysis
      additionalProperties: false
      description: Financial Group
    FinancialAnalysisSetDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FinancialAnalysisSetDto_2'
          description: Financial Analysis Set representation
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ScenarioVersionDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ScenarioVersionDto_2'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    SummaryColumnDefinitionDto_2:
      type: object
      properties:
        id:
          type: string
          description: Summary Column Id
          format: uuid
          example: e9ed602b-e38f-4b20-8ef4-9dcce57058ec
        name:
          type:
          - string
          - 'null'
          description: Unique Summary Column name
          example: FY2022
        type:
          type:
          - string
          - 'null'
          description: 'Column Type: Actual, Scenario or Summary'
          example: Summary
        originColumnId:
          type:
          - string
          - 'null'
          description: Origin Column Id from Actual or Scenario
          example: ''
      additionalProperties: false
    ScenarioVersionDto_2:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis Version GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        scenarioGroups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioGroupDto_2'
          description: List of scenario groups which belong to the financial analysis version
        scenarioCommentaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommentaryGroupDto'
          description: List of Commentary Groups that capture the commentary for the financial analysis scenario
      additionalProperties: false
    ScenarioGroupSchema_2:
      type: object
      properties:
        dataGroupId:
          type:
          - string
          - 'null'
          description: The UiD of the root data group
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        dataGroupVersion:
          type:
          - integer
          - 'null'
          description: Data group version number
          format: int32
          example: 1
        primaryDatakey:
          type:
          - string
          - 'null'
          description: Data group Primary datakey which is used by the dropdown
          example: assetType
        id:
          type:
          - string
          - 'null'
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        name:
          type:
          - string
          - 'null'
          description: Group name
          example: Income
        dataField:
          allOf:
          - $ref: '#/components/schemas/DataFieldDto'
          description: Data Field
        order:
          type:
          - number
          - 'null'
          description: Order
          format: double
          example: 1
        validationRule:
          allOf:
          - $ref: '#/components/schemas/ValidationRuleDto_2'
          description: Validation Rule
        validationRulesV2:
          allOf:
          - $ref: '#/components/schemas/DataValidationRulesDto_2'
          description: Validation Rules V2
        financialAnalysisConfiguration:
          allOf:
          - $ref: '#/components/schemas/FinancialAnalysisConfiguration'
          description: Contains information from Financial Analysis Configuration for the schema to use, mainly for validation
      additionalProperties: false
      description: Model that contains fields related to financial analysis scenario schema
    ScenarioItemDto_2:
      type: object
      properties:
        id:
          type: string
          description: Scenario Item GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        foreignId:
          type:
          - string
          - 'null'
          description: Scenario Item Foreign Id if it is cloned from other item
          example: 8def808a-f6f3-44e7-b466-1f033de656b3
        dataKey:
          type:
          - string
          - 'null'
          description: Scenario Item DataKey
          example: disasterType
        value:
          type:
          - string
          - 'null'
          description: Scenario Item Value
          example: Disaster Type
        source:
          type:
          - string
          - 'null'
          description: Source of the model
          example: Manual
        providerId:
          type:
          - string
          - 'null'
          description: Financial Import Provider Id
          format: uuid
          example: Manual
        providerItemId:
          type:
          - string
          - 'null'
          description: Import Item Id from the provider
          example: ''
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto_2'
          description: Properties of a Scenario Item
        scenarioValues:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioValueDto_2'
          description: Value of the Scenario Item per Scenario
      additionalProperties: false
      description: Scenario Item
    FinancialAnalysisVersionsLiteDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/FinancialAnalysisVersionsLiteDto'
          description: Financial Analysis Set representation with Lite Financial Analysis Versions
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    FinancialItemDto_2:
      type: object
      properties:
        id:
          type: string
          description: Financial Item GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        dataKey:
          type:
          - string
          - 'null'
          description: Financial Item DataKey
          example: IncomeType
        value:
          type:
          - string
          - 'null'
          description: Financial Item Value
          example: Salary
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto_2'
          description: Properties of a Financial Item
        periodReferences:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PeriodReferenceDto'
          description: Value of the Financial Item per period
        providerId:
          type:
          - string
          - 'null'
          description: Guid of import provider
          format: uuid
          example: 88009731-77df-4e72-98e7-0d314b7a5151
        source:
          type:
          - string
          - 'null'
          description: Source of the model
          example: Manual
      additionalProperties: false
      description: Financial Item
    DataValidationRulesDto_2:
      type: object
      properties:
        mandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto_2'
          description: Mandatory Rule - does not allow empty value
        collectionMinimumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto_2'
          description: Validation rule that allows to set minimum count requirements for collection
        collectionMaximumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto_2'
          description: Validation rule that allows to set maximum count requirements for collection
        readOnly:
          allOf:
          - $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto_2'
          description: Validation rule that allows to set if field should be read only
      additionalProperties: false
      description: Request DTO representing validation rule metadata
    FinancialAnalysisVersionsLiteDto:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis Set GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        entityId:
          type: string
          description: Entity Id which financial analysis Set belongs
          format: uuid
          example: 54953531-77df-4e72-98e7-0d314b7a5151
        entityType:
          type:
          - string
          - 'null'
          description: Financial Analysis Entity Type
          example: Company
        journeyId:
          type: string
          description: Journey Id which financial analysis belongs
          format: uuid
          example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4
        taskId:
          type: string
          description: Task Id which financial analysis belongs
          format: uuid
          example: 2c3c8433-efc3-493b-9b14-70b7681c7342
        status:
          type:
          - string
          - 'null'
          description: Financial Analysis Set Status
          example: Draft
        entitiesList:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JointEntityDto_2'
          description: List of entities that financial analysis set belongs to for Joint
        financialAnalysisVersions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionLiteDto'
          description: List of Financial Analysis Versions
      additionalProperties: false
      description: Financial Analysis Set representation with Lite Financial Analysis Versions
    SummaryGroupSchema_2:
      type: object
      properties:
        dataGroupId:
          type:
          - string
          - 'null'
          description: The UiD of the root data group
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        dataGroupVersion:
          type:
          - integer
          - 'null'
          description: Data group version number
          format: int32
          example: 1
        primaryDatakey:
          type:
          - string
          - 'null'
          description: Data group Primary datakey which is used by the dropdown
          example: assetType
        id:
          type:
          - string
          - 'null'
          description: The UiD of the requirement
          format: uuid
          example: 84ec28e2-d786-417b-850f-96321dd849dd
        name:
          type:
          - string
          - 'null'
          description: Group name
          example: Income
        dataField:
          allOf:
          - $ref: '#/components/schemas/DataFieldDto'
          description: Data Field
        order:
          type:
          - number
          - 'null'
          description: Order
          format: double
          example: 1
        validationRule:
          allOf:
          - $ref: '#/components/schemas/ValidationRuleDto_2'
          description: Validation Rule
        validationRulesV2:
          allOf:
          - $ref: '#/components/schemas/DataValidationRulesDto_2'
          description: Validation Rules V2
      additionalProperties: false
      description: Model that contains fields related to financial analysis summary schema
    FinancialAnalysisSchemaDto_2:
      type: object
      properties:
        financialGroupSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialGroupSchema_2'
          description: Financial group schemas that contain data groups information
        financialCommentarySchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialGroupSchema_2'
          description: Schemas that contain commentary information
        lookupSchemas:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LookupSchema'
          description: Lookup schemas that contain data groups and associated lookups information
        scenarioSchema:
          allOf:
          - $ref: '#/components/schemas/ScenarioSchema'
          description: Scenario schemas that contain scenario information
        summarySchema:
          allOf:
          - $ref: '#/components/schemas/SummarySchema'
          description: Summary schemas that contain summary information
      additionalProperties: false
      description: Model that contains information to build financial analysis schema
    SummaryVersionDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SummaryVersionDto_2'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValidationRuleDto_2:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The UiD of the validation rule
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        setId:
          type:
          - string
          - 'null'
          description: The UiD of the requirement set/data group
          format: uuid
          example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3
        propertyId:
          type:
          - string
          - 'null'
          description: The UiD of the requirement/data group field
          format: uuid
          example: 450df9bf-b2d3-48cf-ab8d-481c69b74373
        propertyName:
          type:
          - string
          - 'null'
          description: Requirement/data group field property name
          example: firstName
        friendlyName:
          type:
          - string
          - 'null'
          description: Requirement/data group field friendly Name
          example: First Name
        validationType:
          type:
          - string
          - 'null'
          description: Validation type
          example: text
        validationData:
          allOf:
          - $ref: '#/components/schemas/ValidationDataDto_2'
          description: Validation Data - set of validation rules specific to requirement/data group field
      additionalProperties: false
      description: Request DTO representing validation rule metadata
    JointEntityDto_2:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        entityType:
          type:
          - string
          - 'null'
      additionalProperties: false
    FinancialAnalysisSetDto_2:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis Set GUiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        entityId:
          type: string
          description: Entity Id which financial analysis Set belongs
          format: uuid
          example: 54953531-77df-4e72-98e7-0d314b7a5151
        entityType:
          type:
          - string
          - 'null'
          description: Financial Analysis Entity Type
          example: Company
        journeyId:
          type: string
          description: Journey Id which financial analysis belongs
          format: uuid
          example: 950c8f8f-a367-4f0e-a6ea-23cc3c104cc4
        taskId:
          type: string
          description: Task Id which financial analysis belongs
          format: uuid
          example: 2c3c8433-efc3-493b-9b14-70b7681c7342
        status:
          type:
          - string
          - 'null'
          description: Financial Analysis Set Status
          example: Draft
        entitiesList:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JointEntityDto_2'
          description: List of entities that financial analysis set belongs to for Joint
        isExternalReviewRequired:
          type: boolean
          description: Is External Review required for Financial Analysis Set
          example: false
        financialAnalysisVersions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FinancialAnalysisVersionDto_2'
          description: List of Financial Analysis Versions
      additionalProperties: false
      description: Financial Analysis Set representation
    ColumnSummaryDto_2:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Column id
        value:
          type:
          - string
          - 'null'
          description: Calculated value
      additionalProperties: false
      description: Summary of a financial group by column
    BasicRuleDtoConditionalValidationRuleDto_2:
      type: object
      properties:
        isActive:
          type:
          - boolean
          - 'null'
          description: Validation rule active flag
          example: true
        staticRule:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto2'
          description: Static validation rule always applied when active
      additionalProperties: false
      description: Represent the configuration of the validation rule
    SummaryItemDto_2:
      type: object
      properties:
        id:
          type: string
          description: Summary Item GUiD
          format: uuid
          example: 0b712cf4-1d10-43ba-880b-49354e2db97e
        actualItemId:
          type:
          - string
          - 'null'
          description: Referenced Actual Item Id
          example: ''
        scenarioItemId:
          type:
          - string
          - 'null'
          description: Referenced Scenario Item Id
          example: ''
        dataKey:
          type:
          - string
          - 'null'
          description: Summary Item DataKey
          example: incomeType
        value:
          type:
          - string
          - 'null'
          description: Summary Item Value
          example: Bonus
        source:
          type:
          - string
          - 'null'
          description: Source of the summary item
          example: Manual
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto_2'
          description: Properties of a Summary Item
        summaryValues:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SummaryValueDto_2'
          description: Value of the Summary Item per Period
      additionalProperties: false
      description: Summary Item
    ScenarioGroupDto_2:
      type: object
      properties:
        id:
          type: string
          description: Scenario Group Id
          format: uuid
          example: 51209731-77df-4e72-98e7-0d314b7a5151
        name:
          type:
          - string
          - 'null'
          description: Scenario Group Name
          example: Natural Disaster
        type:
          type:
          - string
          - 'null'
          description: Scenario Group Type
          example: Manual
        scenarioItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioItemDto_2'
          description: List of Scenario Items
        scenarioColumnDefinitions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScenarioColumnDefinitionDto_2'
          description: List of periods captured in this Scenario Analysis
        calculationSummaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CalculationSummaryDto'
          description: List of calculation of summary per column
      additionalProperties: false
    FinancialAnalysisSetLiteDto:
      type: object
      properties:
        id:
          type: string
          description: Financial Analysis UiD
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        entityId:
          type: string
          description: Entity Id which financial analysis Set belongs
          format: uuid
          example: 54953531-77df-4e72-98e7-0d314b7a5151
        entityType:
          type:
          - string
          - 'null'
          description: Financial Analysis Entity Type
          example: Company
        journeyId:
          type: string
          description: Journey Id which financial analysis belongs
          format: uuid
          example: 54953531-77df-4e72-98e7-0d314b7a5151
        taskId:
          type: string
          description: Task Id which financial analysis belongs
          format: uuid
          example: 54953531-77df-4e72-98e7-0d314b7a5151
        status:
          type:
          - string
          - 'null'
          description: Financial Analysis Set Status
          example: Draft
        entitiesList:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JointEntityDto_2'
          description: List of entities that financial analysis set belongs to for Joint
        isExternalReviewRequired:
          type: boolean
          description: Is External Review required for Financial Analysis Set
          example: false
      additionalProperties: false
      description: Financial Analysis Set Lite representation
    SummaryValueDto_2:
      type: object
      properties:
        id:
          type: string
          description: "    Summary Column Id    \n///"
          format: uuid
          example: e9ed602b-e38f-4b20-8ef4-9dcce57058ec
        value:
          type:
          - string
          - 'null'
          description: Summary Value
          example: '100'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-financialanalysiscommand-v1-0-openapi.json
- fenergo-financialanalysisquery-v1-0-openapi.json