openapi: 3.0.1
info:
  title: API Documentation
  description: API Documentation
  version: uk-cca-app-api 0.0.1
servers:
  - url: http://localhost:8082/api
    description: Generated server url
security:
  - bearerAuth: []
paths:
  /v1.0/target-unit-accounts/{accountId}/performance-data-report/lock:
    put:
      tags:
        - Target Period Performance Data Report of the Account
      summary: >-
        Locks/unlocks the account for reporting performance data for the
        specified target period
      operationId: updateAccountPerformanceDataLock
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountPerformanceDataUpdateLockDTO'
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPerformanceDataUpdateLockDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-users/registration/accept-authority-and-set-credentials-to-sector-user:
    put:
      tags:
        - Sector Users registration
      summary: Accept authority and set credentials to sector user
      operationId: acceptAuthorityAndSetCredentialsToSectorUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitedUserCredentialsDTO'
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorUserDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nUSER1003 | User is already registered with different role \t\n USER1004 | User status is not valid \t\n AUTHORITY1005 | User status cannot be updated \t\n CCAAUTHORITY1003 | Authority already exists for a different role type than sector user \t\n EMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-users/registration/accept-authority-and-enable-invited-sector-user-with-credentials:
    put:
      tags:
        - Sector Users registration
      summary: Accept authority and enable sector user from invitation token
      operationId: acceptAuthorityAndEnableInvitedUserWithCredentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SectorUserRegistrationWithCredentialsDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorUserDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nEMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token \t\n USER1003 | User is already registered with different role \t\n AUTHORITY1005 | User status cannot be updated \t\n CCAAUTHORITY1003 | Authority already exists for a different role type than sector user\t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/request-notes/{id}:
    get:
      tags:
        - Request Notes
      summary: Get a request note
      operationId: getRequestNote
      parameters:
        - name: id
          in: path
          description: The note id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestNoteDto'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
        - Request Notes
      summary: Update a request note
      operationId: updateRequestNote
      parameters:
        - name: id
          in: path
          description: The note id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteRequest'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
        - Request Notes
      summary: Delete a request note
      operationId: deleteRequestNote
      parameters:
        - name: id
          in: path
          description: The note id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-users/registration/accept-authority-and-activate-user-from-invitation:
    put:
      tags:
        - Regulator users registration
      summary: Accept authority and activate regulator user from invitation
      operationId: acceptAuthorityAndActivateRegulatorUserFromInvite
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitedUserCredentialsDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n EMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token \t\n USER1001 | User role already exists \t\n USER1004 | User status is not valid t\n AUTHORITY1005 | User status cannot be updated \t\n AUTHORITY1014 | Authority already exists for a different role type or CA "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/operator-users/registration/accept-authority-and-set-credentials-to-operator-user:
    put:
      tags:
        - Operator users registration
      summary: Accept authority and set credentials to operator user
      operationId: acceptAuthorityAndSetCredentialsToOperatorUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitedUserCredentialsDTO'
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorUserDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nUSER1003 | User is already registered with different role \t\n USER1004 | User status is not valid \t\n AUTHORITY1005 | User status cannot be updated \t\n AUTHORITY1016 | Authority already exists for a different role type than operator \t\n EMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/operator-users/registration/accept-authority-and-enable-invited-operator-with-credentials:
    put:
      tags:
        - Operator users registration
      summary: Accept authority and enable operator user from invitation token
      operationId: acceptAuthorityAndEnableInvitedOperatorUserWithCredentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/CcaOperatorUserRegistrationWithCredentialsDTO
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorUserDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nEMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token \t\n USER1003 | User is already registered with different role \t\n AUTHORITY1005 | User status cannot be updated \t\n AUTHORITY1016 | Authority already exists for a different role type than operator \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/notification-templates/{id}:
    get:
      tags:
        - Notification Templates
      summary: Retrieves the notification template with the provided id
      operationId: getNotificationTemplateById
      parameters:
        - name: id
          in: path
          description: The notification template id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplateViewDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
        - Notification Templates
      summary: Updates the notification template with the provided id
      operationId: updateNotificationTemplate
      parameters:
        - name: id
          in: path
          description: The notification template id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplateUpdateDTO'
        required: true
      responses:
        '200':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/mireports/user-defined/{id}:
    get:
      tags:
        - Mi Reports User defined
      summary: Retrieves the MI report user defined
      operationId: getMiReportUserDefinedById
      parameters:
        - name: id
          in: path
          description: The mi Report User Defined Id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiReportUserDefinedDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
        - Mi Reports User defined
      summary: Update MI report user defined
      operationId: updateMiReportUserDefined
      parameters:
        - name: id
          in: path
          description: The mi report user defined id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MiReportUserDefinedDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: "Bad Request\t\n Error Code | Description \t\nMIREPORT1001 | The provided MI Report name already exists"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
        - Mi Reports User defined
      summary: Deletes the MI report user defined with specified id
      operationId: deleteMiReportUserDefined
      parameters:
        - name: id
          in: path
          description: The MI report user defined id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/{facilityId}/performance-data-report/variation-indicator:
    put:
      tags:
        - Target Period Performance Data Report of the Facility
      summary: >-
        Sets the variation indicator for the facility performance data for the
        specified target period year
      operationId: updateFacilityPerformanceDataVariationIndicator
      parameters:
        - name: facilityId
          in: path
          description: The facility id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/FacilityPerformanceDataUpdateVariationIndicatorDTO
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/FacilityPerformanceDataUpdateVariationIndicatorDTO
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/{facilityId}/performance-data-report/lock:
    put:
      tags:
        - Target Period Performance Data Report of the Facility
      summary: >-
        Locks/unlocks the facility for reporting performance data for the
        specified target period year
      operationId: updateFacilityPerformanceDataLock
      parameters:
        - name: facilityId
          in: path
          description: The facility id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityPerformanceDataUpdateLockDTO'
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityPerformanceDataUpdateLockDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/{facilityId}/audit/:
    get:
      tags:
        - Facility Audit Controller
      summary: Retrieves the Facility Audit View by Facility Id
      operationId: getFacilityAuditViewByFacilityId
      parameters:
        - name: facilityId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityAuditViewDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
        - Facility Audit Controller
      summary: Creates or updates the Facility Audit by Facility Id
      operationId: editFacilityAuditDetailsByFacilityId
      parameters:
        - name: facilityId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityAuditUpdateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/account-notes/{id}:
    get:
      tags:
        - Account Notes
      summary: Get an account note
      operationId: getAccountNote
      parameters:
        - name: id
          in: path
          description: The note id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNoteDto'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
        - Account Notes
      summary: Update an account note
      operationId: updateAccountNote
      parameters:
        - name: id
          in: path
          description: The note id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteRequest'
        required: true
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
        - Account Notes
      summary: Delete an account note
      operationId: deleteAccountNote
      parameters:
        - name: id
          in: path
          description: The note id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/validate-password:
    post:
      tags:
        - Validate Password
      summary: Check if password matches the password policy rules
      operationId: validatePassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordValidationRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordValidationResponseDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/security-setup/2fa/request-change:
    post:
      tags:
        - Users Security Setup
      summary: Requests the update of the two factor authentication
      operationId: requestTwoFactorAuthChange
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OneTimePasswordDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nOTP1001 | Invalid OTP \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/forgot-password/token-verification:
    post:
      tags:
        - Forgot Password
      summary: Verifies the JWT token provided in the email
      operationId: verifyToken
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nEMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/forgot-password/reset-password:
    post:
      tags:
        - Forgot Password
      summary: Resets user's password
      operationId: resetPassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPasswordDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nTOKEN1001 | Invalid Token \t\n USER1005 | User not exist \t\n USER1004 | User status is not valid \t\n OTP1001 | Invalid OTP \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/forgot-password/reset-password-email:
    post:
      tags:
        - Forgot Password
      summary: Sends a reset password email
      operationId: sendResetPasswordEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nOTP1001 | Invalid OTP \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/feedback:
    post:
      tags:
        - Users
      summary: Provides the feedback about the service for the logged in user
      operationId: provideUserFeedback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserFeedbackDto'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/tasks/actions:
    post:
      tags:
        - Tasks
      summary: Processes a request task action
      operationId: processRequestTaskAction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestTaskActionProcessDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTaskPayload'
        '204':
          description: No Content
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RequestTaskPayload'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n FORM1002 | Attachment not found \t\n REQUEST_TASK_ACTION1000 | Request task action cannot proceed \t\n REQUEST_TASK_ACTION1001 | User is not the assignee of the request task \t\n ACCOUNT1000 | User account does not belong to legal entity \t\n ACCOUNT1001 | Account name already exists for the user \t\n ACCOUNT1002 | Legal entity name already exists for the user \t\n ACCOUNT1009 | Account status is not valid \t\n ACCOUNT1015 | Aviation Account location doesn't exist \t\n PERMIT1001 | Permit is in invalid state \t\n PERMIT1002 | Invalid Permit review \t\n PERMIT1003 | Invalid Permit \t\n PERMIT1004 | Invalid Permit Variation Review \t\n PERMITSURRENDER1001 | Invalid Permit surrender \t\n "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/tasks-assignment/assign:
    post:
      tags:
        - Tasks Assignment
      summary: Assigns a task to a user
      operationId: assignTask
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestTaskAssignmentDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nITEM1000 | Can not assign request to the provided user \t\nITEM1001 | Request task is not assignable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/task-attachments/upload:
    post:
      tags:
        - Request task attachments handling
      summary: Upload a request task attachment
      operationId: uploadRequestTaskAttachment
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - attachment
                - requestTaskActionDetails
              type: object
              properties:
                requestTaskActionDetails:
                  $ref: '#/components/schemas/RequestTaskAttachmentActionProcessDTO'
                attachment:
                  type: string
                  description: The request task source file attachment
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUuidDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nPERMIT1001 | Permit is in invalid state \t\n FILE1001 | Virus found in input stream \t\n FILE1002 | File size is less than minimum \t\n FILE1003 | File size is greater than maximum \t\nFILE1004 | File upload failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/buy-out-surplus/exclude:
    post:
      tags:
        - Buy-out and surplus info
      summary: Creates the buy-out excluded (on hold) flag for a specific account
      operationId: excludeAccountFromBuyOutSurplus
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/buy-out-surplus/:
    get:
      tags:
        - Buy-out and surplus info
      summary: Retrieves the buy-out and surplus details for a specific account
      operationId: getBuyOutSurplusInfoByAccountId
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBuyOutSurplusInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Buy-out and surplus info
      summary: >-
        Updates the surplus and surplus history for a specific account and
        target period
      operationId: updateSurplusGained
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SurplusUpdateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/runs/{runId}/moas:
    post:
      tags:
        - Subsistence fees run info view
      summary: Retrieves the subsistence fees run MoAs
      operationId: getSubsistenceFeesRunMoas
      parameters:
        - name: runId
          in: path
          description: The runId
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubsistenceFeesMoaSearchCriteria'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesMoaSearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moas/{moaId}/target-units:
    post:
      tags:
        - Subsistence fees MoA view
      summary: Retrieves the subsistence fees MoA target units
      operationId: getSubsistenceFeesMoaTargetUnits
      parameters:
        - name: moaId
          in: path
          description: The moaId
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubsistenceFeesSearchCriteria'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesMoaTargetUnitSearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moas/{moaId}/received-amount:
    get:
      tags:
        - Subsistence fees MoA received amount controller
      summary: Get the received amount history details for the provided MoA id
      operationId: getSubsistenceFeesMoaReceivedAmountInfo
      parameters:
        - name: moaId
          in: path
          description: The subsistence fees MoA id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesMoaReceivedAmountInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Subsistence fees MoA received amount controller
      summary: Update the subsistence fees MoA received amount
      operationId: updateSubsistenceFeesMoaReceivedAmount
      parameters:
        - name: moaId
          in: path
          description: The moaId
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubsistenceFeesMoaReceivedAmountDetailsDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moas/{moaId}/facilities/mark:
    post:
      tags:
        - Subsistence fees MoA view
      summary: Mark status of facilities based on moa id
      operationId: markFacilitiesStatusByMoaId
      parameters:
        - name: moaId
          in: path
          description: The moaId
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubsistenceFeesMoaFacilityMarkingStatusDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moa-target-units/{moaTargetUnitId}/facilities:
    post:
      tags:
        - Subsistence fees MoA target unit view
      summary: Retrieves the subsistence fees MoA target unit facilities
      operationId: getSubsistenceFeesMoaFacilities
      parameters:
        - name: moaTargetUnitId
          in: path
          description: The moa target unit id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubsistenceFeesSearchCriteria'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesMoaFacilitySearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moa-target-units/{moaTargetUnitId}/facilities/mark:
    post:
      tags:
        - Subsistence fees MoA target unit view
      summary: Mark status of facilities based on moa target unit id
      operationId: markFacilitiesStatusByMoaTargetUnitId
      parameters:
        - name: moaTargetUnitId
          in: path
          description: The Target Unit id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubsistenceFeesMoaFacilityMarkingStatusDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsector-schemes/{id}/target-commitments:
    post:
      tags:
        - Subsector association scheme details update
      summary: Update the subsector association scheme commitments
      operationId: updateSubsectorAssociationSchemeTargetCommitments
      parameters:
        - name: id
          in: path
          description: The subsector association scheme id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TargetCommitmentsUpdateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n NOTFOUND1001 | Resource not found \t\n SUBSECTOR_SCHEME1001 | Target commitments are not related to subsector scheme \t\n SUBSECTOR_SCHEME1002 | Subsector association scheme version is not updatable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-users/registration/accept-invitation:
    post:
      tags:
        - Sector Users registration
      summary: Accept invitation for sector user
      operationId: acceptSectorUserInvitation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorInvitedUserInfoDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nEMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token \t\n USER1002 | User is deleted \t\n NOTFOUND1001 | Resource not found \t\n CCAAUTHORITY1004 | User is not sector \t\n "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-users/invite/sector-association/{sectorAssociationId}:
    post:
      tags:
        - Sector Users invitation
      summary: Adds a new sector user to a sector association with a specified role.
      operationId: inviteUserToSectorAssociation
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SectorUserInvitationDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-schemes/{id}/target-commitments:
    post:
      tags:
        - Sector association scheme details update
      summary: Update the sector association scheme commitments
      operationId: updateSectorAssociationSchemeTargetCommitments
      parameters:
        - name: id
          in: path
          description: The sector association scheme id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TargetCommitmentsUpdateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n NOTFOUND1001 | Resource not found \t\n SECTOR_SCHEME1002 | Target commitments are not related to sector scheme \t\n SECTOR_SCHEME1003 | Sector association scheme version is not updatable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-schemes/{id}/details:
    post:
      tags:
        - Sector association scheme details update
      summary: Update the sector association scheme details
      operationId: updateSectorAssociationSchemeDetails
      parameters:
        - name: id
          in: path
          description: The sector association scheme id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SectorAssociationSchemeDetailsUpdateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n FILE1001 | Virus found in input stream \t\n FILE1002 | File size is less than minimum \t\n FILE1003 | File size is greater than maximum \t\nFILE1004 | File upload failed \t\nSECTOR_SCHEME1003 | Sector association scheme version is not updatable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-scheme-document/upload:
    post:
      tags:
        - Sector scheme document upload
      summary: Upload a sector scheme document file
      operationId: uploadSectorSchemeDocumentFile
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - file
              type: object
              properties:
                file:
                  type: string
                  description: The umbrella agreement file
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUuidDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n NOTFOUND1001 | Resource not found \t\n SECTOR_SCHEME1001 | Invalid sector scheme document file type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-authorities/sector-association/{sectorId}:
    get:
      tags:
        - Sector Association authorities
      summary: Retrieves the users of type SECTOR_USER
      operationId: getSectorUserAuthoritiesBySectorAssociationId
      parameters:
        - name: sectorId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorUsersAuthoritiesInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Sector Association authorities
      summary: Update sector user authorities
      operationId: updateSectorUserAuthorities
      parameters:
        - name: sectorId
          in: path
          description: The sectorId id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SectorUserAuthorityUpdateWrapperDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nROLE1000 | Invalid operator role code \t\n AUTHORITY1001 | At least one operator admin should exist in account \t\n AUTHORITY1004 | User is not related to account \t\n AUTHORITY1008 | Authority status in not valid \t\n AUTHORITY1012 | User role can not be modified \t\nACCOUNT_CONTACT1001 | You must have a primary contact on your account \t\nACCOUNT_CONTACT1002 | You must have a financial contact on your account \t\nACCOUNT_CONTACT1003 | You must have a service contact on your account \t\nACCOUNT_CONTACT1004 | You cannot assign the same user as a primary and secondary contact on your account \t\nACCOUNT_CONTACT1005 | You cannot assign an Emitter Contact as primary contact on your account \t\nACCOUNT_CONTACT1006 | You cannot assign an Emitter Contact as secondary contact on your account"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
        - Sector Association authorities
      summary: Delete the current sector user
      operationId: deleteCurrentSectorUser
      parameters:
        - name: sectorId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{sectorId}/target-unit-accounts/:
    get:
      tags:
        - Sector association target unit accounts info
      summary: >-
        Retrieves the target unit accounts and their contacts for specified
        sector
      operationId: getTargetUnitAccountsWithSiteContacts
      parameters:
        - name: sectorId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetUnitAccountInfoResponseDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Sector association target unit accounts info
      summary: Updates target unit account site contacts for specified sector
      operationId: updateTargetUnitAccountSiteContacts
      parameters:
        - name: sectorId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: The target unit account with updated site contacts
              items:
                $ref: '#/components/schemas/TargetUnitAccountSiteContactDTO'
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{sectorAssociationId}/subsistence-fees/moas:
    post:
      tags:
        - Sector association subsistence fees
      summary: Retrieves the subsistence fees MoAs for the specified sector
      operationId: getSectorSubsistenceFeesMoas
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sectorAssociationId
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubsistenceFeesMoaSearchCriteria'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesMoaSearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{sectorAssociationId}/performance-data-report/facilities:
    post:
      tags:
        - Sector-Level Performance Data View Pages
      summary: Populates the target period performance data of sector facilities
      operationId: getSectorFacilityPerformanceDataReportList
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SectorFacilityPerformanceDataReportSearchCriteria
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SectorFacilityPerformanceDataReportListDTO
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nTPRF1001 | Expected exactly one target year, but found multiple."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{sectorAssociationId}/performance-data-report/accounts:
    post:
      tags:
        - Sector-Level Performance Data View Pages
      summary: Populates the target period performance data of sector accounts
      operationId: getSectorAccountPerformanceDataReportList
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SectorAccountPerformanceDataReportSearchCriteria
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorAccountPerformanceDataReportListDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{sectorAssociationId}/performance-account-template-data-report:
    post:
      tags:
        - Sector-Level Performance Account Template Data View Pages
      summary: Populates the performance account template data of sector accounts
      operationId: getSectorPerformanceAccountTemplateDataReportList
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SectorPerformanceAccountTemplateDataReportSearchCriteria
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SectorPerformanceAccountTemplateDataReportListDTO
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{id}/details:
    post:
      tags:
        - Sector Association Details update
      summary: Update the sector association sector details
      operationId: updateSectorAssociationDetails
      parameters:
        - name: id
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SectorAssociationDetailsUpdateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n SECTOR1001 | Sector association details cannot be updated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{id}/contact:
    post:
      tags:
        - Sector Association Details update
      summary: Update the sector association sector contact
      operationId: updateSectorAssociationContact
      parameters:
        - name: id
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SectorAssociationContactDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n SECTOR1002 | Sector association contact cannot be updated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/site-contacts:
    get:
      tags:
        - Sector Associations site contacts
      summary: Retrieves the sector association site contacts
      operationId: getSectorAssociationSiteContacts
      parameters:
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorAssociationSiteContactInfoResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Sector Associations site contacts
      summary: Updates sector association site contacts
      operationId: updateSectorAssociationSiteContacts
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: The sector associations with updated site contacts
              items:
                $ref: '#/components/schemas/SectorAssociationSiteContactDTO'
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/requests:
    post:
      tags:
        - Requests
      summary: Processes a request create action
      operationId: processRequestCreateAction
      parameters:
        - name: resourceId
          in: query
          description: >-
            The resource id on which a request will be created (e.g accountId,
            CA etc.)
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCreateActionProcessDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestCreateActionProcessResponseDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n REQUEST_CREATE_ACTION1000 | Request create action not allowed \t\n ACCOUNT1000 | User account does not belong to legal entity \t\n ACCOUNT1002 | Legal entity name already exists for the user \t\n "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/requests/workflows:
    post:
      tags:
        - Requests
      summary: Get the workflows for the given search criteria
      operationId: getRequestDetailsByResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestSearchCriteria'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestDetailsSearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/request-notes:
    get:
      tags:
        - Request Notes
      summary: Retrieves the notes for request id
      operationId: getNotesByRequestId
      parameters:
        - name: requestId
          in: query
          description: The request id
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestNoteResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Request Notes
      summary: Creates a new request note
      operationId: createRequestNote
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestNoteRequest'
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/request-notes/upload/request/{requestId}:
    post:
      tags:
        - Request Notes
      summary: Upload a note file
      operationId: uploadRequestNoteFile
      parameters:
        - name: requestId
          in: path
          description: The request id
          required: true
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - file
              type: object
              properties:
                file:
                  type: string
                  description: The note file
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUuidDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-users:
    post:
      tags:
        - Regulator Users
      summary: Updates the current regulator user
      operationId: updateCurrentRegulatorUser
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - regulatorUserUpdateDTO
              type: object
              properties:
                regulatorUserUpdateDTO:
                  $ref: '#/components/schemas/RegulatorUserUpdateDTO'
                signature:
                  type: string
                  description: The signature file
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegulatorUserUpdateDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-users/{userId}:
    get:
      tags:
        - Regulator Users
      summary: >-
        Retrieves the user of type REGULATOR that corresponds to the provided
        user id
      operationId: getRegulatorUserByCaAndId
      parameters:
        - name: userId
          in: path
          description: The regulator user id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegulatorUserDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1003 | User is not related to competent authority"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Regulator Users
      summary: >-
        Updates the user of type REGULATOR that corresponds to the provided user
        id
      operationId: updateRegulatorUserByCaAndId
      parameters:
        - name: userId
          in: path
          description: The regulator user id to update
          required: true
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - regulatorUserUpdateDTO
              type: object
              properties:
                regulatorUserUpdateDTO:
                  $ref: '#/components/schemas/RegulatorUserUpdateDTO'
                signature:
                  type: string
                  description: The signature file
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegulatorUserUpdateDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1003 | User is not related to competent authority \t\n INVALID_IMAGE_DIMENSIONSIMAGE1001 | Image dimensions are not valid \t\n FILE1002 | File size is less than minimum \t\n FILE1003 | File size is greater than maximum \t\n FILE1005 | File type is not accepted \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-users/{userId}/reset-2fa:
    post:
      tags:
        - Regulator Users
      summary: >-
        Resets the 2FA device for the user of type REGULATOR that corresponds to
        the provided user id
      operationId: resetRegulator2Fa
      parameters:
        - name: userId
          in: path
          description: Regulator's user id to reset 2FA
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegulatorUserUpdateDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1003 | User is not related to competent authority"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-users/registration/accept-invitation:
    post:
      tags:
        - Regulator users registration
      summary: Accept invitation for regulator user
      operationId: acceptRegulatorInvitation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitedUserInfoDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nEMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token \t\n USER1004 | User status is not valid \t\nUSER1001 | User role already exists \t\n AUTHORITY1005 | User status cannot be updated \t\n AUTHORITY1014 | Authority already exists for a different role type or CA "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/regulator-users/invite:
    post:
      tags:
        - Regulator Users
      summary: Invite new regulator user
      operationId: inviteRegulatorUserToCA
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - regulatorInvitedUser
                - signature
              type: object
              properties:
                regulatorInvitedUser:
                  $ref: '#/components/schemas/RegulatorInvitedUserDTO'
                signature:
                  type: string
                  description: The signature file
                  format: binary
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nUSER1001 | User role already exists \t\n AUTHORITY1005 | User status cannot be updated \t\n AUTHORITY1014 | Authority already exists for a different role type or CA "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-authorities:
    get:
      tags:
        - Regulator Authorities
      summary: Retrieves the users of type REGULATOR
      operationId: getCaRegulators
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegulatorUsersAuthoritiesInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Regulator Authorities
      summary: Updates regulator users status
      operationId: updateCompetentAuthorityRegulatorUsersStatus
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: The regulator users to update
              items:
                $ref: '#/components/schemas/RegulatorUserUpdateStatusDTO'
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
        - Regulator Authorities
      summary: Delete the current regulator user
      operationId: deleteCurrentRegulatorUserByCompetentAuthority
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/operator-users/registration/accept-invitation:
    post:
      tags:
        - Operator users registration
      summary: Accept invitation for operator user
      operationId: acceptOperatorInvitation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CcaOperatorInvitedUserInfoDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nEMAIL1001 | The verification link has expired \t\n TOKEN1001 | Invalid Token \t\n USER1002 | User is deleted \t\n USER1003 | User is already registered with different role \t\n NOTFOUND1001 | Resource not found \t\n AUTHORITY1005 | User status cannot be updated \t\n AUTHORITY1009 | User is not operator \t\n AUTHORITY1016 | Authority already exists for a different role type than operator"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/operator-users/invite/account/{accountId}:
    post:
      tags:
        - Operator Users invitation
      summary: Adds a new operator user to an account with a specified role.
      operationId: inviteOperatorUserToAccount
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CcaOperatorUserInvitationDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n AUTHORITY1005 | User status cannot be updated \t\n AUTHORITY1011 | Regulator user can only add operator administrator users to an account \t\n AUTHORITY1016 | Authority already exists for a different role type than operator \t\nUSER1000 | User registration failed \t\n USER1003 | User is already registered with different role "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/mireports/user-defined:
    get:
      tags:
        - Mi Reports User defined
      summary: Retrieves the MI User defined Reports
      operationId: getAllMiReportsUserDefined
      parameters:
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiReportUserDefinedResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Mi Reports User defined
      summary: Create MI report user defined
      operationId: createMiReportUserDefined
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MiReportUserDefinedDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: "Bad Request\t\n Error Code | Description \t\nMIREPORT1001 | The provided MI Report name already exists"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/mireports/user-defined/{id}/generate:
    post:
      tags:
        - Mi Reports User defined
      summary: Generate MI report user defined
      operationId: generateMiReportUserDefined
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiReportUserDefinedResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/mireports/user-defined/generate-custom:
    post:
      tags:
        - Mi Reports User defined
      summary: Generates custom mi report user defined
      operationId: generateCustomReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomMiReportQuery'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiReportUserDefinedResult'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nMIREPORT1000 | Invalid MI Report type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/mireports/system:
    post:
      tags:
        - MiReports system
      summary: Generates the system report identified by the provided report type
      operationId: generateReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MiReportSystemParams'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MiReportSystemResult'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nMIREPORT1000 | Invalid MI Report type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/file-evidence/upload:
    post:
      tags:
        - File Evidences upload
      summary: Upload an evidence file
      operationId: uploadEvidenceFile
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - file
              type: object
              properties:
                file:
                  type: string
                  description: The evidence file
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUuidDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/document-templates/{id}:
    get:
      tags:
        - Document Templates
      summary: Retrieves the document template with the provided id
      operationId: getDocumentTemplateById
      parameters:
        - name: id
          in: path
          description: The document template id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTemplateViewDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nNOTIF1001 | File does not exist for document template"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Document Templates
      summary: Updates the document template with the provided id
      operationId: updateDocumentTemplate
      parameters:
        - name: id
          in: path
          description: The document template id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - file
              type: object
              properties:
                file:
                  type: string
                  description: The document template source file
                  format: binary
      responses:
        '200':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nNOTIF1001 | File does not exist for document template"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/cca-requests:
    post:
      tags:
        - Cca Requests
      summary: Processes a cca request create action
      operationId: processCcaRequestCreateAction
      parameters:
        - name: sectorAssociationId
          in: query
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
        - name: accountId
          in: query
          description: The account id
          required: false
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCreateActionProcessDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestCreateActionProcessResponseDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n REQUEST_CREATE_ACTION1000 | Request create action not allowed \t\n ACCOUNT1000 | User account does not belong to legal entity \t\n ACCOUNT1002 | Legal entity name already exists for the user \t\n "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/ca-site-contacts:
    get:
      tags:
        - Ca site contacts
      summary: >-
        Retrieves the accounts and competent authority site contact of the
        accounts
      operationId: getCaSiteContacts
      parameters:
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountContactInfoResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Ca site contacts
      summary: Updates competent authority site contacts
      operationId: updateCaSiteContacts
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: The accounts with updated competent authority site contacts
              items:
                $ref: '#/components/schemas/AccountContactDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1003 | User is not related to competent authority \t\n ACCOUNT1004 | Account is not related to competent authority \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/ca-external-contacts:
    get:
      tags:
        - Ca external contacts
      summary: Retrieves the current regulator external contacts
      operationId: getCaExternalContacts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaExternalContactsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Ca external contacts
      summary: Creates a new ca external contact
      operationId: createCaExternalContact
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaExternalContactRegistrationDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/transactions:
    post:
      tags:
        - Buy-out and surplus transactions info view
      summary: >-
        Retrieve buy-out and surplus transactions that match the specified
        search criteria
      operationId: getBuyOutSurplusTransactions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuyOutSurplusTransactionsListSearchCriteria'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyOutSurplusTransactionsListDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/transactions/{id}/update/payment-status:
    post:
      tags:
        - Buy out surplus transaction update controller
      summary: Updates the transaction payment status and transaction history
      operationId: updateBuyOutSurplusTransactionPaymentStatus
      parameters:
        - name: id
          in: path
          description: The transaction id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/BuyOutSurplusTransactionUpdatePaymentStatusDTO
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/transactions/{id}/update/amount:
    post:
      tags:
        - Buy out surplus transaction update controller
      summary: Updates the transaction buy out or refund amount and transaction history
      operationId: updateBuyOutSurplusTransactionAmount
      parameters:
        - name: id
          in: path
          description: The transaction id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuyOutSurplusTransactionUpdateAmountDTO'
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/account-notes:
    get:
      tags:
        - Account Notes
      summary: Retrieves the notes for account id
      operationId: getNotesByAccountId
      parameters:
        - name: accountId
          in: query
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNoteResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Account Notes
      summary: Creates a new account note
      operationId: createAccountNote
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountNoteRequest'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/account-notes/upload/account/{accountId}:
    post:
      tags:
        - Account Notes
      summary: Upload a note file
      operationId: uploadAccountNoteFile
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - file
              type: object
              properties:
                file:
                  type: string
                  description: The note file
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUuidDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/security-setup/2fa/delete:
    patch:
      tags:
        - Users Security Setup
      summary: Delete the two factor authentication
      operationId: deleteOtpCredentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nTOKEN1001 | Invalid Token \t\n EMAIL1001 | The verification link has expired \t\n USER1005 | User not exist \t\n FORM1001 | Form validation failed"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/user-terms:
    get:
      tags:
        - Terms and conditions
      summary: Retrieves accepted terms and conditions version of the logged in user
      operationId: getUserTerms
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserTermsVersionDTO'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - Terms and conditions
      summary: Updates accepted terms and conditions of the logged in user
      operationId: editUserTerms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserTermsVersionUpdateDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserTermsVersionUpdateDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/update/sic:
    patch:
      tags:
        - Update Target Unit Account
      summary: Updates TargetUnit Account Sic codes
      operationId: updateTargetUnitAccountSicCode
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTargetUnitAccountSicCodeDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n ACCOUNT1009 | Account status is not valid"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/update/responsible:
    patch:
      tags:
        - Update Target Unit Account
      summary: Updates TargetUnitAccount Responsible contact details
      operationId: updateTargetUnitAccountResponsiblePerson
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTargetUnitAccountResponsiblePersonDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n ACCOUNT1009 | Account status is not valid"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/update/financial:
    patch:
      tags:
        - Update Target Unit Account
      summary: Updates TargetUnit Account financial independenceStatus code
      operationId: updateTargetUnitAccountFinancialIndependenceStatusCode
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/UpdateTargetUnitAccountFinancialIndependenceStatusCodeDTO
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n ACCOUNT1009 | Account status is not valid"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/update/administrative:
    patch:
      tags:
        - Update Target Unit Account
      summary: Updates TargetUnitAccount Administrative contact details
      operationId: updateTargetUnitAccountAdministrativePerson
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TargetUnitAccountContactDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n ACCOUNT1009 | Account status is not valid"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-users/sector-association/{sectorAssociationId}/{userId}:
    get:
      tags:
        - Sector Users
      summary: Retrieves info of sector user by sector association and user id
      operationId: getSectorUserById
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
        - name: userId
          in: path
          description: The sector user id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorUserAuthorityDetailsDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nCCAAUTHORITY1001 | User is not related to sector association"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - Sector Users
      summary: Updates sector user by sector association and user id
      operationId: updateSectorUserBySectorAssociationIdAndUserId
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
        - name: userId
          in: path
          description: The sector association id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SectorUserAuthorityDetailsDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorUserAuthorityDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-users/sector-association/{sectorAssociationId}/{userId}/reset-2fa:
    patch:
      tags:
        - Sector Users
      summary: >-
        Resets the 2FA device for a sector user by sector association and user
        id
      operationId: resetSectorUser2Fa
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
        - name: userId
          in: path
          description: The sector user id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nCCAAUTHORITY1001 | User is not related to sector association"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-users/sector-association/{sectorAssociationId}/sector-user:
    patch:
      tags:
        - Sector Users
      summary: Updates logged in operator user
      operationId: updateCurrentSectorUser
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SectorUserAuthorityDetailsDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorUserAuthorityDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/operator-users/account/{accountId}:
    get:
      tags:
        - Operator Users
      summary: Retrieves info of the logged in operator user
      operationId: getCurrentOperatorUser
      parameters:
        - name: accountId
          in: path
          description: The operator user id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CcaOperatorUserDetailsDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - Operator Users
      summary: Updates logged in operator user
      operationId: updateCurrentOperatorUser
      parameters:
        - name: accountId
          in: path
          description: The operator account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CcaOperatorUserDetailsDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CcaOperatorUserDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/operator-users/account/{accountId}/{userId}:
    get:
      tags:
        - Operator Users
      summary: Retrieves info of operator user by account and user id
      operationId: getOperatorUserById
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: userId
          in: path
          description: The operator user id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CcaOperatorUserDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - Operator Users
      summary: Updates operator user by account and user id
      operationId: updateOperatorUserById
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: userId
          in: path
          description: The operator user id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CcaOperatorUserDetailsDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CcaOperatorUserDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/operator-users/account/{accountId}/{userId}/reset-2fa:
    patch:
      tags:
        - Operator Users
      summary: Resets the 2FA device for an operator user by account and user id
      operationId: resetOperator2Fa
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: userId
          in: path
          description: The operator user id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorUserDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1004 | User is not related to account"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/operator-authorities/account/{accountId}:
    get:
      tags:
        - Operator Authorities
      summary: >-
        Retrieves the authorities of type OPERATOR for the given account id
        along with the account contact types
      operationId: getAccountOperatorAuthorities
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorAuthoritiesInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - Operator Authorities
      summary: Updates authorities for users of type OPERATOR for the given account id
      operationId: updateAccountOperatorAuthorities
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountOperatorAuthorityUpdateWrapperDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nROLE1000 | Invalid operator role code \t\n AUTHORITY1001 | At least one operator admin should exist in account \t\n AUTHORITY1004 | User is not related to account \t\n AUTHORITY1008 | Authority status in not valid \t\n AUTHORITY1012 | User role can not be modified \t\nACCOUNT_CONTACT1001 | You must have a primary contact on your account \t\nACCOUNT_CONTACT1002 | You must have a financial contact on your account \t\nACCOUNT_CONTACT1003 | You must have a service contact on your account \t\nACCOUNT_CONTACT1004 | You cannot assign the same user as a primary and secondary contact on your account \t\nACCOUNT_CONTACT1005 | You cannot assign an Emitter Contact as primary contact on your account \t\nACCOUNT_CONTACT1006 | You cannot assign an Emitter Contact as secondary contact on your account"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/{facilityId}/scheme-exit-date:
    patch:
      tags:
        - Update Facility Data
      summary: Updates Scheme Exit Date
      operationId: updateFacilitySchemeExitDate
      parameters:
        - name: facilityId
          in: path
          description: The facility id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFacilitySchemeExitDateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n FACILITY1000 | Facility cannot be updated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/{facilityId}/certification:
    patch:
      tags:
        - Update Facility Data
      summary: Updates Facility Certification Status
      operationId: updateFacilityCertificationStatus
      parameters:
        - name: facilityId
          in: path
          description: The facility id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCertificationStatusUpdateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/ca-external-contacts/{id}:
    get:
      tags:
        - Ca external contacts
      summary: Returns the ca external contact with specified id
      operationId: getCaExternalContactById
      parameters:
        - name: id
          in: path
          description: The ca external contact id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CaExternalContactDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
        - Ca external contacts
      summary: Deletes the ca external contact with specified id
      operationId: deleteCaExternalContactById
      parameters:
        - name: id
          in: path
          description: The ca external contact id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - Ca external contacts
      summary: Edits the ca external contact with specified id
      operationId: editCaExternalContact
      parameters:
        - name: id
          in: path
          description: The ca external contact id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaExternalContactRegistrationDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/cost/{tp}:
    patch:
      tags:
        - Buy-out and surplus cost info
      summary: Updates the buy-out cost for the specified target period
      operationId: updateBuyOutCost
      parameters:
        - name: tp
          in: path
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TargetPeriodBuyOutCostUpdateDTO'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n TPR1002 | Target period scheme version is not updatable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/signature:
    get:
      tags:
        - Users
      summary: Generate the token to get the signature of the current user
      operationId: generateGetCurrentUserSignatureToken
      parameters:
        - name: signatureUuid
          in: query
          description: The signature uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/users/current:
    get:
      tags:
        - Users
      summary: Retrieves info of the logged in user
      operationId: getCurrentUser
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UserDTO'
                  - $ref: '#/components/schemas/SectorUserDTO'
                  - $ref: '#/components/schemas/OperatorUserDTO'
                  - $ref: '#/components/schemas/RegulatorCurrentUserDTO'
                  - $ref: '#/components/schemas/VerifierUserDTO'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/user-signatures/{token}:
    get:
      tags:
        - User signatures
      summary: Get the user signature resource for the provided file token
      operationId: getSignature
      parameters:
        - name: token
          in: path
          description: The signature token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/underlying-agreements/{id}/document:
    get:
      tags:
        - Underlying Agreements
      summary: >-
        Generate the token to get the document that belongs to the provided
        underlying agreement id
      operationId: generateGetUnderlyingAgreementDocumentToken
      parameters:
        - name: id
          in: path
          description: The underlying agreement id
          required: true
          schema:
            type: integer
            format: int64
        - name: fileDocumentUuid
          in: query
          description: The document uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/terms:
    get:
      tags:
        - Terms and conditions
      summary: Retrieves the latest version of terms and conditions
      operationId: getLatestTerms
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsDTO'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/tasks/{id}:
    get:
      tags:
        - Tasks
      summary: Get task item info by id
      operationId: getTaskItemInfoById
      parameters:
        - name: id
          in: path
          description: The task id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTaskItemDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/tasks/{id}/default-recipients:
    get:
      tags:
        - Tasks
      summary: >-
        Retrieves the target unit account contacts and the sector association
        contact
      operationId: getDefaultNoticeRecipients
      parameters:
        - name: id
          in: path
          description: The task id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NoticeRecipientDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/tasks/{id}/additional-recipients:
    get:
      tags:
        - Tasks
      summary: >-
        Retrieves the additional recipients for the notify operator workflow
        step
      operationId: getAdditionalNoticeRecipients
      parameters:
        - name: id
          in: path
          description: The task id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdditionalNoticeRecipientDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/tasks/header-info/{resourceType}/{resourceId}:
    get:
      tags:
        - Tasks
      summary: Get the request task header info for the provided resource
      operationId: getRequestTaskHeaderInfo
      parameters:
        - name: resourceType
          in: path
          description: The resource type associated with given resource id
          required: true
          schema:
            type: string
        - name: resourceId
          in: path
          description: The resource id for which the available workflows will be retrieved
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceHeaderInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/tasks-assignment/{taskId}/candidate-assignees:
    get:
      tags:
        - Tasks Assignment
      summary: 'Returns all users to whom can be assigned the provided task '
      operationId: getCandidateAssigneesByTaskId
      parameters:
        - name: taskId
          in: path
          description: The task id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AssigneeUserInfoDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nITEM1001 | Request task is not assignable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/tasks-assignment/{taskId}/candidate-assignees/{taskType}:
    get:
      tags:
        - Tasks Assignment
      summary: Returns all users to whom can be assigned the provided task type
      operationId: getCandidateAssigneesByTaskType
      parameters:
        - name: taskId
          in: path
          description: >-
            The current task id that user works on. Not related to the task type
            for which we search candidate assignees
          required: true
          schema:
            type: integer
            format: int64
        - name: taskType
          in: path
          description: The task type for which you need to retrieve candidate assignees
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AssigneeUserInfoDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nITEM1001 | Request task is not assignable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/task-attachments/{id}:
    get:
      tags:
        - Request task attachments handling
      summary: >-
        Generate the token to get the file with the provided uuid that belongs
        to the provided task
      operationId: generateRequestTaskGetFileAttachmentToken
      parameters:
        - name: id
          in: path
          description: The request task id
          required: true
          schema:
            type: integer
            format: int64
        - name: attachmentUuid
          in: query
          description: The attachment uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}:
    get:
      tags:
        - Target Unit Account info view
      summary: Retrieves the target unit account
      operationId: getTargetUnitAccountDetailsById
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetUnitAccountDetailsResponseDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/performance-data-report/status:
    get:
      tags:
        - Target Period Performance Data Report of the Account
      summary: Retrieves the account performance data status info
      operationId: getAccountPerformanceDataStatus
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriodType
          in: query
          description: The target period business id
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPerformanceDataStatusInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/performance-data-report/details:
    get:
      tags:
        - Target Period Performance Data Report of the Account
      summary: >-
        Retrieves the latest performance data for the account and the target
        period.
      operationId: getAccountPerformanceDataReportDetails
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriodType
          in: query
          description: The target period business id
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPerformanceDataReportDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/performance-data-report/attachment:
    get:
      tags:
        - Target Period Performance Data Report of the Account
      summary: >-
        Retrieves the latest performance data file for the account and the
        target period.
      operationId: generateGetAccountPerformanceDataReportAttachmentToken
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriodType
          in: query
          description: The target period business id
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
        - name: fileAttachmentUuid
          in: query
          description: The attachment uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/performance-account-template-data-report/info:
    get:
      tags:
        - Target Period Performance Account Template Data Report of the Account
      summary: Retrieves the performance account template report info if exist
      operationId: getAccountPerformanceAccountTemplateDataReportInfo
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriodType
          in: query
          description: The target period business id
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AccountPerformanceAccountTemplateDataReportInfoDTO
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/performance-account-template-data-report/details:
    get:
      tags:
        - Target Period Performance Account Template Data Report of the Account
      summary: Retrieves the performance account template report details
      operationId: getAccountPerformanceAccountTemplateDataReportDetails
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriodType
          in: query
          description: The target period business id
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AccountPerformanceAccountTemplateDataReportDetailsDTO
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/performance-account-template-data-report/attachment-token:
    get:
      tags:
        - Target Period Performance Account Template Data Report of the Account
      summary: Retrieves the attachment token for the account and the target period
      operationId: generateGetAccountPerformanceAccountTemplateDataReportAttachmentToken
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriodType
          in: query
          description: The target period type
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
        - name: fileAttachmentUuid
          in: query
          description: The attachment uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/buy-out-surplus/history:
    get:
      tags:
        - Buy-out and surplus info
      summary: Retrieves the surplus history for a specific account and target period
      operationId: getAllSurplusHistoryByTargetPeriodAndAccountId
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriod
          in: query
          description: The target period business id
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SurplusHistoryDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/:
    get:
      tags:
        - Target Unit Account info view
      summary: Retrieves the current user associated accounts
      operationId: searchUserAccounts
      parameters:
        - name: term
          in: query
          description: The term to search
          required: false
          schema:
            maxLength: 256
            minLength: 3
            type: string
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountSearchResults'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-period-reporting/performance-data/available-target-periods:
    get:
      tags:
        - Performance data reporting view info
      summary: Retrieves the eligible target periods for performance data reporting
      operationId: getAvailableTargetPeriodsForPerformanceDataReporting
      parameters:
        - name: scheme
          in: query
          description: The CCA Scheme
          required: true
          schema:
            type: string
            enum:
              - CCA_2
              - CCA_3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PerformanceDataReportTypeDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/runs/{runId}:
    get:
      tags:
        - Subsistence fees run info view
      summary: Retrieves the details for the specific run id
      operationId: getSubsistenceFeesRunDetailsById
      parameters:
        - name: runId
          in: path
          description: The run id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesRunDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/runs/:
    get:
      tags:
        - Subsistence fees run info view
      summary: Retrieves the subsistence fees runs
      operationId: getSubsistenceFeesRuns
      parameters:
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesRunSearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moas/{moaId}:
    get:
      tags:
        - Subsistence fees MoA view
      summary: Retrieves the details for the specific MoA id
      operationId: getSubsistenceFeesMoaDetailsById
      parameters:
        - name: moaId
          in: path
          description: The MoA id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesMoaDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moas/{moaId}/received-amount/evidence:
    get:
      tags:
        - Subsistence fees MoA received amount controller
      summary: >-
        Generate the token to get the evidence file that belongs to the provided
        MoA id
      operationId: generateGetMoaReceivedAmountEvidenceFileToken
      parameters:
        - name: moaId
          in: path
          description: The subsistence fees MoA id
          required: true
          schema:
            type: integer
            format: int64
        - name: fileEvidenceUuid
          in: query
          description: The evidence file uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moas/{moaId}/document:
    get:
      tags:
        - Subsistence fees MoA view
      summary: >-
        Generate the token to get the document that belongs to the provided MoA
        id
      operationId: generateGetSubsistenceFeesMoaDocumentToken
      parameters:
        - name: moaId
          in: path
          description: The subsistence fees MoA id
          required: true
          schema:
            type: integer
            format: int64
        - name: fileDocumentUuid
          in: query
          description: The document uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moa-target-units/{moaTargetUnitId}:
    get:
      tags:
        - Subsistence fees MoA target unit view
      summary: Retrieves the details for the specific MoA target unit id
      operationId: getSubsistenceFeesMoaTargetUnitDetailsById
      parameters:
        - name: moaTargetUnitId
          in: path
          description: The MoA target unit id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsistenceFeesMoaTargetUnitDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsistence-fees/moa-facilities/{moaFacilityId}/marking-history:
    get:
      tags:
        - Subsistence fees MoA facility view
      summary: Retrieves the history details for the specific facility id
      operationId: getSubsistenceFeesMoaFacilityMarkingStatusHistoryInfo
      parameters:
        - name: moaFacilityId
          in: path
          description: The MoA facility id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SubsistenceFeesMoaFacilityMarkingStatusHistoryInfoDTO
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/subsector-association/{subsectorId}/scheme:
    get:
      tags:
        - Subsector association info view
      summary: >-
        Retrieves the subsector association schemes that correspond to the
        provided subsector id
      operationId: getSubsectorAssociationSchemeBySubsectorAssociationId
      parameters:
        - name: subsectorId
          in: path
          description: The subsector association id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubsectorAssociationSchemesDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1003 | User is not related to competent authority"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-users/sector-association/{sectorAssociationId}:
    get:
      tags:
        - Sector Users
      summary: Retrieves info of the logged in sector user
      operationId: getCurrentSectorUser
      parameters:
        - name: sectorAssociationId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorUserAuthorityDetailsDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-scheme-documents/document/{token}:
    get:
      tags:
        - Sector Association Scheme Documents
      summary: >-
        Get the sector association scheme document resource for the provided
        file token
      operationId: getSectorAssociationSchemeDocument
      parameters:
        - name: token
          in: path
          description: The sector association document token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/sector-association/{sectorId}/scheme:
    get:
      tags:
        - Sector association scheme
      summary: >-
        Retrieves the sector association schemes that correspond to the provided
        sector id
      operationId: getSectorAssociationSchemeBySectorAssociationId
      parameters:
        - name: sectorId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorAssociationSchemesDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1003 | User is not related to competent authority"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{sectorId}/scheme/document:
    get:
      tags:
        - Sector association scheme
      summary: >-
        Generate the token to get the document of the sector association with
        the provided sector association id
      operationId: generateGetSectorAssociationSchemeDocumentToken
      parameters:
        - name: sectorId
          in: path
          description: The sector association id the document belongs to
          required: true
          schema:
            type: integer
            format: int64
        - name: documentUuid
          in: query
          description: The sector association document uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nFORM1001 | Form validation failed \t\n NOTFOUND1001 | Resource not found \t\n SECTOR_SCHEME1004 | Submitter is not allowed to access the scheme document"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/{id}:
    get:
      tags:
        - Sector association info view
      summary: >-
        Retrieves the sector association info that corresponds to the provided
        sector id
      operationId: getSectorAssociationById
      parameters:
        - name: id
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectorAssociationResponseDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-association/:
    get:
      tags:
        - Sector association info view
      summary: Retrieves the sectors and their contacts
      operationId: getSectorAssociations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SectorAssociationInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/requests/{id}:
    get:
      tags:
        - Requests
      summary: Get request details by id
      operationId: getRequestDetailsById
      parameters:
        - name: id
          in: path
          description: The request id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/requests/available-workflows/{resourceType}/{resourceId}:
    get:
      tags:
        - Requests
      summary: Get workflows to start a task
      operationId: getAvailableWorkflows
      parameters:
        - name: resourceType
          in: path
          description: The resource type associated with given resource id
          required: true
          schema:
            type: string
        - name: resourceId
          in: path
          description: The resource id for which the available workflows will be retrieved
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/RequestCreateValidationResult'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            '*/*':
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/RequestCreateValidationResult'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            '*/*':
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/RequestCreateValidationResult'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            '*/*':
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/RequestCreateValidationResult'
  /v1.0/request-notes/{requestId}/files:
    get:
      tags:
        - Request Notes
      summary: >-
        Generate the token to get the file that belongs to the provided request
        note id
      operationId: generateGetRequestFileNoteToken
      parameters:
        - name: requestId
          in: path
          description: The request id
          required: true
          schema:
            type: string
        - name: uuid
          in: query
          description: The note file uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/request-actions:
    get:
      tags:
        - Request actions
      summary: Retrieves the actions associated with the request
      operationId: getRequestActionsByRequestId
      parameters:
        - name: requestId
          in: query
          description: The request id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RequestActionInfoDTO'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/request-actions/{id}:
    get:
      tags:
        - Request actions
      summary: Get request action by id
      operationId: getRequestActionById
      parameters:
        - name: id
          in: path
          description: The request action id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestActionDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/request-action-file-documents/{id}:
    get:
      tags:
        - Request action file documents handling
      summary: >-
        Generate the token to get the file document with the provided uuid that
        belongs to the provided request action
      operationId: generateRequestActionGetFileDocumentToken
      parameters:
        - name: id
          in: path
          description: The request action id
          required: true
          schema:
            type: integer
            format: int64
        - name: fileDocumentUuid
          in: query
          description: The file document uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/request-action-attachments/{id}:
    get:
      tags:
        - Request action attachments handling
      summary: >-
        Generate the token to get the file with the provided uuid that belongs
        to the provided request action
      operationId: generateRequestActionGetFileAttachmentToken
      parameters:
        - name: id
          in: path
          description: The request action id
          required: true
          schema:
            type: integer
            format: int64
        - name: attachmentUuid
          in: query
          description: The attachment uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-users/{userId}/signature:
    get:
      tags:
        - Regulator Users
      summary: >-
        Generate the token to get the signature of the user with the provided
        user id
      operationId: generateGetRegulatorSignatureToken
      parameters:
        - name: userId
          in: path
          description: The regulator user id the signature belongs to
          required: true
          schema:
            type: string
        - name: signatureUuid
          in: query
          description: The signature uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-authorities/permissions:
    get:
      tags:
        - Regulator Authorities
      summary: Retrieves the current regulator user's permissions
      operationId: getCurrentRegulatorUserPermissionsByCa
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorityManagePermissionDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-authorities/permissions/{userId}:
    get:
      tags:
        - Regulator Authorities
      summary: Retrieves the regulator user's permissions
      operationId: getRegulatorUserPermissionsByCaAndId
      parameters:
        - name: userId
          in: path
          description: The regulator user id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorityManagePermissionDTO'
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1003 | User is not related to competent authority"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-authorities/permissions/group-levels:
    get:
      tags:
        - Regulator Authorities
      summary: Retrieves the regulator permissions group levels
      operationId: getRegulatorPermissionGroupLevels
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                    enum:
                      - NONE
                      - VIEW_ONLY
                      - EXECUTE
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                    enum:
                      - NONE
                      - VIEW_ONLY
                      - EXECUTE
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
                    enum:
                      - NONE
                      - VIEW_ONLY
                      - EXECUTE
  /v1.0/notification-templates:
    get:
      tags:
        - Notification Templates
      summary: Retrieves the notification templates associated with current user
      operationId: getCurrentUserNotificationTemplates
      parameters:
        - name: roleTypes
          in: query
          description: The list of role types
          required: false
          schema:
            type: array
            items:
              type: string
          example: OPERATOR
        - name: term
          in: query
          description: The term to search
          required: false
          schema:
            maxLength: 256
            minLength: 3
            type: string
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplateSearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/mireports/system/types:
    get:
      tags:
        - MiReports system
      summary: Retrieves the mi report types for current user
      operationId: getCurrentUserMiReports
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MiReportSystemSearchResult'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/mireports/system/request-task-types:
    get:
      tags:
        - MiReports system
      summary: Get regulator related request task types
      operationId: getRegulatorRequestTaskTypes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/items/{requestId}:
    get:
      tags:
        - Request items
      summary: Retrieves the items by request
      operationId: getItemsByRequest
      parameters:
        - name: requestId
          in: path
          description: The request id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemDTOResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/items/unassigned:
    get:
      tags:
        - Unassigned Items
      summary: Retrieves the unassigned items
      operationId: getUnassignedItems
      parameters:
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: searchCriteria
          in: query
          description: The task search criteria
          required: true
          schema:
            $ref: '#/components/schemas/ItemSearchCriteriaDTO'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemDTOResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/items/assigned-to-others:
    get:
      tags:
        - Items Assigned To Others
      summary: >-
        Retrieves the items assigned to users different than the logged-in user
        of the same role type who participate in the same accounts
      operationId: getAssignedToOthersItems
      parameters:
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: searchCriteria
          in: query
          description: The task search criteria
          required: true
          schema:
            $ref: '#/components/schemas/ItemSearchCriteriaDTO'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemDTOResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/items/assigned-to-me:
    get:
      tags:
        - Items Assigned To Me
      summary: Retrieves the items assigned to the logged-in user
      operationId: getAssignedItems
      parameters:
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: searchCriteria
          in: query
          description: The task search criteria
          required: true
          schema:
            $ref: '#/components/schemas/ItemSearchCriteriaDTO'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemDTOResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/file-notes/{token}:
    get:
      tags:
        - File Notes
      summary: Get the file note resource for the provided file token
      operationId: getFileNote
      parameters:
        - name: token
          in: path
          description: The file note token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/file-evidences/{token}:
    get:
      tags:
        - File Evidences
      summary: Get the file evidence resource for the provided file token
      operationId: getFileEvidence
      parameters:
        - name: token
          in: path
          description: The file evidence token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/file-documents/{token}:
    get:
      tags:
        - File Documents
      summary: Get the file document resource for the provided file token
      operationId: getFileDocument
      parameters:
        - name: token
          in: path
          description: The file document token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/file-document-templates/{token}:
    get:
      tags:
        - File Document Templates
      summary: Get the file document template resource for the provided file token
      operationId: getFileDocumentTemplate
      parameters:
        - name: token
          in: path
          description: The file document token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/file-attachments/{token}:
    get:
      tags:
        - File Attachments
      summary: Get the file attachment resource for the provided file attachment token
      operationId: getFileAttachment
      parameters:
        - name: token
          in: path
          description: The file attachment token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
  /v1.0/facility/generate/{accountId}:
    get:
      tags:
        - Facility
      summary: Get the next facility business id per sector association id
      operationId: generateFacilityBusinessId
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityBusinessIdDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facility/facilityBusinessId:
    get:
      tags:
        - Facility
      summary: Checks if facility business ID exists and returns scheme versions
      operationId: getActiveFacilityParticipatingSchemeVersions
      parameters:
        - name: facilityBusinessId
          in: query
          description: The facility business ID to check
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  enum:
                    - CCA_2
                    - CCA_3
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/{facilityId}:
    get:
      tags:
        - Facility info view
      summary: Retrieves the facility details
      operationId: getFacilityDetailsById
      parameters:
        - name: facilityId
          in: path
          description: The facility id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/{facilityId}/performance-data-report/status:
    get:
      tags:
        - Target Period Performance Data Report of the Facility
      summary: Retrieves the facility performance data status info
      operationId: getFacilityPerformanceDataStatus
      parameters:
        - name: facilityId
          in: path
          description: The facility id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriodType
          in: query
          description: The target period business id
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
        - name: reportType
          in: query
          description: The performance data report type
          required: true
          schema:
            type: string
            enum:
              - INTERIM
              - FINAL
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FacilityPerformanceDataStatusInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/{facilityId}/performance-data-report/details:
    get:
      tags:
        - Target Period Performance Data Report of the Facility
      summary: >-
        Retrieves the latest performance data for the facility and the target
        period year.
      operationId: getFacilityPerformanceDataReportDetails
      parameters:
        - name: facilityId
          in: path
          description: The facility id
          required: true
          schema:
            type: integer
            format: int64
        - name: targetPeriodYear
          in: query
          description: The target period year
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityPerformanceDataReportDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/facilities/account/{accountId}:
    get:
      tags:
        - Facility info view
      summary: Retrieves the current account facilities
      operationId: searchFacilities
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: term
          in: query
          description: The term to search
          required: false
          schema:
            maxLength: 256
            minLength: 3
            type: string
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilitySearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/document-templates:
    get:
      tags:
        - Document Templates
      summary: Retrieves the document templates associated with current user
      operationId: getCurrentUserDocumentTemplates
      parameters:
        - name: roleTypes
          in: query
          description: The list of role types
          required: false
          schema:
            type: array
            items:
              type: string
          example: OPERATOR
        - name: term
          in: query
          description: The term to search
          required: false
          schema:
            maxLength: 256
            minLength: 3
            type: string
        - name: page
          in: query
          description: The page number starting from zero
          required: true
          schema:
            minimum: 0
            type: integer
            format: int32
        - name: size
          in: query
          description: The page size
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTemplateSearchResults'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/document-template-files/{id}:
    get:
      tags:
        - Document Template Files
      summary: >-
        Generates the token to get the file with the provided uuid that belongs
        to the provided document template
      operationId: generateGetDocumentTemplateFileToken
      parameters:
        - name: id
          in: path
          description: The document template id
          required: true
          schema:
            type: integer
            format: int64
        - name: fileUuid
          in: query
          description: The file uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/data:
    get:
      tags:
        - Reference Data
      summary: Retrieves reference data by type
      operationId: getReferenceData
      parameters:
        - name: types
          in: query
          description: The reference data types.
          required: true
          schema:
            type: array
            items:
              type: string
              enum:
                - COUNTRIES
                - COUNTIES
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    $ref: '#/components/schemas/ReferenceDataDTO'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    $ref: '#/components/schemas/ReferenceDataDTO'
      security: []
  /v1.0/company-information/{registrationNumber}:
    get:
      tags:
        - Companies information
      summary: >-
        Retrieves information about the company that corresponds to the provided
        registration number
      operationId: getCompanyProfileByRegistrationNumber
      parameters:
        - name: registrationNumber
          in: path
          description: The registration number
          required: true
          schema:
            maxLength: 255
            minLength: 0
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyProfileDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: "Service unavailable\t\n Error Code | Description \t\nCOMPANYINFO1001 | Companies House API is currently unavailable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/certification-period/current:
    get:
      tags:
        - Certification Period view info
      summary: Retrieves the the current certification period
      operationId: getCurrentCertificationPeriod
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificationPeriodInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/cca-authorities/sector-association/{sectorId}/sector-user-roles:
    get:
      tags:
        - Cca Authorities
      summary: Retrieves the sector user roles
      operationId: getSectorUserRoles
      parameters:
        - name: sectorId
          in: path
          description: The sector association id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/transactions/{id}:
    get:
      tags:
        - Buy-out and surplus transaction info view
      summary: >-
        Retrieve buy-out and surplus transaction summary information by
        transaction id
      operationId: getBuyOutSurplusTransactionSummary
      parameters:
        - name: id
          in: path
          description: The transaction id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyOutSurplusTransactionSummaryDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/transactions/{id}/history:
    get:
      tags:
        - Buy-out and surplus transaction info view
      summary: >-
        Retrieve buy-out and surplus transaction history changes by transaction
        id
      operationId: getBuyOutSurplusTransactionHistory
      parameters:
        - name: id
          in: path
          description: The transaction id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BuyOutSurplusTransactionHistoryDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/transactions/{id}/evidence:
    get:
      tags:
        - Buy-out and surplus transaction info view
      summary: >-
        Generate the token to get the evidence file that belongs to the provided
        buy-out and surplus transaction id
      operationId: generateBuyOutSurplusTransactionEvidenceFileToken
      parameters:
        - name: id
          in: path
          description: The transaction id
          required: true
          schema:
            type: integer
            format: int64
        - name: fileEvidenceUuid
          in: query
          description: The evidence file uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/transactions/{id}/document:
    get:
      tags:
        - Buy-out and surplus transaction info view
      summary: >-
        Generate the token to get the document that belongs to the provided
        Transaction id
      operationId: generateBuyOutSurplusTransactionDocumentToken
      parameters:
        - name: id
          in: path
          description: The Transaction id
          required: true
          schema:
            type: integer
            format: int64
        - name: fileDocumentUuid
          in: query
          description: The document uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/transactions/{id}/details:
    get:
      tags:
        - Buy-out and surplus transaction info view
      summary: Retrieve buy-out and surplus transaction details by id
      operationId: getBuyOutSurplusTransactionDetails
      parameters:
        - name: id
          in: path
          description: The transaction id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyOutSurplusTransactionDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/run/excluded-accounts:
    get:
      tags:
        - Buy-out and surplus info
      summary: Retrieves all the on hold accounts for a specific target period
      operationId: getExcludedAccountsForBuyOutSurplusRun
      parameters:
        - name: targetPeriodType
          in: query
          description: The target period business id
          required: true
          schema:
            type: string
            enum:
              - TP5
              - TP6
              - TP7
              - TP8
              - TP9
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TargetUnitAccountBusinessInfoDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/run/available-target-periods:
    get:
      tags:
        - Buy-out and surplus info
      summary: Retrieves the available TPs for buy-out run
      operationId: getAvailableBuyOutTargetPeriods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTargetPeriodsBuyOutDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/buy-out-surplus/cost:
    get:
      tags:
        - Buy-out and surplus cost info
      summary: >-
        Retrieves the buy-out cost for each target period in the specified
        scheme
      operationId: getBuyOutCosts
      parameters:
        - name: schemeVersion
          in: query
          description: The scheme version
          required: true
          schema:
            type: string
            enum:
              - CCA_2
              - CCA_3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TargetPeriodBuyOutDetailsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/authorities/regulator-roles:
    get:
      tags:
        - Authorities
      summary: Returns all regulator roles
      operationId: getRegulatorRoles
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RegulatorRolePermissionsDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/authorities/current-user-state:
    get:
      tags:
        - Authorities
      summary: Retrieves the status of the logged in user
      operationId: getCurrentUserState
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserStateDTO'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/authorities/account/{accountId}/operator-role-codes:
    get:
      tags:
        - Authorities
      summary: Retrieves the operator roles
      operationId: getOperatorRoleCodes
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleDTO'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/account-notes/{accountId}/files:
    get:
      tags:
        - Account Notes
      summary: >-
        Generate the token to get the file that belongs to the provided account
        note id
      operationId: generateGetAccountFileNoteToken
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: uuid
          in: query
          description: The note file uuid
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileToken'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /ui-configuration:
    get:
      tags:
        - UI Configuration
      summary: Retrieves configuration for UI features
      operationId: getUIFlags
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UIPropertiesDTO'
      security: []
  /v1.0/tasks-assignment/release/{taskId}:
    delete:
      tags:
        - Tasks Release
      summary: Releases a task
      operationId: releaseTask
      parameters:
        - name: taskId
          in: path
          description: The task id to be released
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nITEM1000 | Can not assign request to the provided user \t\nITEM1001 | Request task is not assignable"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/target-unit-accounts/{accountId}/buy-out-surplus/include:
    delete:
      tags:
        - Buy-out and surplus info
      summary: Removes the buy-out excluded (on hold) flag for a specific account
      operationId: removeAccountExclusionFromBuyOutSurplus
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/sector-authorities/sector-association/{sectorId}/{userId}:
    delete:
      tags:
        - Sector Association authorities
      summary: Delete authority from the sector association
      operationId: deleteSectorUser
      parameters:
        - name: userId
          in: path
          required: true
          schema:
            type: string
        - name: sectorId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/regulator-authorities/{userId}:
    delete:
      tags:
        - Regulator Authorities
      summary: Delete the regulator user that corresponds to the provided user id
      operationId: deleteRegulatorUserByCompetentAuthority
      parameters:
        - name: userId
          in: path
          description: The regulator to be deleted
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1.0/operator-authorities/account/{accountId}/{userId}:
    delete:
      tags:
        - Operator Authorities
      summary: Deletes authority from the account
      operationId: deleteAccountOperatorAuthority
      parameters:
        - name: accountId
          in: path
          description: The account id
          required: true
          schema:
            type: integer
            format: int64
        - name: userId
          in: path
          description: The user id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '400':
          description: "Bad Request\t\n Error Code | Description \t\nAUTHORITY1001 | At least one operator admin should exist in account \t\n AUTHORITY1004 | User is not related to account"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    HttpHeaders:
      type: object
      properties:
        allow:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/HttpMethod'
        acceptLanguage:
          type: array
          items:
            type: object
            properties:
              range:
                type: string
              weight:
                type: number
                format: double
        accept:
          type: array
          items:
            $ref: '#/components/schemas/MediaType'
        acceptLanguageAsLocales:
          type: array
          items:
            type: object
            properties:
              language:
                type: string
              displayName:
                type: string
              country:
                type: string
              variant:
                type: string
              script:
                type: string
              unicodeLocaleAttributes:
                uniqueItems: true
                type: array
                items:
                  type: string
              unicodeLocaleKeys:
                uniqueItems: true
                type: array
                items:
                  type: string
              displayLanguage:
                type: string
              displayScript:
                type: string
              displayCountry:
                type: string
              displayVariant:
                type: string
              extensionKeys:
                uniqueItems: true
                type: array
                items:
                  type: string
              iso3Language:
                type: string
              iso3Country:
                type: string
        acceptPatch:
          type: array
          items:
            $ref: '#/components/schemas/MediaType'
        accessControlAllowCredentials:
          type: boolean
        accessControlAllowHeaders:
          type: array
          items:
            type: string
        accessControlAllowMethods:
          type: array
          items:
            $ref: '#/components/schemas/HttpMethod'
        accessControlAllowOrigin:
          type: string
        accessControlExposeHeaders:
          type: array
          items:
            type: string
        accessControlMaxAge:
          type: integer
          format: int64
        accessControlRequestHeaders:
          type: array
          items:
            type: string
        accessControlRequestMethod:
          $ref: '#/components/schemas/HttpMethod'
        acceptCharset:
          type: array
          items:
            type: string
        contentDisposition:
          $ref: '#/components/schemas/ContentDisposition'
        etag:
          type: string
        expires:
          type: integer
          format: int64
        ifMatch:
          type: array
          items:
            type: string
        ifNoneMatch:
          type: array
          items:
            type: string
        ifUnmodifiedSince:
          type: integer
          format: int64
        pragma:
          type: string
        range:
          type: array
          items:
            $ref: '#/components/schemas/HttpRange'
        upgrade:
          type: string
        vary:
          type: array
          items:
            type: string
        empty:
          type: boolean
        location:
          type: string
          format: uri
        host:
          type: object
          properties:
            hostString:
              type: string
            address:
              type: object
              properties:
                hostAddress:
                  type: string
                address:
                  type: string
                  format: byte
                hostName:
                  type: string
                linkLocalAddress:
                  type: boolean
                multicastAddress:
                  type: boolean
                anyLocalAddress:
                  type: boolean
                loopbackAddress:
                  type: boolean
                siteLocalAddress:
                  type: boolean
                mcglobal:
                  type: boolean
                mcnodeLocal:
                  type: boolean
                mclinkLocal:
                  type: boolean
                mcsiteLocal:
                  type: boolean
                mcorgLocal:
                  type: boolean
                canonicalHostName:
                  type: string
            port:
              type: integer
              format: int32
            unresolved:
              type: boolean
            hostName:
              type: string
        all:
          type: object
          additionalProperties:
            type: string
          writeOnly: true
        lastModified:
          type: integer
          format: int64
        date:
          type: integer
          format: int64
        contentLength:
          type: integer
          format: int64
        connection:
          type: array
          items:
            type: string
        ifModifiedSince:
          type: integer
          format: int64
        contentType:
          $ref: '#/components/schemas/MediaType'
        origin:
          type: string
        contentLanguage:
          type: object
          properties:
            language:
              type: string
            displayName:
              type: string
            country:
              type: string
            variant:
              type: string
            script:
              type: string
            unicodeLocaleAttributes:
              uniqueItems: true
              type: array
              items:
                type: string
            unicodeLocaleKeys:
              uniqueItems: true
              type: array
              items:
                type: string
            displayLanguage:
              type: string
            displayScript:
              type: string
            displayCountry:
              type: string
            displayVariant:
              type: string
            extensionKeys:
              uniqueItems: true
              type: array
              items:
                type: string
            iso3Language:
              type: string
            iso3Country:
              type: string
        bearerAuth:
          type: string
          writeOnly: true
        basicAuth:
          type: string
          writeOnly: true
        cacheControl:
          type: string
      additionalProperties:
        type: array
        items:
          type: string
    SectorUsersAuthoritiesInfoDTO:
      type: object
      properties:
        authorities:
          type: array
          items:
            $ref: '#/components/schemas/SectorUserAuthorityInfoDTO'
        editable:
          type: boolean
    AuthorisationAndAdditionalEvidence:
      required:
        - authorisationAttachmentIds
      type: object
      properties:
        authorisationAttachmentIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        additionalEvidenceAttachmentIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    SubsistenceFeesRunCompletedRequestActionPayload:
      required:
        - chargingYear
        - paymentRequestId
        - sentInvoices
        - status
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        paymentRequestId:
          type: string
        chargingYear:
          type: integer
          format: int16
        status:
          type: string
        sentInvoices:
          type: integer
          format: int64
        failedInvoices:
          type: integer
          format: int64
        report:
          $ref: '#/components/schemas/FileInfoDTO'
    RdeForceDecisionRequestTaskPayload:
      required:
        - rdeForceDecisionPayload
        - rdeResponsePayload
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        rdeResponsePayload:
          $ref: '#/components/schemas/RdeResponsePayload'
        rdeForceDecisionPayload:
          $ref: '#/components/schemas/RdeForceDecisionPayload'
        rdeAttachments:
          type: object
          additionalProperties:
            type: string
    NonComplianceConclusion:
      required:
        - details
      type: object
      properties:
        details:
          $ref: '#/components/schemas/NonComplianceConclusionDetails'
        withdrawNotice:
          $ref: '#/components/schemas/NonComplianceWithdrawNotice'
    UnderlyingAgreementVariationRegulatorLedSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        underlyingAgreement:
          $ref: >-
            #/components/schemas/UnderlyingAgreementVariationRegulatorLedSavePayload
        determination:
          $ref: '#/components/schemas/VariationRegulatorLedDetermination'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    RfiResponseSubmittedRequestActionPayload:
      required:
        - rfiQuestionPayload
        - rfiResponsePayload
      type: object
      properties:
        payloadType:
          type: string
        rfiQuestionPayload:
          $ref: '#/components/schemas/RfiQuestionPayload'
        rfiResponsePayload:
          $ref: '#/components/schemas/RfiResponsePayload'
        rfiAttachments:
          type: object
          additionalProperties:
            type: string
    SubsistenceFeesMoaTargetUnitSearchResults:
      type: object
      properties:
        subsistenceFeesMoaTargetUnits:
          type: array
          items:
            $ref: >-
              #/components/schemas/SubsistenceFeesMoaTargetUnitSearchResultInfoDTO
        total:
          type: integer
          format: int64
    PerformanceDataFacilityThroughputDetails:
      required:
        - totalTargetVariableEnergy
      type: object
      properties:
        actualThroughput:
          type: string
          format: decimal
        targetImprovement:
          type: string
          format: decimal
        adjustedThroughput:
          type: string
          format: decimal
        totalTargetVariableEnergy:
          type: string
          format: decimal
        variableEnergyConsumptionDataByProduct:
          type: array
          items:
            $ref: >-
              #/components/schemas/PerformanceDataFacilityProductVariableEnergyData
    HttpStatusCode:
      type: object
      properties:
        error:
          type: boolean
        is4xxClientError:
          type: boolean
        is5xxServerError:
          type: boolean
        is1xxInformational:
          type: boolean
        is2xxSuccessful:
          type: boolean
        is3xxRedirection:
          type: boolean
    MiReportUserDefinedDTO:
      required:
        - queryDefinition
        - reportName
      type: object
      properties:
        reportName:
          maxLength: 255
          minLength: 0
          type: string
        description:
          maxLength: 10000
          minLength: 0
          type: string
        queryDefinition:
          maxLength: 10000
          minLength: 0
          type: string
    NonComplianceAppealDetailsSubmittedRequestActionPayload:
      required:
        - registrationDate
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        registrationDate:
          type: string
          format: date
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        comments:
          maxLength: 10000
          minLength: 0
          type: string
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
    UnderlyingAgreementVariationReviewSavePayload:
      required:
        - authorisationAndAdditionalEvidence
        - facilities
        - underlyingAgreementTargetUnitDetails
        - underlyingAgreementVariationDetails
      type: object
      properties:
        underlyingAgreementTargetUnitDetails:
          $ref: '#/components/schemas/UnderlyingAgreementTargetUnitDetails'
        underlyingAgreementVariationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementVariationDetails'
        facilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Facility'
        targetPeriod5Details:
          $ref: '#/components/schemas/TargetPeriod5Details'
        targetPeriod6Details:
          $ref: '#/components/schemas/TargetPeriod6Details'
        authorisationAndAdditionalEvidence:
          $ref: '#/components/schemas/AuthorisationAndAdditionalEvidence'
    Cca2TerminationAccountProcessingSubmittedRequestActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        excludedFacilities:
          type: array
          items:
            $ref: '#/components/schemas/FacilityBaseInfoDTO'
    HttpRange:
      type: object
    RoleDTO:
      type: object
      properties:
        name:
          type: string
        code:
          type: string
    PerformanceDataFacilityReferenceData:
      type: object
      properties:
        baselineAndTargets:
          $ref: '#/components/schemas/PerformanceDataFacilityBaselineAndTargets'
    NonComplianceAppealOutcomeDetails:
      required:
        - appealOutcomeDate
        - tribunalDecision
      type: object
      properties:
        tribunalDecision:
          type: string
          enum:
            - APPEAL_ALLOWED
            - APPEAL_DISMISSED
        appealOutcomeDate:
          type: string
          format: date
        file:
          type: string
          format: uuid
        comments:
          maxLength: 10000
          minLength: 0
          type: string
    RfiResponseSubmitRequestTaskActionPayload:
      required:
        - rfiResponsePayload
      type: object
      properties:
        payloadType:
          type: string
        rfiResponsePayload:
          $ref: '#/components/schemas/RfiResponsePayload'
    BuyOutSurplusTransactionDetailsDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        transactionCode:
          type: string
        accountBusinessId:
          type: string
        operatorName:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodResultType:
          type: string
          enum:
            - TARGET_MET
            - BUY_OUT_REQUIRED
            - SURPLUS_USED_BUY_OUT_REQUIRED
            - SURPLUS_USED
            - OUTSTANDING
        reportVersion:
          type: string
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        fileInfoDTO:
          $ref: '#/components/schemas/FileInfoDTO'
        creationDate:
          type: string
          format: date-time
        dueDate:
          type: string
          format: date
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - AWAITING_REFUND
            - PAID
            - REFUNDED
            - NOT_REQUIRED
            - UNDER_APPEAL
            - TERMINATED
        chargeType:
          type: string
          enum:
            - REFUND
            - FEE
        priBuyOutCarbon:
          type: string
          format: decimal
        priBuyOutCost:
          type: string
          format: decimal
        invoicedBuyOutFee:
          type: string
          format: decimal
        invoicedSurplusGained:
          type: string
          format: decimal
        invoicedPreviousPaidFees:
          type: string
          format: decimal
        buyOutFee:
          type: string
          format: decimal
    BuyOutSurplusRunSummary:
      required:
        - buyOutTransactions
        - failedAccounts
        - refundedTransactions
        - totalAccounts
      type: object
      properties:
        totalAccounts:
          type: integer
          format: int64
        failedAccounts:
          type: integer
          format: int64
        buyOutTransactions:
          type: integer
          format: int64
        refundedTransactions:
          type: integer
          format: int64
    TargetCommitmentUpdateDTO:
      required:
        - id
        - targetImprovement
      type: object
      properties:
        id:
          type: integer
          format: int64
        targetImprovement:
          type: string
          format: decimal
    SubsectorAssociationInfoDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    SectorAssociationSchemeDetailsUpdateDTO:
      required:
        - sectorDefinition
        - umaDate
        - umbrellaAgreementUuid
      type: object
      properties:
        umbrellaAgreementUuid:
          type: string
        umaDate:
          type: string
          format: date
        sectorDefinition:
          maxLength: 10000
          minLength: 0
          type: string
      description: The sector association scheme details fields
    NotificationTemplateUpdateDTO:
      required:
        - subject
        - text
      type: object
      properties:
        subject:
          maxLength: 255
          minLength: 0
          type: string
        text:
          maxLength: 10000
          minLength: 0
          type: string
      description: The data to update the notification template
    ResourceHeaderInfoDTO:
      type: object
      properties:
        name:
          type: string
    AccountNoteDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        payload:
          $ref: '#/components/schemas/NotePayload'
        submitter:
          type: string
        lastUpdatedOn:
          type: string
          format: date-time
        accountId:
          type: integer
          format: int64
    SectorAssociationSiteContactInfoDTO:
      type: object
      properties:
        sectorAssociationId:
          type: integer
          format: int64
        sectorName:
          type: string
        userId:
          type: string
    SectorFacilityPerformanceDataReportItemDTO:
      type: object
      properties:
        facilityId:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        siteName:
          type: string
        accountId:
          type: integer
          format: int64
        submissionDate:
          type: string
          format: date-time
        reportVersion:
          type: integer
          format: int32
        reportStatus:
          type: string
          enum:
            - TARGET_MET
            - TARGET_NOT_MET
            - SUBMITTED
            - OUTSTANDING
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        locked:
          type: boolean
        variationIndicator:
          type: boolean
        atLeastSeventyPercentEnergyUsed:
          type: boolean
        surplusGained:
          type: string
          format: decimal
        actualEnergyCarbon:
          type: string
          format: decimal
        targetEnergyCarbon:
          type: string
          format: decimal
        energyCarbonDifference:
          type: string
          format: decimal
        targetCo2Emissions:
          type: string
          format: decimal
        actualCo2Emissions:
          type: string
          format: decimal
        co2EmissionsDifference:
          type: string
          format: decimal
        actualImprovement:
          type: string
          format: decimal
        buyOutRequired:
          type: string
          format: decimal
    HttpMethod:
      type: object
    UnderlyingAgreementApplySavePayload:
      required:
        - authorisationAndAdditionalEvidence
        - facilities
        - underlyingAgreementTargetUnitDetails
      type: object
      properties:
        underlyingAgreementTargetUnitDetails:
          $ref: '#/components/schemas/UnderlyingAgreementTargetUnitDetails'
        facilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/FacilityItem'
        authorisationAndAdditionalEvidence:
          $ref: '#/components/schemas/AuthorisationAndAdditionalEvidence'
    RequestCreateActionProcessDTO:
      required:
        - requestCreateActionPayload
        - requestType
      type: object
      properties:
        requestType:
          type: string
        requestCreateActionPayload:
          $ref: '#/components/schemas/RequestCreateActionPayload'
      description: The request create action body
    UnderlyingAgreementRejectedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - determination
        - officialNotice
        - underlyingAgreement
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
        determination:
          $ref: '#/components/schemas/Determination'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementFacilityReviewDecision'
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
    AccountPerformanceDataReportDetailsDTO:
      type: object
      properties:
        targetPeriodReport:
          $ref: '#/components/schemas/FileInfoDTO'
        submissionDate:
          type: string
          format: date-time
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        reportVersion:
          type: integer
          format: int32
        energyCarbonUnit:
          type: string
          enum:
            - ENERGY_KWH
            - ENERGY_MWH
            - ENERGY_GJ
            - CARBON_KG
            - CARBON_TONNE
        targetType:
          type: string
          enum:
            - ABSOLUTE
            - RELATIVE
            - NOVEM
        throughputUnit:
          type: string
        tpPerformance:
          type: string
          format: decimal
        percentTarget:
          type: string
          format: decimal
        tpPerformancePercent:
          type: string
          format: decimal
        tpOutcome:
          type: string
          enum:
            - TARGET_MET
            - BUY_OUT_REQUIRED
            - SURPLUS_USED_BUY_OUT_REQUIRED
            - SURPLUS_USED
            - OUTSTANDING
        carbonSurplusBuyOutDTO:
          $ref: '#/components/schemas/CarbonSurplusBuyOutDTO'
        secondaryMoASurplusBuyOutDTO:
          $ref: '#/components/schemas/SecondaryMoASurplusBuyOutDTO'
    PaymentProcessedRequestActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        paymentRefNum:
          type: string
        paymentDate:
          type: string
          format: date
        paidByFullName:
          type: string
        amount:
          type: string
          format: decimal
        status:
          type: string
          enum:
            - MARK_AS_PAID
            - MARK_AS_RECEIVED
            - COMPLETED
            - CANCELLED
        paymentMethod:
          type: string
          enum:
            - BANK_TRANSFER
            - CREDIT_OR_DEBIT_CARD
        receivedDate:
          type: string
          format: date
    NonComplianceConclusionDetails:
      required:
        - comment
        - complianceRestored
        - penaltyOutcome
        - penaltyPaid
      type: object
      properties:
        complianceRestored:
          type: boolean
        complianceRestoredDate:
          type: string
          format: date
        penaltyPaid:
          type: boolean
        penaltyPaymentDate:
          type: string
          format: date
        comment:
          maxLength: 10000
          minLength: 0
          type: string
        penaltyOutcome:
          type: string
          enum:
            - REISSUE
            - WITHDRAW
            - NONE
    CcaDecisionNotification:
      required:
        - signatory
      type: object
      properties:
        operators:
          uniqueItems: true
          type: array
          items:
            type: string
        externalContacts:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int64
        signatory:
          type: string
        sectorUsers:
          uniqueItems: true
          type: array
          items:
            type: string
    SectorUserInvitationDTO:
      required:
        - email
        - firstName
        - lastName
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        roleCode:
          type: string
        contactType:
          type: string
          enum:
            - SECTOR_ASSOCIATION
            - OPERATOR
            - CONSULTANT
      description: The sector user sector association registration info
    CaExternalContactDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        email:
          type: string
        description:
          type: string
        lastUpdatedDate:
          type: string
          format: date-time
    SectorAssociationDetailsUpdateDTO:
      required:
        - commonName
        - legalName
        - noticeServiceAddress
      type: object
      properties:
        commonName:
          maxLength: 255
          minLength: 0
          type: string
        legalName:
          maxLength: 255
          minLength: 0
          type: string
        noticeServiceAddress:
          $ref: '#/components/schemas/AddressDTO'
      description: The sector association details fields
    SecondaryDetermination:
      required:
        - carbonUnderTarget
        - co2Emissions
        - energyCarbonUnderTarget
        - priBuyOutCarbon
        - secondaryBuyOutCo2
        - secondaryBuyOutCost
        - tpCarbonFactor
      type: object
      properties:
        tpCarbonFactor:
          type: string
          format: decimal
        energyCarbonUnderTarget:
          type: string
          format: decimal
        carbonUnderTarget:
          type: string
          format: decimal
        co2Emissions:
          type: string
          format: decimal
        priBuyOutCarbon:
          type: string
          format: decimal
        prevBuyOutCo2:
          type: string
          format: decimal
        prevSurplusUsed:
          type: string
          format: decimal
        prevSurplusGained:
          type: string
          format: decimal
        secondaryBuyOutCo2:
          type: string
          format: decimal
        secondaryBuyOutCost:
          type: string
          format: decimal
    RequestActionPayload:
      type: object
      properties:
        payloadType:
          type: string
      discriminator:
        propertyName: payloadType
    UnderlyingAgreementVariationRegulatorLedPeerReviewRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        workflowSchemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        originalUnderlyingAgreementContainer:
          $ref: '#/components/schemas/UnderlyingAgreementContainer'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        facilityChargeStartDateMap:
          type: object
          additionalProperties:
            type: string
            format: date
        determination:
          $ref: '#/components/schemas/VariationRegulatorLedDetermination'
        regulatorLedSubmitAttachments:
          type: object
          additionalProperties:
            type: string
        decision:
          $ref: '#/components/schemas/CcaPeerReviewDecision'
        peerReviewAttachments:
          type: object
          additionalProperties:
            type: string
    TargetPeriodBuyOutDetailsDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        businessId:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        buyOutCost:
          type: integer
          format: int32
    RequestDetailsDTO:
      type: object
      properties:
        id:
          type: string
        requestType:
          type: string
        requestStatus:
          type: string
        creationDate:
          type: string
          format: date
        requestMetadata:
          $ref: '#/components/schemas/RequestMetadata'
    TargetUnitIdentityAndPerformance:
      required:
        - performanceImpactedByAnyImplementedMeasures
      type: object
      properties:
        targetType:
          type: string
          enum:
            - ABSOLUTE
            - RELATIVE
            - NOVEM_ENERGY
            - NOVEM_CARBON
        targetPercentage:
          type: string
          format: decimal
        improvementAchievedPercentage:
          type: string
          format: decimal
        improvementAccountedPercentage:
          type: string
          format: decimal
        performanceImpactedByAnyImplementedMeasures:
          type: string
        performanceImpactedByAnyImplementedMeasuresSupportingText:
          type: string
        totalEstimateChangeInEnergyConsumptionPercentage:
          type: string
          format: decimal
        totalEstimateChangeInCarbonEmissionsPercentage:
          type: string
          format: decimal
    FacilityBusinessIdDTO:
      type: object
      properties:
        facilityBusinessId:
          type: string
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        security:
          type: boolean
        data:
          type: array
          items:
            type: object
    OperatorUserDTO:
      required:
        - email
        - firstName
        - lastName
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        mobileNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
    DocumentTemplateInfoDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        roleType:
          type: string
        workflow:
          type: string
        lastUpdatedDate:
          type: string
          format: date-time
    PerformanceDataFacilityCalculatedResults:
      required:
        - actualCo2Emissions
        - actualEnergyCarbon
        - actualImprovement
        - co2EmissionsDifference
        - energyCarbonDifference
        - targetCo2Emissions
        - targetEnergyCarbon
        - targetImprovement
        - weightedConversionFactor
      type: object
      properties:
        actualEnergyCarbon:
          type: string
          format: decimal
        targetEnergyCarbon:
          type: string
          format: decimal
        energyCarbonDifference:
          type: string
          format: decimal
        targetImprovement:
          type: string
          format: decimal
        weightedConversionFactor:
          type: string
          format: decimal
        targetCo2Emissions:
          type: string
          format: decimal
        actualCo2Emissions:
          type: string
          format: decimal
        co2EmissionsDifference:
          type: string
          format: decimal
        actualImprovement:
          type: string
          format: decimal
        targetPeriodResultType:
          type: string
          enum:
            - TARGET_MET
            - TARGET_NOT_MET
            - SUBMITTED
            - OUTSTANDING
        surplusGained:
          type: string
          format: decimal
        buyOutRequired:
          type: string
          format: decimal
    AuthorityManagePermissionDTO:
      type: object
      properties:
        permissions:
          type: object
          additionalProperties:
            type: string
            enum:
              - NONE
              - VIEW_ONLY
              - EXECUTE
        editable:
          type: boolean
    RfiQuestionPayload:
      required:
        - questions
      type: object
      properties:
        questions:
          type: array
          items:
            maxLength: 10000
            minLength: 0
            type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    ItemFacilityDTO:
      type: object
      properties:
        facilityId:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        siteName:
          type: string
    AccountUploadReport:
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        accountBusinessId:
          type: string
        succeeded:
          type: boolean
        file:
          $ref: '#/components/schemas/FileInfoDTO'
        errorFilenames:
          type: array
          items:
            type: string
        errors:
          type: array
          items:
            type: string
    RequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
      discriminator:
        propertyName: payloadType
    AuditDetailsCorrectiveActionsSubmitRequestTaskPayload:
      required:
        - auditDetailsAndCorrectiveActions
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        auditDetailsAndCorrectiveActions:
          $ref: '#/components/schemas/AuditDetailsAndCorrectiveActions'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        facilityAuditAttachments:
          type: object
          additionalProperties:
            type: string
    RfiResponsePayload:
      required:
        - answers
      type: object
      properties:
        answers:
          type: array
          items:
            maxLength: 10000
            minLength: 0
            type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    UIPropertiesDTO:
      type: object
      properties:
        features:
          type: object
          additionalProperties:
            type: boolean
        analytics:
          type: object
          additionalProperties:
            type: string
        keycloakServerUrl:
          type: string
        subsistenceFeesRunTriggerDate:
          type: string
          format: date
        underlyingAgreementSchemeParticipationFlagCutOffDate:
          type: string
          format: date
        notificationAlerts:
          type: array
          items:
            $ref: '#/components/schemas/NotificationAlertDTO'
    SubsistenceFeesRunRequestMetadata:
      type: object
      properties:
        type:
          type: string
        chargingYear:
          type: integer
          format: int16
        sectorsReports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/MoaReport'
        accountsReports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/MoaReport'
        skippedSectors:
          type: integer
          format: int64
        sentInvoices:
          type: integer
          format: int64
          readOnly: true
        failedInvoices:
          type: integer
          format: int64
          readOnly: true
    SectorAssociationSchemeDocumentDTO:
      required:
        - fileName
        - fileType
        - id
        - uuid
      type: object
      properties:
        uuid:
          type: string
        id:
          type: integer
          format: int64
        fileName:
          maxLength: 255
          minLength: 0
          type: string
        fileSize:
          type: integer
          format: int64
        fileType:
          type: string
    DocumentTemplateViewDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        workflow:
          type: string
        lastUpdatedDate:
          type: string
          format: date-time
        notificationTemplateId:
          type: integer
          format: int64
        fileUuid:
          type: string
        filename:
          type: string
        notificationTemplate:
          $ref: '#/components/schemas/NotificationTemplateInfoDTO'
    RequestActionUserInfo:
      required:
        - name
      type: object
      properties:
        name:
          type: string
        roleCode:
          type: string
        contactTypes:
          uniqueItems: true
          type: array
          items:
            type: string
    AccountPerformanceDataUpdateLockDTO:
      required:
        - locked
        - targetPeriodType
      type: object
      properties:
        locked:
          type: boolean
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
    TargetUnitAccountSiteContactDTO:
      required:
        - accountId
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        userId:
          type: string
    DefaultNoticeRecipient:
      required:
        - email
        - name
        - recipientType
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        recipientType:
          type: string
          enum:
            - RESPONSIBLE_PERSON
            - ADMINISTRATIVE_CONTACT
            - SECTOR_CONTACT
            - SECTOR_USER
            - SECTOR_CONSULTANT
            - OPERATOR
    TargetUnitAccountPayload:
      required:
        - address
        - administrativeContactDetails
        - competentAuthority
        - emissionTradingScheme
        - isCompanyRegistrationNumber
        - name
        - operatorType
        - responsiblePerson
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 0
          type: string
        emissionTradingScheme:
          type: string
          enum:
            - DUMMY_EMISSION_TRADING_SCHEME
        competentAuthority:
          type: string
          enum:
            - ENGLAND
            - NORTHERN_IRELAND
            - OPRED
            - SCOTLAND
            - WALES
        operatorType:
          type: string
          enum:
            - LIMITED_COMPANY
            - PARTNERSHIP
            - SOLE_TRADER
            - NONE
        isCompanyRegistrationNumber:
          type: boolean
        companyRegistrationNumber:
          maxLength: 255
          minLength: 0
          type: string
        registrationNumberMissingReason:
          maxLength: 255
          minLength: 0
          type: string
        sicCodes:
          maxItems: 4
          minItems: 0
          type: array
          items:
            maxLength: 255
            minLength: 0
            type: string
        subsectorAssociationId:
          type: integer
          format: int64
        subsectorAssociationName:
          maxLength: 255
          minLength: 0
          type: string
        address:
          $ref: '#/components/schemas/AccountAddressDTO'
        responsiblePerson:
          $ref: '#/components/schemas/TargetUnitAccountContactDTO'
        administrativeContactDetails:
          $ref: '#/components/schemas/TargetUnitAccountContactDTO'
    NonComplianceAppealOutcomeSubmittedRequestActionPayload:
      required:
        - appealOutcome
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        appealOutcome:
          $ref: '#/components/schemas/NonComplianceAppealOutcomeDetails'
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
    UnderlyingAgreementVariationFacilityReviewDecision:
      required:
        - facilityStatus
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - ACCEPTED
            - REJECTED
        details:
          $ref: '#/components/schemas/UnderlyingAgreementReviewDecisionDetails'
        changeStartDate:
          type: boolean
        startDate:
          type: string
          format: date
        facilityStatus:
          type: string
          enum:
            - NEW
            - LIVE
            - EXCLUDED
    PerformanceDataFacilitySubmittedRequestActionPayload:
      required:
        - details
        - performanceData
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        details:
          $ref: '#/components/schemas/PerformanceDataFacilitySubmissionDetails'
        performanceData:
          $ref: '#/components/schemas/PerformanceDataFacilityContainer'
    UnderlyingAgreementSubmittedRequestActionPayload:
      required:
        - underlyingAgreement
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
    RdeResponseSubmitRequestTaskActionPayload:
      required:
        - rdeDecisionPayload
      type: object
      properties:
        payloadType:
          type: string
        rdeDecisionPayload:
          $ref: '#/components/schemas/RdeDecisionPayload'
    UnderlyingAgreementTargetUnitDetails:
      required:
        - isCompanyRegistrationNumber
        - operatorAddress
        - operatorName
        - operatorType
        - responsiblePersonDetails
      type: object
      properties:
        operatorName:
          maxLength: 255
          minLength: 0
          type: string
        operatorAddress:
          $ref: '#/components/schemas/AccountAddressDTO'
        responsiblePersonDetails:
          $ref: '#/components/schemas/UnderlyingAgreementTargetUnitResponsiblePerson'
        operatorType:
          type: string
          enum:
            - LIMITED_COMPANY
            - PARTNERSHIP
            - SOLE_TRADER
            - NONE
        isCompanyRegistrationNumber:
          type: boolean
        companyRegistrationNumber:
          maxLength: 255
          minLength: 0
          type: string
        registrationNumberMissingReason:
          maxLength: 255
          minLength: 0
          type: string
        subsectorAssociationName:
          maxLength: 255
          minLength: 0
          type: string
        subsectorAssociationId:
          type: integer
          format: int64
    UnderlyingAgreementVariationSaveFacilityReviewGroupDecisionRequestTaskActionPayload:
      required:
        - decision
        - group
      type: object
      properties:
        payloadType:
          type: string
        group:
          type: string
        determination:
          $ref: '#/components/schemas/VariationDetermination'
        decision:
          $ref: >-
            #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    ResetPasswordDTO:
      required:
        - otp
        - password
        - token
      type: object
      properties:
        token:
          type: string
        otp:
          pattern: \d{6}
          type: string
        password:
          type: string
      description: The new password
    UnderlyingAgreement:
      required:
        - authorisationAndAdditionalEvidence
      type: object
      properties:
        facilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Facility'
        targetPeriod5Details:
          $ref: '#/components/schemas/TargetPeriod5Details'
        targetPeriod6Details:
          $ref: '#/components/schemas/TargetPeriod6Details'
        authorisationAndAdditionalEvidence:
          $ref: '#/components/schemas/AuthorisationAndAdditionalEvidence'
    SectorPerformanceAccountTemplateDataReportListDTO:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/SectorPerformanceAccountTemplateDataReportItemDTO
        total:
          type: integer
          format: int64
    DocumentTemplateDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        workflow:
          type: string
        lastUpdatedDate:
          type: string
          format: date-time
        notificationTemplateId:
          type: integer
          format: int64
        fileUuid:
          type: string
        filename:
          type: string
    FacilityPerformanceAccountTemplateDataUploadProcessingRequestTaskActionPayload:
      required:
        - performanceAccountTemplateDataUpload
      type: object
      properties:
        payloadType:
          type: string
        performanceAccountTemplateDataUpload:
          $ref: '#/components/schemas/FacilityPerformanceAccountTemplateDataUpload'
    AccountNoteResponse:
      type: object
      properties:
        accountNotes:
          type: array
          items:
            $ref: '#/components/schemas/AccountNoteDto'
        totalItems:
          type: integer
          format: int64
    AdminTerminationFinalDecisionReasonDetails:
      required:
        - explanation
        - finalDecisionType
      type: object
      properties:
        finalDecisionType:
          type: string
          enum:
            - TERMINATE_AGREEMENT
            - WITHDRAW_TERMINATION
        explanation:
          maxLength: 10000
          minLength: 0
          type: string
        relevantFiles:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    TargetPeriodDetailsDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        businessId:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        name:
          type: string
        targetPeriodYearsContainer:
          $ref: '#/components/schemas/TargetPeriodYearsContainer'
        buyOutStartDate:
          type: string
          format: date
        buyOutPrimaryPaymentDeadline:
          type: string
          format: date
        buyOutCost:
          type: integer
          format: int32
        secondaryReportingStartDate:
          type: string
          format: date
        schemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
    TargetComposition:
      required:
        - agreementCompositionType
        - calculatorFile
        - measurementType
      type: object
      properties:
        calculatorFile:
          type: string
          format: uuid
        measurementType:
          type: string
          enum:
            - ENERGY_KWH
            - ENERGY_MWH
            - ENERGY_GJ
            - CARBON_KG
            - CARBON_TONNE
        agreementCompositionType:
          type: string
          enum:
            - ABSOLUTE
            - RELATIVE
            - NOVEM
        isTargetUnitThroughputMeasured:
          type: boolean
        throughputUnit:
          type: string
        conversionFactor:
          type: string
          format: decimal
        conversionEvidences:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    PaymentTrackRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        amount:
          type: string
          format: decimal
        paymentRefNum:
          type: string
    PerformanceDataFacilityNonStandardFuel:
      required:
        - conversionFactor
        - deliveredEnergy
        - name
        - primaryEnergy
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 0
          type: string
        conversionFactor:
          type: string
          format: decimal
        deliveredEnergy:
          type: string
          format: decimal
        primaryEnergy:
          type: string
          format: decimal
    NonComplianceFacilityDTO:
      required:
        - facilityBusinessId
        - isHistorical
      type: object
      properties:
        facilityBusinessId:
          maxLength: 255
          minLength: 0
          type: string
        isHistorical:
          type: boolean
    UnderlyingAgreementVariationCompletedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - determination
        - officialNotices
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialNotices:
          type: array
          items:
            $ref: '#/components/schemas/FileInfoDTO'
        determination:
          $ref: '#/components/schemas/VariationDetermination'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
    NonComplianceNoticeOfIntentSubmitSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        noticeOfIntent:
          $ref: '#/components/schemas/NonComplianceNoticeOfIntent'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    NotifyOperatorForDecisionRequestTaskActionPayload:
      required:
        - decisionNotification
      type: object
      properties:
        payloadType:
          type: string
        decisionNotification:
          $ref: '#/components/schemas/DecisionNotification'
    PerformanceAccountTemplateDataUploadSubmitRequestTaskPayload:
      required:
        - reportPackages
        - targetPeriodType
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportPackages:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        fileReports:
          $ref: '#/components/schemas/FileReports'
        csvReportFile:
          $ref: '#/components/schemas/FileInfoDTO'
        processingStatus:
          type: string
          enum:
            - NOT_STARTED_YET
            - IN_PROGRESS
            - COMPLETED
        errorType:
          type: string
          enum:
            - CSV_GENERATION_FAILED
            - REPORT_PACKAGE_MISSING
            - EXTRACT_VALIDATE_PERSIST_GENERIC_ERROR
        uploadAttachments:
          type: object
          additionalProperties:
            type: string
    RdeForceDecisionRequestTaskActionPayload:
      required:
        - rdeForceDecisionPayload
      type: object
      properties:
        payloadType:
          type: string
        rdeForceDecisionPayload:
          $ref: '#/components/schemas/RdeForceDecisionPayload'
    NonComplianceDetailsSubmitSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        nonComplianceDetails:
          $ref: '#/components/schemas/NonComplianceDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    Cca3ExistingFacilitiesMigrationAccountProcessingActivationRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        activationDetails:
          $ref: >-
            #/components/schemas/Cca3ExistingFacilitiesMigrationAccountProcessingActivationDetails
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        activationAttachments:
          type: object
          additionalProperties:
            type: string
    UnderlyingAgreementVariationApplySaveTargetUnitDetails:
      required:
        - operatorAddress
        - operatorName
        - responsiblePersonDetails
      type: object
      properties:
        operatorName:
          maxLength: 255
          minLength: 0
          type: string
        operatorAddress:
          $ref: '#/components/schemas/AccountAddressDTO'
        responsiblePersonDetails:
          $ref: '#/components/schemas/UnderlyingAgreementTargetUnitResponsiblePerson'
    PerformanceData:
      required:
        - buyOutCost
        - sector
        - submissionType
        - targetPeriod
        - targetType
        - templateVersion
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - TP6
        buyOutCost:
          type: integer
          format: int32
        targetPeriod:
          type: string
          enum:
            - TP6
        sector:
          type: string
        reportVersion:
          type: integer
          format: int32
        templateVersion:
          type: string
        reportDate:
          type: string
          format: date
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        targetType:
          type: string
          enum:
            - ABSOLUTE
            - RELATIVE
            - NOVEM
      discriminator:
        propertyName: type
    CarbonSurplusBuyOutDTO:
      type: object
      properties:
        co2Emissions:
          type: string
          format: decimal
        surplusUsed:
          type: string
          format: decimal
        surplusGained:
          type: string
          format: decimal
        priBuyOutCarbon:
          type: string
          format: decimal
        priBuyOutCost:
          type: string
          format: decimal
    PerformanceDataFacilityDigitalFormRequestCreateActionPayload:
      required:
        - reportType
        - targetPeriodType
      type: object
      properties:
        payloadType:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportType:
          type: string
          enum:
            - INTERIM
            - FINAL
    PeerReviewDecision:
      required:
        - notes
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - AGREE
            - DISAGREE
        notes:
          maxLength: 10000
          minLength: 0
          type: string
    FacilityPerformanceDataStatusInfoDTO:
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodName:
          type: string
        targetPeriodYear:
          type: integer
          format: int16
        variationIndicator:
          type: boolean
        locked:
          type: boolean
        reportVersion:
          type: integer
          format: int32
        submissionDate:
          type: string
          format: date
        lockEditable:
          type: boolean
        variationIndicatorEditable:
          type: boolean
    MoaReport:
      type: object
      properties:
        moaType:
          type: string
          enum:
            - SECTOR_MOA
            - TARGET_UNIT_MOA
        sectorAcronym:
          type: string
        sectorName:
          type: string
        businessId:
          type: string
        operatorName:
          type: string
        issueDate:
          type: string
          format: date
        succeeded:
          type: boolean
        errors:
          type: array
          items:
            type: string
    BuyOutSurplusRunCreateActionPayload:
      required:
        - targetPeriodType
      type: object
      properties:
        payloadType:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
    SurplusHistoryDTO:
      type: object
      properties:
        surplusGained:
          type: string
          format: decimal
        comments:
          type: string
        submitter:
          type: string
        submissionDate:
          type: string
          format: date-time
    AccountContactInfoDTO:
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        accountName:
          type: string
        userId:
          type: string
    NonComplianceDetailsSubmittedRequestActionPayload:
      required:
        - nonComplianceDetails
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        nonComplianceDetails:
          $ref: '#/components/schemas/NonComplianceDetails'
        allRelevantWorkflows:
          type: object
          additionalProperties:
            type: string
        allRelevantFacilities:
          type: object
          additionalProperties:
            type: string
    ItemSearchCriteriaDTO:
      type: object
      properties:
        orderBy:
          type: string
          enum:
            - NEWEST_FIRST
            - OLDEST_FIRST
            - NEAREST_DUE_DATE
        requestType:
          maxLength: 255
          minLength: 0
          type: string
        searchTerm:
          maxLength: 255
          minLength: 0
          type: string
    FacilityPerformanceAccountTemplateDataUpload:
      required:
        - files
        - targetYear
      type: object
      properties:
        targetYear:
          type: integer
          format: int16
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    NonComplianceNoticeOfIntent:
      required:
        - file
      type: object
      properties:
        file:
          type: string
          format: uuid
        comments:
          maxLength: 10000
          minLength: 0
          type: string
    FacilityCertificationDetailsDTO:
      type: object
      properties:
        status:
          type: string
          enum:
            - CERTIFIED
            - DECERTIFIED
            - NOT_YET_DEFINED
        startDate:
          type: string
          format: date
        certificationPeriod:
          type: string
          enum:
            - CP6
            - CP7
        certificationPeriodStartDate:
          type: string
          format: date
        certificationPeriodEndDate:
          type: string
          format: date
    UnderlyingAgreementVariationSaveReviewRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationReviewSavePayload'
        determination:
          $ref: '#/components/schemas/VariationDetermination'
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    ItemDTO:
      type: object
      properties:
        creationDate:
          type: string
          format: date-time
        requestId:
          type: string
        requestType:
          type: string
        taskId:
          type: integer
          format: int64
        taskAssignee:
          $ref: '#/components/schemas/UserInfoDTO'
        taskAssigneeType:
          type: string
        taskType:
          type: string
        daysRemaining:
          type: integer
          format: int64
        isNew:
          type: boolean
    FacilityPerformanceAccountTemplateProcessingRequestMetadata:
      type: object
      properties:
        type:
          type: string
        reportVersion:
          type: integer
          format: int32
        targetYear:
          type: integer
          format: int16
        submittedDate:
          type: string
          format: date
        uploadRequestId:
          type: string
    NonComplianceConclusionSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        nonComplianceConclusion:
          $ref: '#/components/schemas/NonComplianceConclusion'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    AccountSearchResultInfoDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        businessId:
          type: string
        status:
          type: string
    RdeRejectedRequestActionPayload:
      required:
        - reason
      type: object
      properties:
        payloadType:
          type: string
        decision:
          type: string
          enum:
            - ACCEPTED
            - REJECTED
        reason:
          type: string
    Cca3FacilityBaselineAndTargets:
      required:
        - baselineData
        - facilityBaselineEnergyConsumption
        - facilityTargets
        - targetComposition
      type: object
      properties:
        targetComposition:
          $ref: '#/components/schemas/FacilityTargetComposition'
        baselineData:
          $ref: '#/components/schemas/FacilityBaselineData'
        facilityBaselineEnergyConsumption:
          $ref: '#/components/schemas/FacilityBaselineEnergyConsumption'
        facilityTargets:
          $ref: '#/components/schemas/FacilityTargets'
    TargetPeriod5Details:
      required:
        - exist
      type: object
      properties:
        exist:
          type: boolean
        details:
          $ref: '#/components/schemas/TargetPeriod6Details'
    SubsectorAssociationDTO:
      required:
        - name
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 0
          type: string
    NonComplianceWithdrawNotice:
      required:
        - comments
        - file
      type: object
      properties:
        file:
          type: string
          format: uuid
        comments:
          maxLength: 10000
          minLength: 0
          type: string
    RequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
      discriminator:
        propertyName: payloadType
    SectorAssociationSiteContactDTO:
      type: object
      properties:
        sectorAssociationId:
          type: integer
          format: int64
        userId:
          type: string
    SectorAccountPerformanceDataReportItemDTO:
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        targetUnitAccountBusinessId:
          type: string
        operatorName:
          type: string
        submissionDate:
          type: string
          format: date-time
        reportVersion:
          type: integer
          format: int32
        performanceOutcome:
          type: string
          enum:
            - TARGET_MET
            - BUY_OUT_REQUIRED
            - SURPLUS_USED_BUY_OUT_REQUIRED
            - SURPLUS_USED
            - OUTSTANDING
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        locked:
          type: boolean
    PerformanceDataReportTypeDTO:
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportType:
          type: string
          enum:
            - INTERIM
            - FINAL
    BuyOutSurplusTransactionSummaryDTO:
      type: object
      properties:
        transactionCode:
          type: string
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - AWAITING_REFUND
            - PAID
            - REFUNDED
            - NOT_REQUIRED
            - UNDER_APPEAL
            - TERMINATED
        initialAmount:
          type: string
          format: decimal
        currentAmount:
          type: string
          format: decimal
    PerformanceDataDownloadSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        sectorAssociationInfo:
          $ref: '#/components/schemas/SectorAssociationInfo'
        targetPeriodType:
          type: string
          enum:
            - TP6
        zipFile:
          $ref: '#/components/schemas/FileInfoDTO'
        errorsFile:
          $ref: '#/components/schemas/FileInfoDTO'
        processCompleted:
          type: boolean
        errorMessage:
          type: string
    AccountPerformanceDataStatusInfoDTO:
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodName:
          type: string
        locked:
          type: boolean
        reportVersion:
          type: integer
          format: int32
        editable:
          type: boolean
    AccountPerformanceAccountTemplateDataReportInfoDTO:
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodName:
          type: string
        targetPeriodYear:
          type: integer
          format: int16
    PerformanceDataTargetUnitDetails:
      required:
        - bankedSurplus
        - byEnergyCarbon
        - byStartDate
        - energyCarbonUnit
        - numOfFacilities
        - operatorName
        - percentTarget
        - tuIdentifier
      type: object
      properties:
        tuIdentifier:
          type: string
        operatorName:
          type: string
        numOfFacilities:
          type: integer
          format: int32
        energyCarbonUnit:
          type: string
          enum:
            - ENERGY_KWH
            - ENERGY_MWH
            - ENERGY_GJ
            - CARBON_KG
            - CARBON_TONNE
        throughputUnit:
          type: string
        byStartDate:
          type: string
          format: date
        byEnergyCarbon:
          type: string
          format: decimal
        byThroughput:
          type: string
          format: decimal
        byPerformance:
          type: string
          format: decimal
        numericalTarget:
          type: string
          format: decimal
        tolerance:
          type: string
          format: decimal
        percentTarget:
          type: string
          format: decimal
        tolerancePercentage:
          type: string
          format: decimal
        bankedSurplus:
          type: string
          format: decimal
    RdeSubmittedRequestActionPayload:
      required:
        - officialDocument
        - rdePayload
      type: object
      properties:
        payloadType:
          type: string
        rdePayload:
          $ref: '#/components/schemas/RdePayload'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialDocument:
          $ref: '#/components/schemas/FileInfoDTO'
    TargetPeriodYearsContainer:
      required:
        - targetPeriodYears
      type: object
      properties:
        targetPeriodYears:
          type: array
          items:
            $ref: '#/components/schemas/TargetPeriodYear'
    PerformanceAccountTemplateDataUpload:
      required:
        - reportPackages
        - targetPeriodType
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportPackages:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    NonComplianceEnforcementResponseNoticeSubmittedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - enforcementResponseNotice
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        enforcementResponseNotice:
          $ref: '#/components/schemas/NonComplianceEnforcementResponseNotice'
        decisionNotification:
          $ref: '#/components/schemas/DecisionNotification'
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
    UpdateFacilitySchemeExitDateDTO:
      type: object
      properties:
        schemeExitDate:
          type: string
          format: date
      description: The updated scheme exit date
    SectorAssociationSchemeDTO:
      required:
        - id
        - schemeVersion
        - umbrellaAgreement
      type: object
      properties:
        id:
          type: integer
          format: int64
        umbrellaAgreement:
          $ref: '#/components/schemas/SectorAssociationSchemeDocumentDTO'
        targetSet:
          $ref: '#/components/schemas/TargetSetDTO'
        umaDate:
          type: string
          format: date
        sectorDefinition:
          type: string
        schemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        editable:
          type: boolean
    PerformanceDataFacilityDataUploadSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        sectorAssociationInfo:
          $ref: '#/components/schemas/SectorAssociationInfo'
        performanceDataUpload:
          $ref: '#/components/schemas/PerformanceDataFacilityUpload'
        processingStatus:
          type: string
          enum:
            - NOT_STARTED_YET
            - IN_PROGRESS
            - COMPLETED
        results:
          $ref: '#/components/schemas/PerformanceDataFacilityUploadResults'
        errorMessage:
          type: string
          enum:
            - SUBMISSION_RESULTS_CSV_FAILED
            - MESSAGE_PROCESSING_FAILED
        facilityReports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FacilityUploadReport'
        csvRowErrors:
          type: array
          items:
            $ref: '#/components/schemas/PerformanceDataFacilityCsvErrorEntry'
        uploadAttachments:
          type: object
          additionalProperties:
            type: string
    RdeForceDecisionPayload:
      required:
        - decision
        - evidence
      type: object
      properties:
        decision:
          type: string
          enum:
            - ACCEPTED
            - REJECTED
        evidence:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    UnderlyingAgreementActivationRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        underlyingAgreementActivationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementActivationDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementActivationAttachments:
          type: object
          additionalProperties:
            type: string
    AdminTerminationPeerReviewRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        adminTerminationReasonDetails:
          $ref: '#/components/schemas/AdminTerminationReasonDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        adminTerminationAttachments:
          type: object
          additionalProperties:
            type: string
        decision:
          $ref: '#/components/schemas/CcaPeerReviewDecision'
        peerReviewAttachments:
          type: object
          additionalProperties:
            type: string
    UnderlyingAgreementVariationSubmittedRequestActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
    RdeResponseRequestTaskPayload:
      required:
        - rdeResponsePayload
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        rdeResponsePayload:
          $ref: '#/components/schemas/RdeResponsePayload'
    UnderlyingAgreementVariationApplySavePayload:
      required:
        - authorisationAndAdditionalEvidence
        - facilities
        - underlyingAgreementTargetUnitDetails
        - underlyingAgreementVariationDetails
      type: object
      properties:
        underlyingAgreementTargetUnitDetails:
          $ref: >-
            #/components/schemas/UnderlyingAgreementVariationApplySaveTargetUnitDetails
        underlyingAgreementVariationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementVariationDetails'
        facilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Facility'
        targetPeriod5Details:
          $ref: '#/components/schemas/TargetPeriod5Details'
        targetPeriod6Details:
          $ref: '#/components/schemas/TargetPeriod6Details'
        authorisationAndAdditionalEvidence:
          $ref: '#/components/schemas/AuthorisationAndAdditionalEvidence'
    Cca3ExistingFacilitiesMigrationAccountProcessingSubmittedRequestActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        facilityMigrationDataList:
          type: array
          items:
            $ref: '#/components/schemas/Cca3FacilityMigrationData'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
        underlyingAgreementDocument:
          $ref: '#/components/schemas/FileInfoDTO'
    FacilityPerformanceAccountTemplateDataUploadRequestMetadata:
      type: object
      properties:
        type:
          type: string
        targetYear:
          type: integer
          format: int16
        submittedDate:
          type: string
          format: date-time
    PerformanceDataFacilityDigitalFormSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        energyFuelDetails:
          $ref: '#/components/schemas/PerformanceDataFacilityInputEnergyFuelDetails'
        throughputDetails:
          $ref: '#/components/schemas/PerformanceDataFacilityThroughputDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    AccountOperatorAuthorityUpdateDTO:
      required:
        - authorityStatus
        - userId
      type: object
      properties:
        userId:
          type: string
        roleCode:
          type: string
        authorityStatus:
          type: string
          enum:
            - PENDING
            - TEMP_DISABLED_PENDING
            - ACTIVE
            - DISABLED
            - ACCEPTED
            - TEMP_DISABLED
    MiReportUserDefinedResults:
      type: object
      properties:
        queries:
          type: array
          items:
            $ref: '#/components/schemas/MiReportUserDefinedInfoDTO'
        total:
          type: integer
          format: int64
    AuditReasonDetails:
      required:
        - comment
        - reasonsForAudit
      type: object
      properties:
        reasonsForAudit:
          type: array
          items:
            type: string
            enum:
              - ELIGIBILITY
              - SEVENTY_RULE_EVALUATION
              - BASE_YEAR_DATA
              - REPORTING_DATA
              - NON_COMPLIANCE
              - OTHER
        comment:
          maxLength: 10000
          minLength: 0
          type: string
    BankAccountDetailsDTO:
      type: object
      properties:
        sortCode:
          type: string
        accountNumber:
          type: string
        accountName:
          type: string
        iban:
          type: string
        swiftCode:
          type: string
    AssigneeUserInfoDTO:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
    SubsistenceFeesMoaFacilityMarkingStatusHistoryDTO:
      type: object
      properties:
        submitter:
          type: string
        submissionDate:
          type: string
          format: date-time
        paymentStatus:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - CANCELLED
    RequestTaskAssignmentDTO:
      required:
        - taskId
        - userId
      type: object
      properties:
        taskId:
          type: integer
          format: int64
        userId:
          type: string
      description: The request task assignment body
    SectorAssociationContactDTO:
      required:
        - address
        - email
        - firstName
        - lastName
      type: object
      properties:
        title:
          maxLength: 20
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        organisationName:
          maxLength: 255
          minLength: 0
          type: string
        address:
          $ref: '#/components/schemas/AddressDTO'
        phoneNumber:
          maxLength: 255
          minLength: 0
          type: string
        email:
          maxLength: 255
          minLength: 0
          type: string
        fullName:
          type: string
    RequestCreateValidationResult:
      type: object
      properties:
        valid:
          type: boolean
        accountStatus:
          type: string
        applicableAccountStatuses:
          uniqueItems: true
          type: array
          items:
            type: string
        requests:
          uniqueItems: true
          type: array
          items:
            type: string
    UnderlyingAgreementActivationDetails:
      required:
        - evidenceFiles
      type: object
      properties:
        evidenceFiles:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        comments:
          maxLength: 10000
          minLength: 0
          type: string
    SubsistenceFeesMoaSearchResultInfoDTO:
      type: object
      properties:
        moaId:
          type: integer
          format: int64
        transactionId:
          type: string
        businessId:
          type: string
        name:
          type: string
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - PAID
            - CANCELLED
            - OVERPAID
        markFacilitiesStatus:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - CANCELLED
        currentTotalAmount:
          type: string
          format: decimal
        outstandingTotalAmount:
          type: string
          format: decimal
        submissionDate:
          type: string
          format: date-time
    RfiSubmitRequestTaskActionPayload:
      required:
        - rfiSubmitPayload
      type: object
      properties:
        payloadType:
          type: string
        rfiSubmitPayload:
          $ref: '#/components/schemas/RfiSubmitPayload'
    UnderlyingAgreementSaveReviewRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        determination:
          $ref: '#/components/schemas/Determination'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementApplySavePayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    UnderlyingAgreementPayload:
      required:
        - authorisationAndAdditionalEvidence
        - underlyingAgreementTargetUnitDetails
      type: object
      properties:
        underlyingAgreementTargetUnitDetails:
          $ref: '#/components/schemas/UnderlyingAgreementTargetUnitDetails'
        facilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Facility'
        targetPeriod5Details:
          $ref: '#/components/schemas/TargetPeriod5Details'
        targetPeriod6Details:
          $ref: '#/components/schemas/TargetPeriod6Details'
        authorisationAndAdditionalEvidence:
          $ref: '#/components/schemas/AuthorisationAndAdditionalEvidence'
    AdminTerminationSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        adminTerminationReasonDetails:
          $ref: '#/components/schemas/AdminTerminationReasonDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        adminTerminationAttachments:
          type: object
          additionalProperties:
            type: string
    VariationDetermination:
      required:
        - type
      type: object
      properties:
        variationImpactsAgreement:
          type: boolean
        type:
          type: string
          enum:
            - ACCEPTED
            - REJECTED
        reason:
          maxLength: 10000
          minLength: 0
          type: string
        additionalInformation:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    UserBasicInfoDTO:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
    FileReports:
      type: object
      properties:
        accountFileReports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AccountUploadReport'
        notAccountRelatedFileErrors:
          type: array
          items:
            $ref: '#/components/schemas/NotAccountRelatedUploadErrorReport'
        numberOfFilesFailed:
          type: integer
          format: int32
          readOnly: true
        numberOfFilesSucceeded:
          type: integer
          format: int32
          readOnly: true
    AuditTrackCorrectiveActionsSaveRequestTaskActionPayload:
      required:
        - actionTitle
      type: object
      properties:
        payloadType:
          type: string
        actionTitle:
          type: string
        correctiveActionFollowUpResponse:
          $ref: '#/components/schemas/CorrectiveActionFollowUpResponse'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    UnderlyingAgreementReviewDecision:
      required:
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - ACCEPTED
            - REJECTED
        details:
          $ref: '#/components/schemas/UnderlyingAgreementReviewDecisionDetails'
    SectorInvitedUserInfoDTO:
      type: object
      properties:
        email:
          type: string
        invitationStatus:
          type: string
          enum:
            - ACCEPTED
            - PENDING_TO_REGISTERED_SET_REGISTER_FORM
            - PENDING_TO_REGISTERED_SET_REGISTER_FORM_NO_PASSWORD
            - PENDING_TO_REGISTERED_SET_PASSWORD_ONLY
            - ALREADY_REGISTERED
            - ALREADY_REGISTERED_SET_PASSWORD_ONLY
        firstName:
          type: string
        lastName:
          type: string
        roleCode:
          type: string
        contactType:
          type: string
          enum:
            - SECTOR_ASSOCIATION
            - OPERATOR
            - CONSULTANT
        sectorAssociationId:
          type: integer
          format: int64
        sector:
          type: string
    BuyOutSurplusDetails:
      required:
        - performanceDataReportVersion
        - runId
        - submissionType
        - targetPeriodType
        - tpOutcome
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        performanceDataReportVersion:
          type: integer
          format: int32
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        tpOutcome:
          type: string
          enum:
            - TARGET_MET
            - BUY_OUT_REQUIRED
            - SURPLUS_USED_BUY_OUT_REQUIRED
            - SURPLUS_USED
            - OUTSTANDING
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - AWAITING_REFUND
            - PAID
            - REFUNDED
            - NOT_REQUIRED
            - UNDER_APPEAL
            - TERMINATED
        transactionCode:
          type: string
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
        dueDate:
          type: string
          format: date
        runId:
          type: string
    VerifierUserDTO:
      required:
        - email
        - firstName
        - lastName
        - phoneNumber
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          maxLength: 255
          minLength: 0
          type: string
        mobileNumber:
          maxLength: 255
          minLength: 0
          type: string
    SectorAccountPerformanceDataReportListDTO:
      type: object
      properties:
        performanceDataReportItems:
          type: array
          items:
            $ref: '#/components/schemas/SectorAccountPerformanceDataReportItemDTO'
        total:
          type: integer
          format: int64
    UnderlyingAgreementFacilityReviewDecision:
      required:
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - ACCEPTED
            - REJECTED
        details:
          $ref: '#/components/schemas/UnderlyingAgreementReviewDecisionDetails'
        changeStartDate:
          type: boolean
        startDate:
          type: string
          format: date
    CorrectiveActions:
      required:
        - hasActions
      type: object
      properties:
        hasActions:
          type: boolean
        actions:
          maxItems: 10
          minItems: 0
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CorrectiveAction'
    PerformanceDataFacilityEnergyFuelDetails:
      required:
        - atLeastSeventyPercentEnergyUsed
      type: object
      properties:
        fuels:
          type: array
          items:
            $ref: '#/components/schemas/PerformanceDataFacilityFuel'
        atLeastSeventyPercentEnergyUsed:
          type: boolean
        electricitySuppliedFromCHP:
          type: string
          format: decimal
        throughputAdjustmentFactor:
          type: string
          format: decimal
    RegulatorCurrentUserDTO:
      required:
        - email
        - firstName
        - jobTitle
        - lastName
        - phoneNumber
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          maxLength: 255
          minLength: 0
          type: string
        mobileNumber:
          maxLength: 255
          minLength: 0
          type: string
        signature:
          $ref: '#/components/schemas/FileInfoDTO'
        competentAuthority:
          type: string
          enum:
            - ENGLAND
            - NORTHERN_IRELAND
            - OPRED
            - SCOTLAND
            - WALES
    RfiResponseSubmitRequestTaskPayload:
      required:
        - rfiQuestionPayload
        - rfiResponsePayload
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        rfiQuestionPayload:
          $ref: '#/components/schemas/RfiQuestionPayload'
        rfiResponsePayload:
          $ref: '#/components/schemas/RfiResponsePayload'
        rfiAttachments:
          type: object
          additionalProperties:
            type: string
    Cca3ExistingFacilitiesMigrationAccountProcessingActivationSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        activationDetails:
          $ref: >-
            #/components/schemas/Cca3ExistingFacilitiesMigrationAccountProcessingActivationDetails
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    BuyOutSurplusTransactionsListDTO:
      type: object
      properties:
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/BuyOutSurplusTransactionListItemDTO'
        total:
          type: integer
          format: int64
    UnderlyingAgreementSaveFacilityReviewGroupDecisionRequestTaskActionPayload:
      required:
        - decision
        - group
      type: object
      properties:
        payloadType:
          type: string
        determination:
          $ref: '#/components/schemas/Determination'
        group:
          type: string
        decision:
          $ref: '#/components/schemas/UnderlyingAgreementFacilityReviewDecision'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    SectorAccountPerformanceDataReportSearchCriteria:
      required:
        - pageNumber
        - pageSize
        - targetPeriodType
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        targetUnitAccountBusinessId:
          maxLength: 255
          minLength: 3
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        performanceOutcome:
          type: string
          enum:
            - TARGET_MET
            - BUY_OUT_REQUIRED
            - SURPLUS_USED_BUY_OUT_REQUIRED
            - SURPLUS_USED
            - OUTSTANDING
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        pageNumber:
          minimum: 0
          type: integer
          format: int32
        pageSize:
          minimum: 1
          type: integer
          format: int32
      description: The search criteria
    InvitedUserInfoDTO:
      type: object
      properties:
        email:
          type: string
        invitationStatus:
          type: string
          enum:
            - ACCEPTED
            - PENDING_TO_REGISTERED_SET_REGISTER_FORM
            - PENDING_TO_REGISTERED_SET_REGISTER_FORM_NO_PASSWORD
            - PENDING_TO_REGISTERED_SET_PASSWORD_ONLY
            - ALREADY_REGISTERED
            - ALREADY_REGISTERED_SET_PASSWORD_ONLY
    AdminTerminationReasonDetails:
      required:
        - explanation
        - reason
      type: object
      properties:
        reason:
          type: string
          enum:
            - SITE_CLOSURE_SCHEME
            - NOT_SIGN_AGREEMENT
            - TRANSFER_OF_OWNERSHIP
            - DATA_NOT_PROVIDED
            - FAILURE_TO_COMPLY
            - FAILURE_TO_AGREE
            - FAILURE_TO_PAY
        explanation:
          maxLength: 10000
          minLength: 0
          type: string
        relevantFiles:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    PasswordValidationErrorDTO:
      type: object
      properties:
        code:
          type: string
          enum:
            - INVALID_MIN_LENGTH
            - INVALID_MAX_LENGTH
            - BLACKLISTED_PATTERN
            - PWNED
            - PWNED_SERVICE_UNAVAILABLE
            - OTHER
        message:
          type: string
    UnderlyingAgreementDocumentDetailsDTO:
      type: object
      properties:
        activationDate:
          type: string
          format: date
        terminatedDate:
          type: string
          format: date
        fileDocument:
          $ref: '#/components/schemas/FileInfoDTO'
    PerformanceDataFacilityUpload:
      required:
        - files
        - reportType
        - targetPeriodType
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportType:
          type: string
          enum:
            - INTERIM
            - FINAL
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    FacilityUploadReport:
      type: object
      properties:
        facilityId:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        accountId:
          type: integer
          format: int64
        csvFileName:
          type: string
        csvData:
          $ref: '#/components/schemas/PerformanceDataFacilityUploadCsvData'
        succeeded:
          type: boolean
        errors:
          type: array
          items:
            type: string
    RequestInfoDTO:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        resourceType:
          type: string
        requestMetadata:
          $ref: '#/components/schemas/RequestMetadata'
        paymentCompleted:
          type: boolean
        paymentAmount:
          type: string
          format: decimal
        creationDate:
          type: string
          format: date-time
        resources:
          type: object
          additionalProperties:
            type: string
    AuditDetails:
      required:
        - auditDate
        - auditDocuments
        - auditTechnique
        - comments
        - finalAuditReportDate
      type: object
      properties:
        auditTechnique:
          type: string
          enum:
            - DESK_BASED_INTERVIEW
            - ON_SITE_VISIT
        auditDate:
          type: string
          format: date
        comments:
          maxLength: 10000
          minLength: 0
          type: string
        finalAuditReportDate:
          type: string
          format: date
        auditDocuments:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    MiReportSystemSearchResult:
      type: object
      properties:
        id:
          type: integer
          format: int32
        miReportType:
          type: string
    TargetUnitAccountDetails:
      type: object
      properties:
        operatorName:
          type: string
        operatorType:
          type: string
          enum:
            - LIMITED_COMPANY
            - PARTNERSHIP
            - SOLE_TRADER
            - NONE
        companyRegistrationNumber:
          type: string
        registrationNumberMissingReason:
          type: string
        address:
          $ref: '#/components/schemas/AccountAddressDTO'
        responsiblePerson:
          $ref: '#/components/schemas/TargetUnitAccountContactDTO'
        administrativeContactDetails:
          $ref: '#/components/schemas/TargetUnitAccountContactDTO'
        sectorAssociationId:
          type: integer
          format: int64
        subsectorAssociationId:
          type: integer
          format: int64
    UnderlyingAgreementVariationSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        workflowSchemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        originalUnderlyingAgreementContainer:
          $ref: '#/components/schemas/UnderlyingAgreementContainer'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
    FileUuidDTO:
      type: object
      properties:
        uuid:
          type: string
    CcaOperatorUserInvitationDTO:
      required:
        - email
        - firstName
        - lastName
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        roleCode:
          type: string
        contactType:
          type: string
          enum:
            - SECTOR_ASSOCIATION
            - OPERATOR
            - CONSULTANT
      description: The operator user account registration info
    BuyOutCalculatedDetails:
      required:
        - buyOutFee
        - previousPaidFees
        - priBuyOutCarbon
        - priBuyOutCost
      type: object
      properties:
        priBuyOutCarbon:
          type: string
          format: decimal
        priBuyOutCost:
          type: string
          format: decimal
        previousPaidFees:
          type: string
          format: decimal
        buyOutFee:
          type: string
          format: decimal
    NonComplianceEnforcementResponseNotice:
      required:
        - file
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - PENALTY
            - PENALTY_WAIVER
        file:
          type: string
          format: uuid
        comments:
          maxLength: 10000
          minLength: 0
          type: string
    SectorFacilityPerformanceDataReportSearchCriteria:
      required:
        - pageNumber
        - pageSize
        - targetPeriodReportType
        - targetPeriodType
      type: object
      properties:
        facilityOrTargetUnitAccountBusinessId:
          maxLength: 255
          minLength: 3
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodReportType:
          type: string
          enum:
            - INTERIM
            - FINAL
        reportStatus:
          type: string
          enum:
            - TARGET_MET
            - TARGET_NOT_MET
            - SUBMITTED
            - OUTSTANDING
        subType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        pageNumber:
          minimum: 0
          type: integer
          format: int32
        pageSize:
          minimum: 1
          type: integer
          format: int32
      description: The search criteria
    AdminTerminationWithdrawRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        adminTerminationWithdrawReasonDetails:
          $ref: '#/components/schemas/AdminTerminationWithdrawReasonDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        adminTerminationAttachments:
          type: object
          additionalProperties:
            type: string
    UnderlyingAgreementVariationAcceptedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - determination
        - officialNotices
        - underlyingAgreementDocuments
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialNotices:
          type: array
          items:
            $ref: '#/components/schemas/FileInfoDTO'
        determination:
          $ref: '#/components/schemas/VariationDetermination'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementDocuments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FileInfoDTO'
    BuyOutSurplusTransactionListItemDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        accountBusinessId:
          type: string
        operatorName:
          type: string
        transactionCode:
          type: string
        creationDate:
          type: string
          format: date-time
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - AWAITING_REFUND
            - PAID
            - REFUNDED
            - NOT_REQUIRED
            - UNDER_APPEAL
            - TERMINATED
        buyOutFee:
          type: string
          format: decimal
    AdditionalNoticeRecipientDTO:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        type:
          type: string
          enum:
            - RESPONSIBLE_PERSON
            - ADMINISTRATIVE_CONTACT
            - SECTOR_CONTACT
            - SECTOR_USER
            - SECTOR_CONSULTANT
            - OPERATOR
        userId:
          type: string
    SubsistenceFeesMoaReceivedAmountInfoDTO:
      type: object
      properties:
        transactionId:
          type: string
        businessId:
          type: string
        name:
          type: string
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - PAID
            - CANCELLED
            - OVERPAID
        currentTotalAmount:
          type: string
          format: decimal
        receivedAmount:
          type: string
          format: decimal
        receivedAmountHistoryList:
          type: array
          items:
            $ref: '#/components/schemas/SubsistenceFeesMoaReceivedAmountHistoryDTO'
    UnderlyingAgreementVariationRejectedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - determination
        - officialNotices
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialNotices:
          type: array
          items:
            $ref: '#/components/schemas/FileInfoDTO'
        determination:
          $ref: '#/components/schemas/VariationDetermination'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
    OperatorAuthoritiesInfoDTO:
      type: object
      properties:
        authorities:
          type: array
          items:
            $ref: '#/components/schemas/OperatorAuthorityInfoDTO'
        editable:
          type: boolean
    SubsistenceFeesMoaDetailsDTO:
      type: object
      properties:
        moaId:
          type: integer
          format: int64
        transactionId:
          type: string
        businessId:
          type: string
        name:
          type: string
        moaDocument:
          $ref: '#/components/schemas/FileInfoDTO'
        submissionDate:
          type: string
          format: date-time
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - PAID
            - CANCELLED
            - OVERPAID
        totalFacilities:
          type: integer
          format: int64
        paidFacilities:
          type: integer
          format: int64
        initialTotalAmount:
          type: string
          format: decimal
        currentTotalAmount:
          type: string
          format: decimal
        receivedAmount:
          type: string
          format: decimal
        facilityFee:
          type: string
          format: decimal
        moaTargetUnitId:
          type: integer
          format: int64
    SectorAssociationDetailsResponseDTO:
      required:
        - acronym
        - commonName
        - competentAuthority
        - energyIntensiveOrEPR
        - legalName
        - noticeServiceAddress
      type: object
      properties:
        competentAuthority:
          type: string
          enum:
            - ENGLAND
            - NORTHERN_IRELAND
            - OPRED
            - SCOTLAND
            - WALES
        commonName:
          maxLength: 255
          minLength: 0
          type: string
        acronym:
          maxLength: 255
          minLength: 0
          type: string
        legalName:
          maxLength: 255
          minLength: 0
          type: string
        facilitator:
          $ref: '#/components/schemas/UserBasicInfoDTO'
        noticeServiceAddress:
          $ref: '#/components/schemas/AddressDTO'
        energyIntensiveOrEPR:
          maxLength: 255
          minLength: 0
          type: string
    FileInfoDTO:
      type: object
      properties:
        name:
          type: string
        uuid:
          type: string
    NonComplianceEnforcementResponseNoticeSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        enforcementResponseNotice:
          $ref: '#/components/schemas/NonComplianceEnforcementResponseNotice'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    PerformanceDataFacilityFuelEnergyConsumption:
      required:
        - deliveredEnergy
        - primaryEnergy
      type: object
      properties:
        deliveredEnergy:
          type: string
          format: decimal
        primaryEnergy:
          type: string
          format: decimal
    PerformanceDataFacilityDataUploadProcessingRequestTaskActionPayload:
      required:
        - performanceDataUpload
      type: object
      properties:
        payloadType:
          type: string
        performanceDataUpload:
          $ref: '#/components/schemas/PerformanceDataFacilityUpload'
    RdeResponsePayload:
      required:
        - currentDueDate
        - proposedDueDate
      type: object
      properties:
        currentDueDate:
          type: string
          format: date
        proposedDueDate:
          type: string
          format: date
    FacilityTargetComposition:
      required:
        - agreementCompositionType
        - calculatorFile
        - measurementType
      type: object
      properties:
        calculatorFile:
          type: string
          format: uuid
        measurementType:
          type: string
          enum:
            - ENERGY_KWH
            - ENERGY_MWH
            - ENERGY_GJ
            - CARBON_KG
            - CARBON_TONNE
        agreementCompositionType:
          type: string
          enum:
            - ABSOLUTE
            - RELATIVE
            - NOVEM
    AccountNoteRequest:
      required:
        - accountId
        - note
      type: object
      properties:
        note:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        accountId:
          type: integer
          format: int64
      description: The account note request
    RdeDecisionPayload:
      required:
        - decision
      type: object
      properties:
        decision:
          type: string
          enum:
            - ACCEPTED
            - REJECTED
        reason:
          maxLength: 10000
          minLength: 0
          type: string
    FacilityAuditUpdateDTO:
      required:
        - auditRequired
      type: object
      properties:
        auditRequired:
          type: boolean
        reasons:
          type: array
          items:
            type: string
            enum:
              - ELIGIBILITY
              - SEVENTY_RULE_EVALUATION
              - BASE_YEAR_DATA
              - REPORTING_DATA
              - NON_COMPLIANCE
              - OTHER
        comments:
          maxLength: 10000
          minLength: 0
          type: string
    NotePayload:
      required:
        - note
      type: object
      properties:
        note:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          type: object
          additionalProperties:
            type: string
    PhoneNumberDTO:
      type: object
      properties:
        countryCode:
          type: string
        number:
          maxLength: 255
          minLength: 0
          type: string
    AccountBuyOutSurplusInfoDTO:
      type: object
      properties:
        excluded:
          type: boolean
        surplusGainedDTOList:
          type: array
          items:
            $ref: '#/components/schemas/SurplusGainedDTO'
    NonComplianceDetailsSubmitRequestTaskPayload:
      required:
        - nonComplianceDetails
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        nonComplianceDetails:
          $ref: '#/components/schemas/NonComplianceDetails'
        allRelevantWorkflows:
          type: object
          additionalProperties:
            type: string
        allRelevantFacilities:
          type: object
          additionalProperties:
            type: string
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    TP6SurplusCalculatedAccountProcessingSubmittedRequestActionPayload:
      required:
        - details
        - surplusCalculatedDetails
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        details:
          $ref: '#/components/schemas/BuyOutSurplusDetails'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        surplusCalculatedDetails:
          $ref: '#/components/schemas/SurplusCalculatedDetails'
    PreAuditReviewSubmitRequestTaskPayload:
      required:
        - preAuditReviewDetails
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        preAuditReviewDetails:
          $ref: '#/components/schemas/PreAuditReviewDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        facilityAuditAttachments:
          type: object
          additionalProperties:
            type: string
    AccountContactInfoResponse:
      type: object
      properties:
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/AccountContactInfoDTO'
        editable:
          type: boolean
        totalItems:
          type: integer
          format: int64
    CcaPeerReviewDecision:
      required:
        - notes
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - AGREE
            - DISAGREE
        notes:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    RequestTaskAttachmentActionProcessDTO:
      required:
        - requestTaskActionType
        - requestTaskId
      type: object
      properties:
        requestTaskId:
          type: integer
          format: int64
        requestTaskActionType:
          type: string
      description: The request task attachment properties
    NonComplianceEnforcementResponseNoticeSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        enforcementResponseNotice:
          $ref: '#/components/schemas/NonComplianceEnforcementResponseNotice'
        closeJustification:
          $ref: '#/components/schemas/NonComplianceCloseJustification'
        penaltyReissue:
          type: boolean
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
    PerformanceDataFacilityDigitalFormRequestMetadata:
      type: object
      properties:
        type:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportType:
          type: string
          enum:
            - INTERIM
            - FINAL
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        reportVersion:
          type: integer
          format: int32
        submittedDate:
          type: string
          format: date
    UnderlyingAgreementAcceptedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - determination
        - officialNotice
        - underlyingAgreement
        - underlyingAgreementDocuments
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
        determination:
          $ref: '#/components/schemas/Determination'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementFacilityReviewDecision'
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementDocuments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FileInfoDTO'
    EligibilityDetailsAndAuthorisation:
      required:
        - agreementType
        - isConnectedToExistingFacility
      type: object
      properties:
        isConnectedToExistingFacility:
          type: boolean
        adjacentFacilityId:
          maxLength: 255
          minLength: 0
          pattern: ^[A-Z0-9_]+-F\d{5}$
          type: string
        agreementType:
          type: string
          enum:
            - ENVIRONMENTAL_PERMITTING_REGULATIONS
            - ENERGY_INTENSIVE
        erpAuthorisationExists:
          type: boolean
        authorisationNumber:
          maxLength: 255
          minLength: 0
          type: string
        regulatorName:
          type: string
          enum:
            - ENVIRONMENT_AGENCY
            - SCOTTISH_ENVIRONMENT_PROTECTION_AGENCY
            - DEPARTMENT_OF_AGRICULTURE_ENVIRONMENT_AND_RURAL_AFFAIRS
            - NATURAL_RESOURCES_WALES
            - OTHER
        permitFile:
          type: string
          format: uuid
    NotificationTemplateViewDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        subject:
          type: string
        text:
          type: string
        eventTrigger:
          type: string
        workflow:
          type: string
        lastUpdatedDate:
          type: string
          format: date-time
        documentTemplates:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/DocumentTemplateInfoDTO'
    NonComplianceNoticeOfIntentSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        noticeOfIntent:
          $ref: '#/components/schemas/NonComplianceNoticeOfIntent'
        closeJustification:
          $ref: '#/components/schemas/NonComplianceCloseJustification'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
    SurplusCalculatedDetails:
      required:
        - overPaymentFee
        - previousPaidFees
        - surplusGained
      type: object
      properties:
        surplusGained:
          type: string
          format: decimal
        previousPaidFees:
          type: string
          format: decimal
        overPaymentFee:
          type: string
          format: decimal
    PaymentMakeRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        amount:
          type: string
          format: decimal
        paymentRefNum:
          type: string
        creationDate:
          type: string
          format: date
        paymentMethodTypes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - BANK_TRANSFER
              - CREDIT_OR_DEBIT_CARD
        bankAccountDetails:
          $ref: '#/components/schemas/BankAccountDetailsDTO'
        externalPaymentId:
          type: string
    PreAuditReviewSubmitSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        preAuditReviewDetails:
          $ref: '#/components/schemas/PreAuditReviewDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    TargetUnitAccountInfoResponseDTO:
      type: object
      properties:
        accountsWithSiteContact:
          type: array
          items:
            $ref: '#/components/schemas/TargetUnitAccountInfoDTO'
        editable:
          type: boolean
        totalItems:
          type: integer
          format: int64
    FileToken:
      type: object
      properties:
        token:
          type: string
        tokenExpirationMinutes:
          type: integer
          format: int64
    SectorAssociationResponseDTO:
      required:
        - sectorAssociationContact
        - sectorAssociationDetails
      type: object
      properties:
        sectorAssociationContact:
          $ref: '#/components/schemas/SectorAssociationContactDTO'
        sectorAssociationDetails:
          $ref: '#/components/schemas/SectorAssociationDetailsResponseDTO'
        editable:
          type: boolean
    BuyOutSurplusTransactionUpdatePaymentStatusDTO:
      required:
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - AWAITING_PAYMENT
            - AWAITING_REFUND
            - PAID
            - REFUNDED
            - NOT_REQUIRED
            - UNDER_APPEAL
            - TERMINATED
        comments:
          maxLength: 10000
          minLength: 0
          type: string
        evidenceFiles:
          type: object
          additionalProperties:
            type: string
        paymentDate:
          type: string
          format: date
      description: The Transaction Update Payment Status Info
    BuyOutSurplusRunRequestMetadata:
      type: object
      properties:
        type:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        totalAccounts:
          type: integer
          format: int64
        failedAccounts:
          type: integer
          format: int64
    UnderlyingAgreementVariationRegulatorLedSubmittedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - determination
        - officialNotices
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        facilityChargeStartDateMap:
          type: object
          additionalProperties:
            type: string
            format: date
        determination:
          $ref: '#/components/schemas/VariationRegulatorLedDetermination'
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        underlyingAgreementDocuments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FileInfoDTO'
        officialNotices:
          type: array
          items:
            $ref: '#/components/schemas/FileInfoDTO'
        regulatorLedSubmitAttachments:
          type: object
          additionalProperties:
            type: string
    FacilityPerformanceAccountTemplateUploadReport:
      type: object
      properties:
        facilityId:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        accountId:
          type: integer
          format: int64
        succeeded:
          type: boolean
        errors:
          type: array
          items:
            type: string
    UnderlyingAgreementVariationActivationRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        underlyingAgreementActivationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementActivationDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementActivationAttachments:
          type: object
          additionalProperties:
            type: string
    AdminTerminationFinalDecisionSubmittedRequestActionPayload:
      required:
        - adminTerminationFinalDecisionReasonDetails
        - decisionNotification
        - defaultContacts
        - officialNotice
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        adminTerminationFinalDecisionReasonDetails:
          $ref: '#/components/schemas/AdminTerminationFinalDecisionReasonDetails'
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        adminTerminationFinalDecisionAttachments:
          type: object
          additionalProperties:
            type: string
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
    UnderlyingAgreementVariationRegulatorLedCompletedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - determination
        - officialNotices
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        facilityChargeStartDateMap:
          type: object
          additionalProperties:
            type: string
            format: date
        determination:
          $ref: '#/components/schemas/VariationRegulatorLedDetermination'
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        underlyingAgreementDocuments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FileInfoDTO'
        officialNotices:
          type: array
          items:
            $ref: '#/components/schemas/FileInfoDTO'
        regulatorLedSubmitAttachments:
          type: object
          additionalProperties:
            type: string
    FacilityBaselineData:
      required:
        - baselineDate
        - energyCarbonFactor
        - isTwelveMonths
        - usedReportingMechanism
      type: object
      properties:
        isTwelveMonths:
          type: boolean
        baselineDate:
          type: string
          format: date
        explanation:
          type: string
        greenfieldEvidences:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        energy:
          type: string
          format: decimal
        usedReportingMechanism:
          type: boolean
        energyCarbonFactor:
          type: string
          format: decimal
        carbonConversionFactorMeasurement:
          type: string
          enum:
            - kgCe/kWh
            - kgCO2e/kWh
    FacilitySearchResultExtendedDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        siteName:
          type: string
        schemeExitDate:
          type: string
          format: date
        status:
          type: string
          enum:
            - LIVE
            - INACTIVE
        certificationStatus:
          type: string
          enum:
            - CERTIFIED
            - DECERTIFIED
            - NOT_YET_DEFINED
        auditRequired:
          type: boolean
    SubsistenceFeesRunSearchResultInfoDTO:
      type: object
      properties:
        runId:
          type: integer
          format: int64
        paymentRequestId:
          type: string
        submissionDate:
          type: string
          format: date-time
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - PAID
            - CANCELLED
            - OVERPAID
        markFacilitiesStatus:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - CANCELLED
        currentTotalAmount:
          type: string
          format: decimal
        outstandingTotalAmount:
          type: string
          format: decimal
    SectorPerformanceAccountTemplateDataReportItemDTO:
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        targetUnitAccountBusinessId:
          type: string
        operatorName:
          type: string
        submissionDate:
          type: string
          format: date-time
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodYear:
          type: integer
          format: int16
        status:
          type: string
          enum:
            - SUBMITTED
            - OUTSTANDING
        submissionType:
          type: string
          enum:
            - INTERIM
            - FINAL
    SubsectorAssociationSchemesDTO:
      required:
        - name
        - subsectorAssociationSchemeMap
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 0
          type: string
        subsectorAssociationSchemeMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SubsectorAssociationSchemeDTO'
    NotificationTemplateSearchResults:
      type: object
      properties:
        templates:
          type: array
          items:
            $ref: '#/components/schemas/NotificationTemplateInfoDTO'
        total:
          type: integer
          format: int64
    FacilityPerformanceDataReportDetailsDTO:
      type: object
      properties:
        targetPeriod:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        atLeastSeventyPercentEnergyUsed:
          type: boolean
        calculatedResults:
          $ref: '#/components/schemas/PerformanceDataFacilityCalculatedResults'
        baselineAndTargets:
          $ref: '#/components/schemas/PerformanceDataFacilityBaselineAndTargets'
    CcaItemDTO:
      type: object
      properties:
        creationDate:
          type: string
          format: date-time
        requestId:
          type: string
        requestType:
          type: string
        taskId:
          type: integer
          format: int64
        taskAssignee:
          $ref: '#/components/schemas/UserInfoDTO'
        taskAssigneeType:
          type: string
        taskType:
          type: string
        daysRemaining:
          type: integer
          format: int64
        accountId:
          type: integer
          format: int64
        accountName:
          type: string
        businessId:
          type: string
        competentAuthority:
          type: string
          enum:
            - ENGLAND
            - NORTHERN_IRELAND
            - OPRED
            - SCOTLAND
            - WALES
        sectorId:
          type: integer
          format: int64
        sectorAcronym:
          type: string
        sectorName:
          type: string
        facilityId:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        siteName:
          type: string
        isNew:
          type: boolean
    TargetUnitAccountDetailsResponseDTO:
      type: object
      properties:
        targetUnitAccountDetails:
          $ref: '#/components/schemas/TargetUnitAccountDetailsDTO'
        subsectorAssociation:
          $ref: '#/components/schemas/SubsectorAssociationDTO'
        underlyingAgreementDetails:
          $ref: '#/components/schemas/UnderlyingAgreementDetailsDTO'
    EmailDTO:
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
      description: The user email
    SubsistenceFeesSearchCriteria:
      required:
        - pageNumber
        - pageSize
      type: object
      properties:
        term:
          maxLength: 255
          minLength: 3
          type: string
        markFacilitiesStatus:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - CANCELLED
        pageNumber:
          minimum: 0
          type: integer
          format: int32
        pageSize:
          minimum: 1
          type: integer
          format: int32
      description: The search criteria
    MiReportSystemResult:
      required:
        - columnNames
        - reportType
      type: object
      properties:
        reportType:
          type: string
        columnNames:
          type: array
          items:
            type: string
      discriminator:
        propertyName: reportType
    RequestDetailsSearchResults:
      type: object
      properties:
        requestDetails:
          type: array
          items:
            $ref: '#/components/schemas/RequestDetailsDTO'
        total:
          type: integer
          format: int64
    UnderlyingAgreementVariationSaveReviewDeterminationRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        determination:
          $ref: '#/components/schemas/VariationDetermination'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    AdminTerminationWithdrawReasonDetails:
      required:
        - explanation
      type: object
      properties:
        explanation:
          maxLength: 10000
          minLength: 0
          type: string
        relevantFiles:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    UnderlyingAgreementTargetUnitResponsiblePerson:
      required:
        - address
        - email
        - firstName
        - lastName
      type: object
      properties:
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        email:
          maxLength: 255
          minLength: 0
          type: string
        address:
          $ref: '#/components/schemas/AccountAddressDTO'
    SectorUserDTO:
      required:
        - email
        - firstName
        - lastName
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        status:
          type: string
          enum:
            - REGISTERED
            - PENDING
            - DELETED
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        mobileNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
    TargetPeriod6Details:
      required:
        - baselineData
        - targetComposition
        - targets
      type: object
      properties:
        targetComposition:
          $ref: '#/components/schemas/TargetComposition'
        baselineData:
          $ref: '#/components/schemas/BaselineData'
        targets:
          $ref: '#/components/schemas/Targets'
    ItemSectorDTO:
      type: object
      properties:
        sectorId:
          type: integer
          format: int64
        sectorAcronym:
          type: string
        sectorName:
          type: string
    RequestActionInfoDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        submitter:
          type: string
        creationDate:
          type: string
          format: date-time
    AccountReferenceData:
      type: object
      properties:
        targetUnitAccountDetails:
          $ref: '#/components/schemas/TargetUnitAccountDetails'
        sectorAssociationDetails:
          $ref: '#/components/schemas/SectorAssociationDetails'
    UserStateDTO:
      type: object
      properties:
        userId:
          type: string
        roleType:
          type: string
        status:
          type: string
          enum:
            - NO_ROLE_TYPE
            - ENABLED
            - DISABLED
            - ACCEPTED
            - TEMP_DISABLED
            - NO_AUTHORITY
    PerformanceDataFacilityInputEnergyFuelDetails:
      required:
        - atLeastSeventyPercentEnergyUsed
      type: object
      properties:
        standardFuels:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PerformanceDataFacilityFuelEnergyConsumption'
        nonStandardFuels:
          maxItems: 10
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/PerformanceDataFacilityNonStandardFuel'
        atLeastSeventyPercentEnergyUsed:
          type: boolean
        electricitySuppliedFromCHP:
          type: string
          format: decimal
        throughputAdjustmentFactor:
          type: string
          format: decimal
    TargetCommitmentDTO:
      required:
        - targetPeriod
      type: object
      properties:
        id:
          type: integer
          format: int64
        targetPeriod:
          maxLength: 255
          minLength: 0
          type: string
        targetImprovement:
          type: string
          format: decimal
    BuyOutSurplusTransactionsListSearchCriteria:
      required:
        - pageNumber
        - pageSize
        - targetPeriodType
      type: object
      properties:
        term:
          maxLength: 255
          minLength: 3
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        buyOutSurplusPaymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - AWAITING_REFUND
            - PAID
            - REFUNDED
            - NOT_REQUIRED
            - UNDER_APPEAL
            - TERMINATED
        pageNumber:
          minimum: 0
          type: integer
          format: int32
        pageSize:
          minimum: 1
          type: integer
          format: int32
      description: Search criteria for transactions
    FacilityPerformanceDataUpdateVariationIndicatorDTO:
      required:
        - targetPeriodYear
        - variationIndicator
      type: object
      properties:
        variationIndicator:
          type: boolean
        targetPeriodYear:
          type: integer
          format: int16
    MediaType:
      type: object
      properties:
        type:
          type: string
        subtype:
          type: string
        parameters:
          type: object
          additionalProperties:
            type: string
        qualityValue:
          type: number
          format: double
        wildcardType:
          type: boolean
        wildcardSubtype:
          type: boolean
        subtypeSuffix:
          type: string
        charset:
          type: string
        concrete:
          type: boolean
    NotificationTemplateDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        subject:
          type: string
        text:
          type: string
        eventTrigger:
          type: string
        workflow:
          type: string
        lastUpdatedDate:
          type: string
          format: date-time
    FacilityPerformanceAccountTemplateDataUploadSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        sectorAssociationInfo:
          $ref: '#/components/schemas/SectorAssociationInfo'
        performanceAccountTemplateDataUpload:
          $ref: '#/components/schemas/FacilityPerformanceAccountTemplateDataUpload'
        processingStatus:
          type: string
          enum:
            - NOT_STARTED_YET
            - IN_PROGRESS
            - COMPLETED
        errorMessage:
          type: string
          enum:
            - SUBMISSION_RESULTS_CSV_FAILED
            - MESSAGE_PROCESSING_FAILED
        facilityReports:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/FacilityPerformanceAccountTemplateUploadReport
        uploadAttachments:
          type: object
          additionalProperties:
            type: string
    AuditTrackCorrectiveActionsRequestTaskPayload:
      required:
        - auditTrackCorrectiveActions
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        auditTrackCorrectiveActions:
          $ref: '#/components/schemas/AuditTrackCorrectiveActions'
        respondedActions:
          uniqueItems: true
          type: array
          items:
            type: string
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        facilityAuditAttachments:
          type: object
          additionalProperties:
            type: string
    Cca2ExtensionNoticeAccountProcessingSubmittedRequestActionPayload:
      required:
        - defaultContacts
        - officialNotice
        - underlyingAgreementDocument
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
        underlyingAgreementDocument:
          $ref: '#/components/schemas/FileInfoDTO'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
    UserFeedbackDto:
      required:
        - creatingAccountRate
        - onBoardingRate
        - onlineGuidanceRate
        - satisfactionRate
        - tasksRate
        - userRegistrationRate
      type: object
      properties:
        satisfactionRate:
          type: string
          enum:
            - VERY_SATISFIED
            - SATISFIED
            - NEITHER_SATISFIED_NOR_DISSATISFIED
            - DISSATISFIED
            - VERY_DISSATISFIED
            - NOT_APPLICABLE_NOT_USED_YET
        satisfactionRateReason:
          maxLength: 1200
          minLength: 0
          type: string
        userRegistrationRate:
          type: string
          enum:
            - VERY_SATISFIED
            - SATISFIED
            - NEITHER_SATISFIED_NOR_DISSATISFIED
            - DISSATISFIED
            - VERY_DISSATISFIED
            - NOT_APPLICABLE_NOT_USED_YET
        userRegistrationRateReason:
          maxLength: 1200
          minLength: 0
          type: string
        onlineGuidanceRate:
          type: string
          enum:
            - VERY_SATISFIED
            - SATISFIED
            - NEITHER_SATISFIED_NOR_DISSATISFIED
            - DISSATISFIED
            - VERY_DISSATISFIED
            - NOT_APPLICABLE_NOT_USED_YET
        onlineGuidanceRateReason:
          maxLength: 1200
          minLength: 0
          type: string
        creatingAccountRate:
          type: string
          enum:
            - VERY_SATISFIED
            - SATISFIED
            - NEITHER_SATISFIED_NOR_DISSATISFIED
            - DISSATISFIED
            - VERY_DISSATISFIED
            - NOT_APPLICABLE_NOT_USED_YET
        creatingAccountRateReason:
          maxLength: 1200
          minLength: 0
          type: string
        onBoardingRate:
          type: string
          enum:
            - VERY_SATISFIED
            - SATISFIED
            - NEITHER_SATISFIED_NOR_DISSATISFIED
            - DISSATISFIED
            - VERY_DISSATISFIED
            - NOT_APPLICABLE_NOT_USED_YET
        onBoardingRateReason:
          maxLength: 1200
          minLength: 0
          type: string
        tasksRate:
          type: string
          enum:
            - VERY_SATISFIED
            - SATISFIED
            - NEITHER_SATISFIED_NOR_DISSATISFIED
            - DISSATISFIED
            - VERY_DISSATISFIED
            - NOT_APPLICABLE_NOT_USED_YET
        tasksRateReason:
          maxLength: 1200
          minLength: 0
          type: string
        improvementSuggestion:
          maxLength: 1200
          minLength: 0
          type: string
      description: The user feedback
    NotificationAlertDTO:
      required:
        - body
        - subject
      type: object
      properties:
        subject:
          type: string
        body:
          type: string
    Cca3FacilityMigrationData:
      required:
        - accountBusinessId
        - facilityBusinessId
        - facilityName
        - participatingInCca3Scheme
      type: object
      properties:
        accountBusinessId:
          maxLength: 255
          minLength: 0
          type: string
        facilityBusinessId:
          maxLength: 255
          minLength: 0
          type: string
        facilityName:
          maxLength: 255
          minLength: 0
          type: string
        participatingInCca3Scheme:
          type: boolean
        baselineDate:
          type: string
          format: date
        explanation:
          maxLength: 10000
          minLength: 0
          type: string
        measurementType:
          type: string
          enum:
            - ENERGY_KWH
            - ENERGY_MWH
            - ENERGY_GJ
            - CARBON_KG
            - CARBON_TONNE
        energyCarbonFactor:
          type: string
          format: decimal
        usedReportingMechanism:
          type: boolean
        tp7Improvement:
          type: string
          format: decimal
        tp8Improvement:
          type: string
          format: decimal
        tp9Improvement:
          type: string
          format: decimal
        totalFixedEnergy:
          type: string
          format: decimal
        totalVariableEnergy:
          type: string
          format: decimal
        totalThroughput:
          type: string
          format: decimal
        throughputUnit:
          maxLength: 255
          minLength: 0
          type: string
        calculatorFileUuid:
          maxLength: 255
          minLength: 0
          type: string
        calculatorFileName:
          maxLength: 255
          minLength: 0
          type: string
        calculatorFileProvided:
          type: boolean
    AccountOperatorAuthorityUpdateWrapperDTO:
      required:
        - accountOperatorAuthorityUpdateList
      type: object
      properties:
        accountOperatorAuthorityUpdateList:
          type: array
          items:
            $ref: '#/components/schemas/AccountOperatorAuthorityUpdateDTO'
      description: The account operator authorities to update
    PerformanceDataFacilityProcessingRequestMetadata:
      type: object
      properties:
        type:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportType:
          type: string
          enum:
            - INTERIM
            - FINAL
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        reportVersion:
          type: integer
          format: int32
        submittedDate:
          type: string
          format: date
        uploadRequestId:
          type: string
    AdminTerminationSubmittedRequestActionPayload:
      required:
        - adminTerminationReasonDetails
        - decisionNotification
        - defaultContacts
        - officialNotice
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        adminTerminationReasonDetails:
          $ref: '#/components/schemas/AdminTerminationReasonDetails'
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        adminTerminationSubmitAttachments:
          type: object
          additionalProperties:
            type: string
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
    CcaOperatorInvitedUserInfoDTO:
      type: object
      properties:
        email:
          type: string
        invitationStatus:
          type: string
          enum:
            - ACCEPTED
            - PENDING_TO_REGISTERED_SET_REGISTER_FORM
            - PENDING_TO_REGISTERED_SET_REGISTER_FORM_NO_PASSWORD
            - PENDING_TO_REGISTERED_SET_PASSWORD_ONLY
            - ALREADY_REGISTERED
            - ALREADY_REGISTERED_SET_PASSWORD_ONLY
        firstName:
          type: string
        lastName:
          type: string
        roleCode:
          type: string
        contactType:
          type: string
        accountName:
          type: string
    TargetUnitAccountHeaderInfoDTO:
      type: object
      properties:
        name:
          type: string
        businessId:
          type: string
        status:
          type: string
          enum:
            - NEW
            - LIVE
            - CANCELLED
            - TERMINATED
            - REJECTED
    UnderlyingAgreementVariationRegulatorLedSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        workflowSchemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        originalUnderlyingAgreementContainer:
          $ref: '#/components/schemas/UnderlyingAgreementContainer'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        facilityChargeStartDateMap:
          type: object
          additionalProperties:
            type: string
            format: date
        determination:
          $ref: '#/components/schemas/VariationRegulatorLedDetermination'
        regulatorLedSubmitAttachments:
          type: object
          additionalProperties:
            type: string
    TP6BuyOutCalculatedAccountProcessingSubmittedRequestActionPayload:
      required:
        - buyOutCalculatedDetails
        - details
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        details:
          $ref: '#/components/schemas/BuyOutSurplusDetails'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        buyOutCalculatedDetails:
          $ref: '#/components/schemas/BuyOutCalculatedDetails'
    SubsistenceFeesMoaTargetUnitDetailsDTO:
      type: object
      properties:
        moaTargetUnitId:
          type: integer
          format: int64
        businessId:
          type: string
        name:
          type: string
        initialTotalAmount:
          type: string
          format: decimal
        submissionDate:
          type: string
          format: date-time
        facilityFee:
          type: string
          format: decimal
        currentTotalAmount:
          type: string
          format: decimal
        totalFacilities:
          type: integer
          format: int64
        paidFacilities:
          type: integer
          format: int64
    UnderlyingAgreementReviewRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        workflowSchemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementProposed:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementFacilityReviewDecision'
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
        determination:
          $ref: '#/components/schemas/Determination'
    PerformanceAccountTemplateProcessingRequestMetadata:
      type: object
      properties:
        type:
          type: string
        parentRequestId:
          type: string
        sectorAssociationInfo:
          $ref: '#/components/schemas/SectorAssociationInfo'
        sectorUserAssignee:
          type: string
        accountId:
          type: integer
          format: int64
        accountBusinessId:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodYear:
          type: integer
          format: int16
        reportVersion:
          type: integer
          format: int32
    Determination:
      required:
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - ACCEPTED
            - REJECTED
        reason:
          maxLength: 10000
          minLength: 0
          type: string
        additionalInformation:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    SubsistenceFeesMoaFacilitySearchResults:
      type: object
      properties:
        subsistenceFeesMoaFacilities:
          type: array
          items:
            $ref: '#/components/schemas/SubsistenceFeesMoaFacilitySearchResultInfoDTO'
        total:
          type: integer
          format: int64
    SubsistenceFeesMoaReceivedAmountHistoryDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        submitter:
          type: string
        submissionDate:
          type: string
          format: date-time
        transactionAmount:
          type: string
          format: decimal
        comments:
          type: string
        evidenceFiles:
          type: object
          additionalProperties:
            type: string
    ProblemDetail:
      type: object
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          format: int32
        detail:
          type: string
        instance:
          type: string
          format: uri
        properties:
          type: object
          additionalProperties:
            type: object
    PerformanceDataCalculatedMetrics:
      type: object
      properties:
        byPerformance:
          type: string
          format: decimal
        numericalTarget:
          type: string
          format: decimal
        tolerance:
          type: string
          format: decimal
        tpEnergy:
          type: string
          format: decimal
        tpChpDeliveredElectricity:
          type: string
          format: decimal
        tpPerformance:
          type: string
          format: decimal
        tpPerformancePercent:
          type: string
          format: decimal
        tpOutcome:
          type: string
          enum:
            - TARGET_MET
            - BUY_OUT_REQUIRED
            - SURPLUS_USED_BUY_OUT_REQUIRED
            - SURPLUS_USED
            - OUTSTANDING
        tpCarbonFactor:
          type: string
          format: decimal
        energyCarbonUnderTarget:
          type: string
          format: decimal
        carbonUnderTarget:
          type: string
          format: decimal
        co2Emissions:
          type: string
          format: decimal
        surplusUsed:
          type: string
          format: decimal
        surplusGained:
          type: string
          format: decimal
        priBuyOutCarbon:
          type: string
          format: decimal
        priBuyOutCost:
          type: string
          format: decimal
        secondaryBuyOutCo2:
          type: string
          format: decimal
        secondaryBuyOutCost:
          type: string
          format: decimal
    OperatorAuthorityInfoDTO:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        roleName:
          type: string
        roleCode:
          type: string
        contactType:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - TEMP_DISABLED_PENDING
            - ACTIVE
            - DISABLED
            - ACCEPTED
            - TEMP_DISABLED
        authorityCreationDate:
          type: string
          format: date-time
        userId:
          type: string
    BuyOutSurplusTransactionHistoryPayload:
      required:
        - type
      type: object
      properties:
        comments:
          maxLength: 10000
          minLength: 0
          type: string
        evidenceFiles:
          type: object
          additionalProperties:
            type: string
        type:
          type: string
          enum:
            - AMOUNT_CHANGED
            - PAYMENT_STATUS_CHANGED
      discriminator:
        propertyName: type
    SectorAssociationSchemesDTO:
      required:
        - sectorAssociationSchemeMap
      type: object
      properties:
        sectorAssociationSchemeMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SectorAssociationSchemeDTO'
        subsectorAssociations:
          type: array
          items:
            $ref: '#/components/schemas/SubsectorAssociationInfoDTO'
    UnderlyingAgreementVariationReviewRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        workflowSchemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        originalUnderlyingAgreementContainer:
          $ref: '#/components/schemas/UnderlyingAgreementContainer'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementProposed:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        determination:
          $ref: '#/components/schemas/VariationDetermination'
    SectorAssociationSiteContactInfoResponse:
      type: object
      properties:
        siteContacts:
          type: array
          items:
            $ref: '#/components/schemas/SectorAssociationSiteContactInfoDTO'
        editable:
          type: boolean
        totalItems:
          type: integer
          format: int64
    RegulatorInvitedUserDetailsDTO:
      required:
        - email
        - firstName
        - jobTitle
        - lastName
        - phoneNumber
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          maxLength: 255
          minLength: 0
          type: string
        mobileNumber:
          maxLength: 255
          minLength: 0
          type: string
    PasswordValidationResponseDTO:
      type: object
      properties:
        valid:
          type: boolean
        errors:
          type: array
          items:
            $ref: '#/components/schemas/PasswordValidationErrorDTO'
    PerformanceDataFacilityCsvErrorEntry:
      type: object
      properties:
        filename:
          type: string
        message:
          type: string
        facilityBusinessId:
          type: string
    SectorFacilityPerformanceDataReportListDTO:
      type: object
      properties:
        performanceDataReportItems:
          type: array
          items:
            $ref: '#/components/schemas/SectorFacilityPerformanceDataReportItemDTO'
        total:
          type: integer
          format: int64
    MiReportUserDefinedResult:
      type: object
      properties:
        columnNames:
          type: array
          items:
            type: string
        results:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
    RegulatorRolePermissionsDTO:
      type: object
      properties:
        name:
          type: string
        code:
          type: string
        rolePermissions:
          type: object
          additionalProperties:
            type: string
            enum:
              - NONE
              - VIEW_ONLY
              - EXECUTE
    AdminTerminationFinalDecisionRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        adminTerminationFinalDecisionReasonDetails:
          $ref: '#/components/schemas/AdminTerminationFinalDecisionReasonDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        adminTerminationAttachments:
          type: object
          additionalProperties:
            type: string
    PerformanceDataFacilityDataUploadRequestMetadata:
      type: object
      properties:
        type:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportType:
          type: string
          enum:
            - INTERIM
            - FINAL
        targetPeriodYear:
          $ref: '#/components/schemas/TargetPeriodYear'
        targetPeriods:
          type: array
          items:
            $ref: '#/components/schemas/TargetPeriodDetailsDTO'
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        submittedDate:
          type: string
          format: date-time
    SubsistenceFeesMoaSearchResults:
      type: object
      properties:
        subsistenceFeesMoas:
          type: array
          items:
            $ref: '#/components/schemas/SubsistenceFeesMoaSearchResultInfoDTO'
        total:
          type: integer
          format: int64
    PerformanceDataSpreadsheetProcessingRequestMetadata:
      type: object
      properties:
        type:
          type: string
        parentRequestId:
          type: string
        accountBusinessId:
          type: string
        sectorAssociationInfo:
          $ref: '#/components/schemas/SectorAssociationInfo'
        performanceDataTargetPeriodType:
          type: string
          enum:
            - TP6
        targetPeriodDetails:
          $ref: '#/components/schemas/TargetPeriodYearDTO'
        reportVersion:
          type: integer
          format: int32
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        uploadedDate:
          type: string
          format: date
    AdminTerminationWithdrawSubmittedRequestActionPayload:
      required:
        - adminTerminationWithdrawReasonDetails
        - decisionNotification
        - defaultContacts
        - officialNotice
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        adminTerminationWithdrawReasonDetails:
          $ref: '#/components/schemas/AdminTerminationWithdrawReasonDetails'
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        adminTerminationWithdrawAttachments:
          type: object
          additionalProperties:
            type: string
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
    AuditDetailsCorrectiveActionsSubmitSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        auditDetailsAndCorrectiveActions:
          $ref: '#/components/schemas/AuditDetailsAndCorrectiveActions'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    DecisionNotification:
      required:
        - signatory
      type: object
      properties:
        operators:
          uniqueItems: true
          type: array
          items:
            type: string
        externalContacts:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int64
        signatory:
          type: string
    PaymentCancelledRequestActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        status:
          type: string
          enum:
            - MARK_AS_PAID
            - MARK_AS_RECEIVED
            - COMPLETED
            - CANCELLED
        cancellationReason:
          type: string
    PerformanceDataGenerateRequestTaskActionPayload:
      required:
        - targetPeriodType
      type: object
      properties:
        payloadType:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP6
    CcaOperatorUserRegistrationWithCredentialsDTO:
      required:
        - contactType
        - emailToken
        - firstName
        - lastName
        - password
      type: object
      properties:
        emailToken:
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        mobileNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        contactType:
          type: string
          enum:
            - SECTOR_ASSOCIATION
            - OPERATOR
            - CONSULTANT
        organisationName:
          type: string
        password:
          type: string
      description: The operator user
    SubsistenceFeesMoaFacilityMarkingStatusHistoryInfoDTO:
      type: object
      properties:
        facilityBusinessId:
          type: string
        siteName:
          type: string
        markingStatusHistoryList:
          type: array
          items:
            $ref: >-
              #/components/schemas/SubsistenceFeesMoaFacilityMarkingStatusHistoryDTO
    PerformanceDataFacilityUploadCsvData:
      type: object
      properties:
        facilityBusinessId:
          type: string
        gridElectricity:
          type: string
          format: decimal
        nonGridElectricity:
          type: string
          format: decimal
        naturalGas:
          type: string
          format: decimal
        lpg:
          type: string
          format: decimal
        gasDieselOil:
          type: string
          format: decimal
        fuelOil:
          type: string
          format: decimal
        kerosene:
          type: string
          format: decimal
        coal:
          type: string
          format: decimal
        coke:
          type: string
          format: decimal
        petrol:
          type: string
          format: decimal
        nitrogen:
          type: string
          format: decimal
        carbonDioxide:
          type: string
          format: decimal
        ethane:
          type: string
          format: decimal
        naphtha:
          type: string
          format: decimal
        petroleumCoke:
          type: string
          format: decimal
        refineryGas:
          type: string
          format: decimal
        otherFuelName1:
          type: string
        otherFuelConversionFactor1:
          type: string
          format: decimal
        otherFuelAmount1:
          type: string
          format: decimal
        otherFuelName2:
          type: string
        otherFuelConversionFactor2:
          type: string
          format: decimal
        otherFuelAmount2:
          type: string
          format: decimal
        otherFuelName3:
          type: string
        otherFuelConversionFactor3:
          type: string
          format: decimal
        otherFuelAmount3:
          type: string
          format: decimal
        otherFuelName4:
          type: string
        otherFuelConversionFactor4:
          type: string
          format: decimal
        otherFuelAmount4:
          type: string
          format: decimal
        otherFuelName5:
          type: string
        otherFuelConversionFactor5:
          type: string
          format: decimal
        otherFuelAmount5:
          type: string
          format: decimal
        otherFuelName6:
          type: string
        otherFuelConversionFactor6:
          type: string
          format: decimal
        otherFuelAmount6:
          type: string
          format: decimal
        otherFuelName7:
          type: string
        otherFuelConversionFactor7:
          type: string
          format: decimal
        otherFuelAmount7:
          type: string
          format: decimal
        otherFuelName8:
          type: string
        otherFuelConversionFactor8:
          type: string
          format: decimal
        otherFuelAmount8:
          type: string
          format: decimal
        otherFuelName9:
          type: string
        otherFuelConversionFactor9:
          type: string
          format: decimal
        otherFuelAmount9:
          type: string
          format: decimal
        otherFuelName10:
          type: string
        otherFuelConversionFactor10:
          type: string
          format: decimal
        otherFuelAmount10:
          type: string
          format: decimal
        atLeastSeventyPercentEnergyUsed:
          type: boolean
        electricitySuppliedFromCHP:
          type: string
          format: decimal
        actualThroughput:
          type: string
          format: decimal
        productName1:
          type: string
        productActualThroughput1:
          type: string
          format: decimal
        productName2:
          type: string
        productActualThroughput2:
          type: string
          format: decimal
        productName3:
          type: string
        productActualThroughput3:
          type: string
          format: decimal
        productName4:
          type: string
        productActualThroughput4:
          type: string
          format: decimal
        productName5:
          type: string
        productActualThroughput5:
          type: string
          format: decimal
        productName6:
          type: string
        productActualThroughput6:
          type: string
          format: decimal
        productName7:
          type: string
        productActualThroughput7:
          type: string
          format: decimal
        productName8:
          type: string
        productActualThroughput8:
          type: string
          format: decimal
        productName9:
          type: string
        productActualThroughput9:
          type: string
          format: decimal
        productName10:
          type: string
        productActualThroughput10:
          type: string
          format: decimal
        productName11:
          type: string
        productActualThroughput11:
          type: string
          format: decimal
        productName12:
          type: string
        productActualThroughput12:
          type: string
          format: decimal
        productName13:
          type: string
        productActualThroughput13:
          type: string
          format: decimal
        productName14:
          type: string
        productActualThroughput14:
          type: string
          format: decimal
        productName15:
          type: string
        productActualThroughput15:
          type: string
          format: decimal
        productName16:
          type: string
        productActualThroughput16:
          type: string
          format: decimal
        productName17:
          type: string
        productActualThroughput17:
          type: string
          format: decimal
        productName18:
          type: string
        productActualThroughput18:
          type: string
          format: decimal
        productName19:
          type: string
        productActualThroughput19:
          type: string
          format: decimal
        productName20:
          type: string
        productActualThroughput20:
          type: string
          format: decimal
    PaymentConfirmRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        paymentRefNum:
          type: string
        paymentDate:
          type: string
          format: date
        paidByFullName:
          type: string
        amount:
          type: string
          format: decimal
        status:
          type: string
          enum:
            - MARK_AS_PAID
            - MARK_AS_RECEIVED
            - COMPLETED
            - CANCELLED
        paymentMethod:
          type: string
          enum:
            - BANK_TRANSFER
            - CREDIT_OR_DEBIT_CARD
    RdeSubmitRequestTaskActionPayload:
      required:
        - rdePayload
      type: object
      properties:
        payloadType:
          type: string
        rdePayload:
          $ref: '#/components/schemas/RdePayload'
    UnderlyingAgreementVariationDetails:
      required:
        - modifications
        - reason
      type: object
      properties:
        reason:
          maxLength: 10000
          minLength: 0
          type: string
        modifications:
          type: array
          items:
            type: string
            enum:
              - AMEND_OPERATOR_OR_ORGANISATION_NAME
              - AMEND_OPERATOR_OR_ORGANISATION_TARGET_UNIT_ADDRESS
              - AMEND_OPERATOR_OR_ORGANISATION_COMPANY_NUMBER
              - AMEND_ONE_OR_MORE_FACILITIES_NAME
              - ADD_ONE_OR_MORE_FACILITIES_TO_AGREEMENT
              - REMOVE_ONE_OR_MORE_FACILITIES_FROM_AGREEMENT
              - AMEND_ONE_OR_MORE_FACILITIES_UK_ETS
              - AMEND_ONE_OR_MORE_IMPROVEMENT_TARGETS
              - UNEXPECTED_POWER_SUPPLY_DISRUPTION_DURING_TARGET_PERIOD
              - THROUGHPUT_DROPPING_MORE_THAN_10_PERCENT_DURING_TARGET_PERIOD
              - AMEND_RESPONSIBLE_PERSON_PERSONAL_DETAILS
              - AMEND_EVIDENCE_DEFINING_EXTENT_OF_FACILITY_ELIGIBILITY
              - AMEND_70_PERCENT_RULE_EVALUATION
              - STRUCTURAL_CHANGE
              - REVIEW_OF_70_PERCENT_RULE
              - ERROR_DISCOVERY
              - REPLACING_ESTIMATED_WITH_ACTUAL_VALUES
              - AMEND_FACILITY_BASE_YEAR_CHANGE_ALLOCATION
              - AMEND_FACILITY_BASE_YEAR_ADD_NEW_PRODUCTS
              - ANY_CHANGES_NOT_COVERED
              - ADDITION_OR_REMOVAL_ONE_OR_MORE_FACILITIES_FROM_AGREEMENT
              - CHANGE_BETWEEN_RELATIVE_AND_NOVEM_TARGET_TYPES
              - CHANGE_THROUGHPUT_UNIT
    FacilityTargets:
      required:
        - improvements
      type: object
      properties:
        improvements:
          type: object
          additionalProperties:
            type: string
            format: decimal
    RfiSubmittedRequestActionPayload:
      required:
        - officialDocument
        - rfiSubmitPayload
      type: object
      properties:
        payloadType:
          type: string
        rfiSubmitPayload:
          $ref: '#/components/schemas/RfiSubmitPayload'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        rfiAttachments:
          type: object
          additionalProperties:
            type: string
        officialDocument:
          $ref: '#/components/schemas/FileInfoDTO'
    UnderlyingAgreementVariationPayload:
      required:
        - authorisationAndAdditionalEvidence
        - underlyingAgreementTargetUnitDetails
        - underlyingAgreementVariationDetails
      type: object
      properties:
        underlyingAgreementVariationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementVariationDetails'
        underlyingAgreementTargetUnitDetails:
          $ref: '#/components/schemas/UnderlyingAgreementTargetUnitDetails'
        facilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Facility'
        targetPeriod5Details:
          $ref: '#/components/schemas/TargetPeriod5Details'
        targetPeriod6Details:
          $ref: '#/components/schemas/TargetPeriod6Details'
        authorisationAndAdditionalEvidence:
          $ref: '#/components/schemas/AuthorisationAndAdditionalEvidence'
    TargetUnitAccountUploadReport:
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        accountBusinessId:
          type: string
        file:
          $ref: '#/components/schemas/FileInfoDTO'
        succeeded:
          type: boolean
        performanceDataCalculatedMetrics:
          $ref: '#/components/schemas/PerformanceDataCalculatedMetrics'
        errors:
          type: array
          items:
            type: string
    PaymentMarkAsReceivedRequestTaskActionPayload:
      required:
        - receivedDate
      type: object
      properties:
        payloadType:
          type: string
        receivedDate:
          type: string
          format: date
    CorrectiveAction:
      required:
        - deadline
        - details
        - title
      type: object
      properties:
        title:
          maxLength: 255
          minLength: 0
          type: string
        details:
          maxLength: 10000
          minLength: 0
          type: string
        deadline:
          type: string
          format: date
    UnderlyingAgreementReviewDecisionDetails:
      type: object
      properties:
        notes:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    RequestTaskDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        payload:
          $ref: '#/components/schemas/RequestTaskPayload'
        assignable:
          type: boolean
        assigneeUserId:
          type: string
        assigneeFullName:
          type: string
        daysRemaining:
          type: integer
          format: int64
        startDate:
          type: string
          format: date-time
    PerformanceDataFacilityBaselineAndTargets:
      type: object
      properties:
        baselineDate:
          type: string
          format: date
        baselineYear:
          type: integer
          format: int16
        isTwelveMonths:
          type: boolean
        energyCarbonFactor:
          type: string
          format: decimal
        measurementType:
          type: string
          enum:
            - ENERGY_KWH
            - ENERGY_MWH
            - ENERGY_GJ
            - CARBON_KG
            - CARBON_TONNE
        usedReportingMechanism:
          type: boolean
        improvements:
          type: object
          additionalProperties:
            type: string
            format: decimal
        totalFixedEnergy:
          type: string
          format: decimal
        variableEnergyType:
          type: string
          enum:
            - TOTALS
            - BY_PRODUCT
        baselineVariableEnergy:
          type: string
          format: decimal
        totalThroughput:
          type: string
          format: decimal
        throughputUnit:
          type: string
        baselineEnergyCarbonIntensity:
          type: string
          format: decimal
        variableEnergyConsumptionDataByProduct:
          type: array
          items:
            $ref: '#/components/schemas/ProductVariableEnergyConsumptionData'
    UnderlyingAgreementSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        workflowSchemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
    RequestMetadata:
      type: object
      properties:
        type:
          type: string
      discriminator:
        propertyName: type
    ReportRelatedRequestCreateActionPayload:
      required:
        - requestId
      type: object
      properties:
        payloadType:
          type: string
        requestId:
          type: string
    SubsistenceFeesRunDetailsDTO:
      type: object
      properties:
        runId:
          type: integer
          format: int64
        paymentRequestId:
          type: string
        submissionDate:
          type: string
          format: date-time
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - PAID
            - CANCELLED
            - OVERPAID
        initialTotalAmount:
          type: string
          format: decimal
        currentTotalAmount:
          type: string
          format: decimal
        outstandingTotalAmount:
          type: string
          format: decimal
        sectorMoasCount:
          type: integer
          format: int64
        targetUnitMoasCount:
          type: integer
          format: int64
    FacilityBaseInfoDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        siteName:
          type: string
    UnderlyingAgreementVariationSaveReviewGroupDecisionRequestTaskActionPayload:
      required:
        - decision
        - group
      type: object
      properties:
        payloadType:
          type: string
        group:
          type: string
          enum:
            - TARGET_UNIT_DETAILS
            - TARGET_PERIOD5_DETAILS
            - TARGET_PERIOD6_DETAILS
            - AUTHORISATION_AND_ADDITIONAL_EVIDENCE
            - VARIATION_DETAILS
        determination:
          $ref: '#/components/schemas/VariationDetermination'
        decision:
          $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    FacilityBaselineEnergyConsumption:
      required:
        - hasVariableEnergy
        - totalFixedEnergy
      type: object
      properties:
        totalFixedEnergy:
          type: string
          format: decimal
        hasVariableEnergy:
          type: boolean
        variableEnergyType:
          type: string
          enum:
            - TOTALS
            - BY_PRODUCT
        baselineVariableEnergy:
          type: string
          format: decimal
        totalThroughput:
          type: string
          format: decimal
        throughputUnit:
          maxLength: 255
          minLength: 0
          type: string
        variableEnergyConsumptionDataByProduct:
          type: array
          items:
            $ref: '#/components/schemas/ProductVariableEnergyConsumptionData'
    SectorPerformanceAccountTemplateDataReportSearchCriteria:
      required:
        - pageNumber
        - pageSize
        - targetPeriodType
      type: object
      properties:
        targetUnitAccountBusinessId:
          maxLength: 255
          minLength: 3
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        status:
          type: string
          enum:
            - SUBMITTED
            - OUTSTANDING
        submissionType:
          type: string
          enum:
            - INTERIM
            - FINAL
        pageNumber:
          minimum: 0
          type: integer
          format: int32
        pageSize:
          minimum: 1
          type: integer
          format: int32
      description: The search criteria
    PerformanceDataFacilityDigitalFormSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportType:
          type: string
          enum:
            - INTERIM
            - FINAL
        targetPeriodYear:
          type: integer
          format: int16
        facility:
          $ref: '#/components/schemas/FacilityBaseInfoDTO'
        referenceData:
          $ref: '#/components/schemas/PerformanceDataFacilityReferenceData'
        performanceData:
          $ref: '#/components/schemas/PerformanceDataFacilityInputData'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        expired:
          type: boolean
    NotAccountRelatedUploadErrorReport:
      type: object
      properties:
        fileName:
          type: string
        error:
          type: string
    UserInfoDTO:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
    BuyOutSurplusTransactionHistoryDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        submitter:
          type: string
        submissionDate:
          type: string
          format: date-time
        payload:
          oneOf:
            - $ref: >-
                #/components/schemas/BuyOutSurplusTransactionAmountChangedHistoryPayload
            - $ref: >-
                #/components/schemas/BuyOutSurplusTransactionPaymentStatusChangedHistoryPayload
    NonComplianceDetails:
      required:
        - isEnforcementResponseNoticeRequired
        - nonComplianceType
      type: object
      properties:
        nonComplianceType:
          type: string
          enum:
            - FAILURE_TO_PROVIDE_TPR
            - FAILURE_TO_PROVIDE_PR
            - FAILURE_TO_PROVIDE_OTHER_INFO
            - FAILURE_TO_NOTIFY_OF_AN_ERROR
            - FAILURE_TO_NOTIFY_FACILITY_NO_LONGER_ELIGIBLE
            - FAILURE_TO_NOTIFY_OTHER_REQUIREMENT_UNA
            - INACCURATE_TPR_INFO
            - INACCURATE_PR_INFO
            - INACCURATE_OTHER_INFO
        nonCompliantDate:
          type: string
          format: date
        compliantDate:
          type: string
          format: date
        comment:
          maxLength: 10000
          minLength: 0
          type: string
        relevantWorkflows:
          uniqueItems: true
          type: array
          items:
            type: string
        relevantFacilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/NonComplianceFacilityDTO'
        isEnforcementResponseNoticeRequired:
          type: boolean
        explanation:
          maxLength: 10000
          minLength: 0
          type: string
    SurplusGainedDTO:
      type: object
      properties:
        targetPeriod:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        surplusGained:
          type: string
          format: decimal
        hasHistory:
          type: boolean
    SectorAssociationInfo:
      type: object
      properties:
        id:
          type: integer
          format: int64
        acronym:
          type: string
        name:
          type: string
        competentAuthority:
          type: string
          enum:
            - ENGLAND
            - NORTHERN_IRELAND
            - OPRED
            - SCOTLAND
            - WALES
    AuditDetailsAndCorrectiveActions:
      required:
        - auditDetails
        - correctiveActions
      type: object
      properties:
        auditDetails:
          $ref: '#/components/schemas/AuditDetails'
        correctiveActions:
          $ref: '#/components/schemas/CorrectiveActions'
    TargetUnitAccountInfoDTO:
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        businessId:
          type: string
        accountName:
          type: string
        status:
          type: string
          enum:
            - NEW
            - LIVE
            - CANCELLED
            - TERMINATED
            - REJECTED
        siteContactUserId:
          type: string
    PerformanceAccountTemplateProcessingSubmittedRequestActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodYear:
          type: integer
          format: int16
        data:
          $ref: '#/components/schemas/PerformanceAccountTemplateDataContainer'
    AuditCorrectiveActionResponse:
      required:
        - deadline
        - details
        - isActionCarriedOut
        - title
      type: object
      properties:
        title:
          maxLength: 255
          minLength: 0
          type: string
        details:
          maxLength: 10000
          minLength: 0
          type: string
        deadline:
          type: string
          format: date
        isActionCarriedOut:
          type: boolean
        actionCarriedOutDate:
          type: string
          format: date
        comments:
          maxLength: 10000
          minLength: 0
          type: string
        evidenceFiles:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    RequestTaskItemDTO:
      type: object
      properties:
        requestTask:
          $ref: '#/components/schemas/RequestTaskDTO'
        allowedRequestTaskActions:
          type: array
          items:
            type: string
        userAssignCapable:
          type: boolean
        requestInfo:
          $ref: '#/components/schemas/RequestInfoDTO'
    PerformanceDataFacilityProductVariableEnergyData:
      required:
        - actualThroughput
        - adjustedThroughput
        - productName
        - targetEnergy
        - targetImprovement
      type: object
      properties:
        productName:
          maxLength: 255
          minLength: 0
          type: string
        targetImprovement:
          type: string
          format: decimal
        actualThroughput:
          type: string
          format: decimal
        adjustedThroughput:
          type: string
          format: decimal
        targetEnergy:
          type: string
          format: decimal
    ActualTargetPeriodPerformance:
      required:
        - actualThroughput
        - actualTuIdentifier
        - reportingThroughput
        - tpChpDeliveredElectricity
        - tpEnergy
      type: object
      properties:
        actualTuIdentifier:
          type: string
        actualThroughput:
          type: string
          format: decimal
        energyData:
          type: object
          additionalProperties:
            type: string
            format: decimal
        carbonFactors:
          type: array
          items:
            $ref: '#/components/schemas/OtherFuel'
        tpEnergy:
          type: string
          format: decimal
        tpChpDeliveredElectricity:
          type: string
          format: decimal
        reportingThroughput:
          type: string
          format: decimal
        adjustedThroughput:
          type: string
          format: decimal
    CorrectiveActionFollowUpResponse:
      required:
        - isActionCarriedOut
      type: object
      properties:
        isActionCarriedOut:
          type: boolean
        actionCarriedOutDate:
          type: string
          format: date
        comments:
          maxLength: 10000
          minLength: 0
          type: string
        evidenceFiles:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    UnderlyingAgreementMigratedRequestActionPayload:
      required:
        - activationDate
        - underlyingAgreement
        - underlyingAgreementDocument
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementDocument:
          $ref: '#/components/schemas/FileInfoDTO'
        activationDate:
          type: string
          format: date-time
    ItemTargetUnitAccountDTO:
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        accountName:
          type: string
        businessId:
          type: string
        competentAuthority:
          type: string
          enum:
            - ENGLAND
            - NORTHERN_IRELAND
            - OPRED
            - SCOTLAND
            - WALES
    SurplusUpdateDTO:
      required:
        - comments
        - newSurplusGained
        - targetPeriodType
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        newSurplusGained:
          type: string
          format: decimal
        comments:
          maxLength: 10000
          minLength: 0
          type: string
      description: Updates Surplus info
    CaExternalContactsDTO:
      type: object
      properties:
        caExternalContacts:
          type: array
          items:
            $ref: '#/components/schemas/CaExternalContactDTO'
        isEditable:
          type: boolean
    NoticeRecipientDTO:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        type:
          type: string
          enum:
            - RESPONSIBLE_PERSON
            - ADMINISTRATIVE_CONTACT
            - SECTOR_CONTACT
            - SECTOR_USER
            - SECTOR_CONSULTANT
            - OPERATOR
    RegulatorUsersAuthoritiesInfoDTO:
      type: object
      properties:
        caUsers:
          type: array
          items:
            $ref: '#/components/schemas/RegulatorUserAuthorityInfoDTO'
        editable:
          type: boolean
    PrimaryDetermination:
      required:
        - carbonUnderTarget
        - co2Emissions
        - energyCarbonUnderTarget
        - priBuyOutCarbon
        - priBuyOutCost
        - surplusGained
        - surplusUsed
        - tpCarbonFactor
      type: object
      properties:
        tpCarbonFactor:
          type: string
          format: decimal
        energyCarbonUnderTarget:
          type: string
          format: decimal
        carbonUnderTarget:
          type: string
          format: decimal
        co2Emissions:
          type: string
          format: decimal
        surplusUsed:
          type: string
          format: decimal
        surplusGained:
          type: string
          format: decimal
        priBuyOutCarbon:
          type: string
          format: decimal
        priBuyOutCost:
          type: string
          format: decimal
    AuditTrackCorrectiveActionsSubmitRequestTaskActionPayload:
      required:
        - actionTitle
      type: object
      properties:
        payloadType:
          type: string
        actionTitle:
          type: string
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    BuyOutSurplusTransactionAmountChangedHistoryPayload:
      required:
        - amount
        - type
      type: object
      allOf:
        - $ref: '#/components/schemas/BuyOutSurplusTransactionHistoryPayload'
        - type: object
          properties:
            amount:
              type: string
              format: decimal
    BuyOutSurplusTransactionPaymentStatusChangedHistoryPayload:
      required:
        - paymentStatus
        - type
      type: object
      allOf:
        - $ref: '#/components/schemas/BuyOutSurplusTransactionHistoryPayload'
        - type: object
          properties:
            paymentStatus:
              type: string
              enum:
                - AWAITING_PAYMENT
                - AWAITING_REFUND
                - PAID
                - REFUNDED
                - NOT_REQUIRED
                - UNDER_APPEAL
                - TERMINATED
            paymentDate:
              type: string
              format: date
    PerformanceDataFacilitySubmissionDetails:
      required:
        - creationDate
        - reportType
        - reportVersion
        - submissionDate
        - targetPeriodType
        - targetPeriodYear
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportType:
          type: string
          enum:
            - INTERIM
            - FINAL
        targetPeriodYear:
          type: integer
          format: int16
        submissionType:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
        reportVersion:
          type: integer
          format: int32
        creationDate:
          type: string
          format: date-time
        submissionDate:
          type: string
          format: date-time
    Apply70Rule:
      required:
        - energyConsumed
        - energyConsumedEligible
        - evidenceFile
      type: object
      properties:
        energyConsumed:
          type: string
          format: decimal
        energyConsumedProvision:
          type: string
          format: decimal
        energyConsumedEligible:
          type: string
          format: decimal
        startDate:
          type: string
          format: date
        evidenceFile:
          type: string
          format: uuid
    MiReportUserDefinedInfoDTO:
      required:
        - reportName
      type: object
      properties:
        id:
          type: integer
          format: int64
        reportName:
          maxLength: 255
          minLength: 0
          type: string
        description:
          maxLength: 10000
          minLength: 0
          type: string
    SubsistenceFeesMoaFacilitySearchResultInfoDTO:
      type: object
      properties:
        moaFacilityId:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        facilityName:
          type: string
        markFacilitiesStatus:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - CANCELLED
        paymentDate:
          type: string
          format: date
        hasHistory:
          type: boolean
    NonComplianceEnforcementResponseNoticePeerReviewRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        enforcementResponseNotice:
          $ref: '#/components/schemas/NonComplianceEnforcementResponseNotice'
        closeJustification:
          $ref: '#/components/schemas/NonComplianceCloseJustification'
        penaltyReissue:
          type: boolean
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
        decision:
          $ref: '#/components/schemas/CcaPeerReviewDecision'
        peerReviewAttachments:
          type: object
          additionalProperties:
            type: string
    SectorAssociationInfoDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        sector:
          type: string
        mainContact:
          type: string
    ReferenceDataDTO:
      type: object
    UnderlyingAgreementActivatedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - officialNotice
        - underlyingAgreementActivationDetails
        - underlyingAgreementDocuments
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
        underlyingAgreementDocuments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FileInfoDTO'
        underlyingAgreementActivationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementActivationDetails'
        underlyingAgreementActivationAttachments:
          type: object
          additionalProperties:
            type: string
    CompanyProfileDTO:
      type: object
      properties:
        name:
          type: string
        registrationNumber:
          type: string
        operatorType:
          type: string
        sicCodes:
          type: array
          items:
            type: string
        address:
          $ref: '#/components/schemas/AccountAddressDTO'
    SectorMoaGeneratedRequestActionPayload:
      required:
        - chargingYear
        - moaDocument
        - paymentRequestId
        - recipients
        - transactionId
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        paymentRequestId:
          type: string
        chargingYear:
          type: integer
          format: int16
        transactionId:
          type: string
        moaDocument:
          $ref: '#/components/schemas/FileInfoDTO'
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
    BaselineData:
      required:
        - baselineDate
        - energy
        - energyCarbonFactor
        - isTwelveMonths
      type: object
      properties:
        isTwelveMonths:
          type: boolean
        baselineDate:
          type: string
          format: date
        explanation:
          type: string
        greenfieldEvidences:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        energy:
          type: string
          format: decimal
        usedReportingMechanism:
          type: boolean
        throughput:
          type: string
          format: decimal
        performance:
          type: string
          format: decimal
        energyCarbonFactor:
          type: string
          format: decimal
    NonComplianceCloseRequestTaskActionPayload:
      required:
        - closeJustification
      type: object
      properties:
        payloadType:
          type: string
        closeJustification:
          $ref: '#/components/schemas/NonComplianceCloseJustification'
    SectorUserRegistrationWithCredentialsDTO:
      required:
        - emailToken
        - firstName
        - lastName
        - password
      type: object
      properties:
        emailToken:
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        contactType:
          type: string
          enum:
            - SECTOR_ASSOCIATION
            - OPERATOR
            - CONSULTANT
        organisationName:
          type: string
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        mobileNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        password:
          type: string
      description: The sector user
    UnderlyingAgreementVariationActivatedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - officialNotices
        - underlyingAgreementActivationDetails
        - underlyingAgreementDocuments
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialNotices:
          type: array
          items:
            $ref: '#/components/schemas/FileInfoDTO'
        underlyingAgreementDocuments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/FileInfoDTO'
        underlyingAgreementActivationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementActivationDetails'
        underlyingAgreementActivationAttachments:
          type: object
          additionalProperties:
            type: string
    ContentDisposition:
      type: object
      properties:
        type:
          type: string
        name:
          type: string
        filename:
          type: string
        charset:
          type: string
        size:
          type: integer
          format: int64
          deprecated: true
        creationDate:
          type: string
          format: date-time
          deprecated: true
        modificationDate:
          type: string
          format: date-time
          deprecated: true
        readDate:
          type: string
          format: date-time
          deprecated: true
        attachment:
          type: boolean
        formData:
          type: boolean
        inline:
          type: boolean
    CcaNotifyOperatorForDecisionRequestTaskActionPayload:
      required:
        - decisionNotification
      type: object
      properties:
        payloadType:
          type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
    TargetUnitAccountCreationSubmitApplicationCreateActionPayload:
      required:
        - payload
      type: object
      properties:
        payloadType:
          type: string
        payload:
          $ref: '#/components/schemas/TargetUnitAccountPayload'
    CcaPeerReviewDecisionSubmittedRequestActionPayload:
      required:
        - decision
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        decision:
          $ref: '#/components/schemas/CcaPeerReviewDecision'
        peerReviewAttachments:
          type: object
          additionalProperties:
            type: string
    NoteRequest:
      required:
        - note
      type: object
      properties:
        note:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
      description: The note request
    AuditTrackCorrectiveActionsSubmittedRequestActionPayload:
      required:
        - auditTrackCorrectiveActions
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        auditTrackCorrectiveActions:
          $ref: '#/components/schemas/AuditTrackCorrectiveActions'
        facilityAuditAttachments:
          type: object
          additionalProperties:
            type: string
    AccountContactDTO:
      required:
        - accountId
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        userId:
          type: string
    UnderlyingAgreementSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementApplySavePayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    PreAuditReviewDetails:
      required:
        - auditDetermination
        - auditReasonDetails
        - requestedDocuments
      type: object
      properties:
        auditReasonDetails:
          $ref: '#/components/schemas/AuditReasonDetails'
        requestedDocuments:
          $ref: '#/components/schemas/RequestedDocuments'
        auditDetermination:
          $ref: '#/components/schemas/AuditDetermination'
    PerformanceDataFacilityDataUploadCompletedRequestActionPayload:
      required:
        - performanceDataUpload
        - results
        - uploadAttachments
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        performanceDataUpload:
          $ref: '#/components/schemas/PerformanceDataFacilityUpload'
        results:
          $ref: '#/components/schemas/PerformanceDataFacilityUploadResults'
        uploadAttachments:
          type: object
          additionalProperties:
            type: string
    PerformanceDataUploadSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        sectorAssociationInfo:
          $ref: '#/components/schemas/SectorAssociationInfo'
        performanceDataUpload:
          $ref: '#/components/schemas/PerformanceDataUpload'
        processCompleted:
          type: boolean
        errorMessage:
          type: string
        csvFile:
          $ref: '#/components/schemas/FileInfoDTO'
        totalFilesUploaded:
          type: integer
          format: int32
        filesSucceeded:
          type: integer
          format: int32
        filesFailed:
          type: integer
          format: int32
        errors:
          type: object
          additionalProperties:
            type: string
        accountReports:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TargetUnitAccountUploadReport'
        performanceDataUploadAttachments:
          type: object
          additionalProperties:
            type: string
    NonComplianceConclusionSubmitRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        nonComplianceConclusion:
          $ref: '#/components/schemas/NonComplianceConclusion'
        appealDetails:
          $ref: '#/components/schemas/NonComplianceAppealDetails'
        closeJustification:
          $ref: '#/components/schemas/NonComplianceCloseJustification'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
    UnderlyingAgreementSaveReviewGroupDecisionRequestTaskActionPayload:
      required:
        - decision
        - group
      type: object
      properties:
        payloadType:
          type: string
        determination:
          $ref: '#/components/schemas/Determination'
        group:
          type: string
          enum:
            - TARGET_UNIT_DETAILS
            - TARGET_PERIOD5_DETAILS
            - TARGET_PERIOD6_DETAILS
            - AUTHORISATION_AND_ADDITIONAL_EVIDENCE
        decision:
          $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    AdminTerminationWithdrawSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        adminTerminationWithdrawReasonDetails:
          $ref: '#/components/schemas/AdminTerminationWithdrawReasonDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    SubsistenceFeesMoaTargetUnitSearchResultInfoDTO:
      type: object
      properties:
        moaTargetUnitId:
          type: integer
          format: int64
        businessId:
          type: string
        name:
          type: string
        markFacilitiesStatus:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - CANCELLED
        currentTotalAmount:
          type: string
          format: decimal
    TargetPeriodYearDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        businessId:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        name:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        performanceDataTemplateVersion:
          type: string
        performanceDataStartDate:
          type: string
          format: date
        performanceDataEndDate:
          type: string
          format: date
        buyOutStartDate:
          type: string
          format: date
        buyOutEndDate:
          type: string
          format: date
        buyOutCost:
          type: integer
          format: int32
        secondaryReportingStartDate:
          type: string
          format: date
        current:
          type: boolean
    AvailableTargetPeriodsBuyOutDTO:
      type: object
      properties:
        currentTargetPeriods:
          type: array
          items:
            $ref: '#/components/schemas/TargetPeriodBuyOutDetailsDTO'
        previousTargetPeriods:
          type: array
          items:
            $ref: '#/components/schemas/TargetPeriodBuyOutDetailsDTO'
    RequestNoteResponse:
      type: object
      properties:
        requestNotes:
          type: array
          items:
            $ref: '#/components/schemas/RequestNoteDto'
        totalItems:
          type: integer
          format: int64
    PerformanceDataFacilityInputData:
      required:
        - energyFuelDetails
        - throughputDetails
      type: object
      properties:
        energyFuelDetails:
          $ref: '#/components/schemas/PerformanceDataFacilityInputEnergyFuelDetails'
        throughputDetails:
          $ref: '#/components/schemas/PerformanceDataFacilityThroughputDetails'
        calculatedResults:
          $ref: '#/components/schemas/PerformanceDataFacilityCalculatedResults'
    NonComplianceNoticeOfIntentPeerReviewRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        noticeOfIntent:
          $ref: '#/components/schemas/NonComplianceNoticeOfIntent'
        closeJustification:
          $ref: '#/components/schemas/NonComplianceCloseJustification'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
        decision:
          $ref: '#/components/schemas/CcaPeerReviewDecision'
        peerReviewAttachments:
          type: object
          additionalProperties:
            type: string
    SubsistenceFeesMoaFacilityMarkingStatusDTO:
      required:
        - filterResourceIds
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - CANCELLED
        filterResourceIds:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int64
      description: Status details of facilities based on moa facility ids
    RequestTaskActionEmptyPayload:
      type: object
      properties:
        payloadType:
          type: string
    UnderlyingAgreementActivationSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        underlyingAgreementActivationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementActivationDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    AccountAddressDTO:
      required:
        - city
        - country
        - line1
        - postcode
      type: object
      properties:
        line1:
          maxLength: 255
          minLength: 0
          type: string
        line2:
          maxLength: 255
          minLength: 0
          type: string
        city:
          maxLength: 255
          minLength: 0
          type: string
        postcode:
          maxLength: 255
          minLength: 0
          type: string
        county:
          maxLength: 255
          minLength: 0
          type: string
        country:
          maxLength: 255
          minLength: 0
          type: string
    FacilityAddressDTO:
      required:
        - city
        - country
        - line1
        - postcode
      type: object
      properties:
        line1:
          maxLength: 255
          minLength: 0
          type: string
        line2:
          maxLength: 255
          minLength: 0
          type: string
        city:
          maxLength: 255
          minLength: 0
          type: string
        postcode:
          maxLength: 255
          minLength: 0
          type: string
        county:
          maxLength: 255
          minLength: 0
          type: string
        country:
          maxLength: 255
          minLength: 0
          type: string
    AdminTerminationSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        adminTerminationReasonDetails:
          $ref: '#/components/schemas/AdminTerminationReasonDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    AccountSearchResults:
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountSearchResultInfoDTO'
        total:
          type: integer
          format: int64
    PeerReviewRequestTaskActionPayload:
      required:
        - peerReviewer
      type: object
      properties:
        payloadType:
          type: string
        peerReviewer:
          type: string
    CcaPeerReviewDecisionRequestTaskActionPayload:
      required:
        - decision
      type: object
      properties:
        payloadType:
          type: string
        decision:
          $ref: '#/components/schemas/CcaPeerReviewDecision'
        referencedAttachmentIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    TargetUnitAccountBusinessInfoDTO:
      type: object
      properties:
        accountId:
          type: integer
          format: int64
        businessId:
          type: string
        name:
          type: string
    RequestTaskActionProcessDTO:
      required:
        - requestTaskActionPayload
        - requestTaskActionType
        - requestTaskId
      type: object
      properties:
        requestTaskActionType:
          type: string
        requestTaskActionPayload:
          $ref: '#/components/schemas/RequestTaskActionPayload'
        requestTaskId:
          type: integer
          format: int64
      description: The request task action body
    NonComplianceAppealDetails:
      required:
        - registrationDate
      type: object
      properties:
        registrationDate:
          type: string
          format: date
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        comments:
          maxLength: 10000
          minLength: 0
          type: string
    RdeDecisionForcedRequestActionPayload:
      required:
        - rdeForceDecisionPayload
      type: object
      properties:
        payloadType:
          type: string
        rdeForceDecisionPayload:
          $ref: '#/components/schemas/RdeForceDecisionPayload'
        rdeAttachments:
          type: object
          additionalProperties:
            type: string
    PasswordValidationRequestDTO:
      required:
        - password
      type: object
      properties:
        password:
          type: string
      description: The password validation request
    FacilitySearchResults:
      type: object
      properties:
        facilities:
          type: array
          items:
            $ref: '#/components/schemas/FacilitySearchResultExtendedDTO'
        total:
          type: integer
          format: int64
    UnderlyingAgreementPeerReviewRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        workflowSchemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementProposed:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementFacilityReviewDecision'
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
        determination:
          $ref: '#/components/schemas/Determination'
        decision:
          $ref: '#/components/schemas/CcaPeerReviewDecision'
        peerReviewAttachments:
          type: object
          additionalProperties:
            type: string
    PerformanceDataSpreadsheetProcessingSubmittedRequestActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        performanceDataTargetPeriodType:
          type: string
          enum:
            - TP6
        accountReportFile:
          $ref: '#/components/schemas/FileInfoDTO'
        performanceData:
          $ref: '#/components/schemas/PerformanceData'
    SubsistenceFeesMoaSearchCriteria:
      required:
        - moaType
        - pageNumber
        - pageSize
      type: object
      properties:
        term:
          maxLength: 255
          minLength: 3
          type: string
        markFacilitiesStatus:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - CANCELLED
        pageNumber:
          minimum: 0
          type: integer
          format: int32
        pageSize:
          minimum: 1
          type: integer
          format: int32
        moaType:
          type: string
          enum:
            - SECTOR_MOA
            - TARGET_UNIT_MOA
        paymentStatus:
          type: string
          enum:
            - AWAITING_PAYMENT
            - PAID
            - CANCELLED
            - OVERPAID
      description: The search criteria
    SubsistenceFeesRunSearchResults:
      type: object
      properties:
        subsistenceFeesRuns:
          type: array
          items:
            $ref: '#/components/schemas/SubsistenceFeesRunSearchResultInfoDTO'
        total:
          type: integer
          format: int64
    PerformanceAccountTemplateDataUploadProcessingRequestTaskActionPayload:
      required:
        - reportPackages
        - targetPeriodType
      type: object
      properties:
        payloadType:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        reportPackages:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    DocumentTemplateSearchResults:
      type: object
      properties:
        templates:
          type: array
          items:
            $ref: '#/components/schemas/DocumentTemplateInfoDTO'
        total:
          type: integer
          format: int64
    SectorAssociationHeaderInfoDTO:
      type: object
      properties:
        name:
          type: string
        businessId:
          type: string
    AuditDetailsCorrectiveActionsSubmittedRequestActionPayload:
      required:
        - auditDetailsAndCorrectiveActions
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        auditDetailsAndCorrectiveActions:
          $ref: '#/components/schemas/AuditDetailsAndCorrectiveActions'
        facilityAuditAttachments:
          type: object
          additionalProperties:
            type: string
    BuyOutSurplusRunCompletedRequestActionPayload:
      required:
        - runSummary
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        runSummary:
          $ref: '#/components/schemas/BuyOutSurplusRunSummary'
        errorType:
          type: string
          enum:
            - GENERATE_CSV_FAILED
        csvFile:
          $ref: '#/components/schemas/FileInfoDTO'
    CaExternalContactRegistrationDTO:
      required:
        - description
        - email
        - name
      type: object
      properties:
        name:
          maxLength: 100
          minLength: 0
          type: string
        email:
          maxLength: 255
          minLength: 0
          type: string
        description:
          maxLength: 100
          minLength: 0
          type: string
      description: The ca external information
    UserTermsVersionDTO:
      type: object
      properties:
        termsVersion:
          type: integer
          format: int32
    UnderlyingAgreementVariationPeerReviewRequestTaskPayload:
      type: object
      properties:
        payloadType:
          type: string
        sendEmailNotification:
          type: boolean
        workflowSchemeVersion:
          type: string
          enum:
            - CCA_2
            - CCA_3
        accountReferenceData:
          $ref: '#/components/schemas/AccountReferenceData'
        originalUnderlyingAgreementContainer:
          $ref: '#/components/schemas/UnderlyingAgreementContainer'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
        reviewAttachments:
          type: object
          additionalProperties:
            type: string
        underlyingAgreementProposed:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
        determination:
          $ref: '#/components/schemas/VariationDetermination'
        decision:
          $ref: '#/components/schemas/CcaPeerReviewDecision'
        peerReviewAttachments:
          type: object
          additionalProperties:
            type: string
    AuditDetermination:
      required:
        - furtherAuditNeeded
        - reviewCompletionDate
      type: object
      properties:
        reviewCompletionDate:
          type: string
          format: date
        furtherAuditNeeded:
          type: boolean
        reviewComments:
          maxLength: 1000
          minLength: 0
          type: string
    SchemeData:
      type: object
      properties:
        sectorMeasurementType:
          type: string
          enum:
            - ENERGY_KWH
            - ENERGY_MWH
            - ENERGY_GJ
            - CARBON_KG
            - CARBON_TONNE
        sectorThroughputUnit:
          type: string
    TokenDTO:
      required:
        - token
      type: object
      properties:
        token:
          type: string
      description: The change 2FA token
    TargetUnitAccountContactDTO:
      required:
        - address
        - email
        - firstName
        - lastName
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        address:
          $ref: '#/components/schemas/AccountAddressDTO'
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
    NonComplianceConclusionSubmittedRequestActionPayload:
      required:
        - nonComplianceConclusion
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        nonComplianceConclusion:
          $ref: '#/components/schemas/NonComplianceConclusion'
        decisionNotification:
          $ref: '#/components/schemas/DecisionNotification'
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
    FacilityPerformanceDataUpdateLockDTO:
      required:
        - locked
        - targetPeriodType
        - targetPeriodYear
      type: object
      properties:
        locked:
          type: boolean
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodYear:
          type: integer
          format: int16
    FacilityDetails:
      required:
        - applicationReason
        - facilityAddress
        - isCoveredByUkets
        - name
        - participatingSchemeVersions
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 0
          type: string
        isCoveredByUkets:
          type: boolean
        uketsId:
          maxLength: 255
          minLength: 0
          type: string
        applicationReason:
          type: string
          enum:
            - NEW_AGREEMENT
            - CHANGE_OF_OWNERSHIP
        previousFacilityId:
          maxLength: 255
          minLength: 0
          pattern: ^[A-Z0-9_]+-F\d{5}$
          type: string
        participatingSchemeVersions:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - CCA_2
              - CCA_3
        facilityAddress:
          $ref: '#/components/schemas/FacilityAddressDTO'
    RegulatorUserAuthorityInfoDTO:
      type: object
      properties:
        userId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
        authorityCreationDate:
          type: string
          format: date-time
        authorityStatus:
          type: string
          enum:
            - PENDING
            - TEMP_DISABLED_PENDING
            - ACTIVE
            - DISABLED
            - ACCEPTED
            - TEMP_DISABLED
    UnderlyingAgreementVariationSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreementVariationApplySavePayload'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
        reviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementReviewDecision'
        facilitiesReviewGroupDecisions:
          type: object
          additionalProperties:
            $ref: >-
              #/components/schemas/UnderlyingAgreementVariationFacilityReviewDecision
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    FacilityHeaderInfoDTO:
      type: object
      properties:
        name:
          type: string
        businessId:
          type: string
        status:
          type: string
          enum:
            - LIVE
            - INACTIVE
    UpdateTargetUnitAccountResponsiblePersonDTO:
      type: object
      properties:
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
      description: The updated data for responsible person
    PerformanceDataFacilityContainer:
      required:
        - baselineAndTargets
        - calculatedResults
        - energyFuelDetails
        - throughputDetails
      type: object
      properties:
        baselineAndTargets:
          $ref: '#/components/schemas/PerformanceDataFacilityBaselineAndTargets'
        energyFuelDetails:
          $ref: '#/components/schemas/PerformanceDataFacilityEnergyFuelDetails'
        throughputDetails:
          $ref: '#/components/schemas/PerformanceDataFacilityThroughputDetails'
        calculatedResults:
          $ref: '#/components/schemas/PerformanceDataFacilityCalculatedResults'
    RegulatorUserDTO:
      required:
        - email
        - firstName
        - jobTitle
        - lastName
        - phoneNumber
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          maxLength: 255
          minLength: 0
          type: string
        mobileNumber:
          maxLength: 255
          minLength: 0
          type: string
        signature:
          $ref: '#/components/schemas/FileInfoDTO'
    UpdateTargetUnitAccountSicCodeDTO:
      type: object
      properties:
        sicCodes:
          maxItems: 4
          minItems: 0
          type: array
          items:
            maxLength: 255
            minLength: 0
            type: string
      description: The updated data for sic codes
    RequestNoteRequest:
      required:
        - note
        - requestId
      type: object
      properties:
        note:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        requestId:
          type: string
      description: The request note request
    TargetUnitAccountCreationSubmittedRequestActionPayload:
      required:
        - payload
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        payload:
          $ref: '#/components/schemas/TargetUnitAccountPayload'
    VariationRegulatorLedDetermination:
      required:
        - variationImpactsAgreement
      type: object
      properties:
        variationImpactsAgreement:
          type: boolean
        additionalInformation:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    Targets:
      required:
        - improvement
      type: object
      properties:
        improvement:
          type: string
          format: decimal
        target:
          type: string
          format: decimal
    UnderlyingAgreementContainer:
      required:
        - schemeDataMap
        - underlyingAgreement
      type: object
      properties:
        schemeDataMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SchemeData'
        underlyingAgreement:
          $ref: '#/components/schemas/UnderlyingAgreement'
        excludedFacilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Facility'
        underlyingAgreementAttachments:
          type: object
          additionalProperties:
            type: string
    NonComplianceCloseJustification:
      required:
        - reason
      type: object
      properties:
        reason:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    OneTimePasswordDTO:
      required:
        - password
      type: object
      properties:
        password:
          type: string
      description: The one time authenticator code
    PreAuditReviewSubmittedRequestActionPayload:
      required:
        - preAuditReviewDetails
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        preAuditReviewDetails:
          $ref: '#/components/schemas/PreAuditReviewDetails'
        facilityAuditAttachments:
          type: object
          additionalProperties:
            type: string
    UpdateTargetUnitAccountFinancialIndependenceStatusCodeDTO:
      required:
        - financialIndependenceStatus
      type: object
      properties:
        financialIndependenceStatus:
          type: string
          enum:
            - NON_FINANCIALLY_INDEPENDENT
            - FINANCIALLY_INDEPENDENT
      description: The updated data for financial independenceStatus code
    UnderlyingAgreementVariationActivationSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        underlyingAgreementActivationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementActivationDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    PerformanceDataUpload:
      required:
        - performanceDataTargetPeriodType
        - reportPackages
      type: object
      properties:
        performanceDataTargetPeriodType:
          type: string
          enum:
            - TP6
        reportPackages:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    RequestActionDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        payload:
          $ref: '#/components/schemas/RequestActionPayload'
        requestId:
          type: string
        requestType:
          type: string
        requestAccountId:
          type: integer
          format: int64
        competentAuthority:
          type: string
          enum:
            - ENGLAND
            - NORTHERN_IRELAND
            - OPRED
            - SCOTLAND
            - WALES
        submitter:
          type: string
        creationDate:
          type: string
          format: date-time
    EnergyOrCarbonSavingActionsAndMeasuresImplementedItem:
      required:
        - actionCategoryType
        - energyConsumptionOrCarbonEmissionsImpactedPercentage
        - estimatedChangeInCarbonEmissionsPercentage
        - estimatedChangeInEnergyConsumptionPercentage
        - expectedExtentOfChangeImplementedPercentage
        - expectedSavingsFromTheChangeImplementedPercentage
        - fixedEnergyConsumptionOrCarbonEmissionsImpacted
        - implementationDate
        - reasonsForImplementation
        - savingActionsImplemented
      type: object
      properties:
        facilityId:
          type: string
        actionCategoryType:
          type: string
          enum:
            - ENERGY_MANAGEMENT
            - PROCESS_OPTIMISATION
            - NEW_TECHNOLOGY_UPTAKE
            - INSULATION_IMPROVEMENT
            - INFRASTRUCTURE_IMPROVEMENT
            - SWITCHING_NON_RENEWABLE_FUELS
            - HEAT_RECOVERY
            - SWITCHING_TO_CHP
            - SWITCHING_TO_BIOMASS_HEATING
            - SWITCHING_TO_RENEWABLE_POWER
            - OTHER_CONTRIBUTIONS
        savingActionsImplemented:
          type: string
        reasonsForImplementation:
          type: string
        implementationDate:
          type: string
        fixedEnergyConsumptionOrCarbonEmissionsImpacted:
          type: string
          enum:
            - FIXED
            - VARIABLE
            - FIXED_AND_VARIABLE
        energyConsumptionOrCarbonEmissionsImpactedPercentage:
          type: string
          format: decimal
        expectedExtentOfChangeImplementedPercentage:
          type: string
          format: decimal
        expectedSavingsFromTheChangeImplementedPercentage:
          type: string
          format: decimal
        estimatedChangeInEnergyConsumptionPercentage:
          type: string
          format: decimal
        estimatedChangeInCarbonEmissionsPercentage:
          type: string
          format: decimal
        notes:
          type: string
    Facility:
      required:
        - apply70Rule
        - eligibilityDetailsAndAuthorisation
        - facilityContact
        - facilityDetails
        - facilityExtent
        - facilityId
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - NEW
            - LIVE
            - EXCLUDED
        excludedDate:
          type: string
          format: date
        facilityId:
          maxLength: 255
          minLength: 0
          pattern: ^[A-Z0-9_]+-F\d{5}$
          type: string
        facilityDetails:
          $ref: '#/components/schemas/FacilityDetails'
        facilityContact:
          $ref: '#/components/schemas/TargetUnitAccountContactDTO'
        eligibilityDetailsAndAuthorisation:
          $ref: '#/components/schemas/EligibilityDetailsAndAuthorisation'
        facilityExtent:
          $ref: '#/components/schemas/FacilityExtent'
        apply70Rule:
          $ref: '#/components/schemas/Apply70Rule'
        cca3BaselineAndTargets:
          $ref: '#/components/schemas/Cca3FacilityBaselineAndTargets'
    RegulatorInvitedUserDTO:
      required:
        - email
        - firstName
        - jobTitle
        - lastName
        - permissions
        - phoneNumber
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          maxLength: 255
          minLength: 0
          type: string
        mobileNumber:
          maxLength: 255
          minLength: 0
          type: string
        permissions:
          type: object
          additionalProperties:
            type: string
            enum:
              - NONE
              - VIEW_ONLY
              - EXECUTE
      description: The regulator to invite
    UserDTO:
      required:
        - email
        - firstName
        - lastName
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
    SectorUserAuthorityUpdateDTO:
      required:
        - authorityStatus
        - userId
      type: object
      properties:
        userId:
          type: string
        roleCode:
          type: string
        authorityStatus:
          type: string
          enum:
            - PENDING
            - TEMP_DISABLED_PENDING
            - ACTIVE
            - DISABLED
            - ACCEPTED
            - TEMP_DISABLED
    UnderlyingAgreementVariationRegulatorLedSavePayload:
      required:
        - authorisationAndAdditionalEvidence
        - facilities
        - underlyingAgreementTargetUnitDetails
        - underlyingAgreementVariationDetails
      type: object
      properties:
        underlyingAgreementTargetUnitDetails:
          $ref: '#/components/schemas/UnderlyingAgreementTargetUnitDetails'
        underlyingAgreementVariationDetails:
          $ref: '#/components/schemas/UnderlyingAgreementVariationDetails'
        facilities:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Facility'
        facilityChargeStartDateMap:
          type: object
          additionalProperties:
            type: string
            format: date
        targetPeriod5Details:
          $ref: '#/components/schemas/TargetPeriod5Details'
        targetPeriod6Details:
          $ref: '#/components/schemas/TargetPeriod6Details'
        authorisationAndAdditionalEvidence:
          $ref: '#/components/schemas/AuthorisationAndAdditionalEvidence'
    NonComplianceClosedRequestActionPayload:
      required:
        - reason
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        reason:
          maxLength: 10000
          minLength: 0
          type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
    TermsDTO:
      required:
        - url
        - version
      type: object
      properties:
        url:
          type: string
        version:
          type: integer
          format: int32
    FacilityExtent:
      required:
        - annotatedSitePlansFile
        - areActivitiesClaimed
        - eligibleProcessFile
        - manufacturingProcessFile
        - processFlowFile
      type: object
      properties:
        manufacturingProcessFile:
          type: string
          format: uuid
        processFlowFile:
          type: string
          format: uuid
        annotatedSitePlansFile:
          type: string
          format: uuid
        eligibleProcessFile:
          type: string
          format: uuid
        areActivitiesClaimed:
          type: boolean
        activitiesDescriptionFile:
          type: string
          format: uuid
    TargetSetDTO:
      required:
        - energyOrCarbonUnit
        - id
        - targetCurrencyType
      type: object
      properties:
        id:
          type: integer
          format: int64
        targetCurrencyType:
          maxLength: 255
          minLength: 0
          type: string
        throughputUnit:
          maxLength: 255
          minLength: 0
          type: string
        energyOrCarbonUnit:
          maxLength: 255
          minLength: 0
          type: string
        targetCommitments:
          type: array
          items:
            $ref: '#/components/schemas/TargetCommitmentDTO'
    RequestNoteDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        payload:
          $ref: '#/components/schemas/NotePayload'
        submitter:
          type: string
        lastUpdatedOn:
          type: string
          format: date-time
        requestId:
          type: string
    FacilityAuditViewDTO:
      type: object
      properties:
        auditRequired:
          type: boolean
        reasons:
          type: array
          items:
            type: string
            enum:
              - ELIGIBILITY
              - SEVENTY_RULE_EVALUATION
              - BASE_YEAR_DATA
              - REPORTING_DATA
              - NON_COMPLIANCE
              - OTHER
        comments:
          type: string
        editable:
          type: boolean
    TargetPeriodPerformanceResult:
      required:
        - tpOutcome
        - tpPerformance
        - tpPerformancePercent
      type: object
      properties:
        targetEnergyCarbonTpThroughput:
          type: string
          format: decimal
        byEnergyCarbonTpThroughput:
          type: string
          format: decimal
        tpPerformance:
          type: string
          format: decimal
        tpPerformancePercent:
          type: string
          format: decimal
        tpOutcome:
          type: string
          enum:
            - TARGET_MET
            - BUY_OUT_REQUIRED
            - SURPLUS_USED_BUY_OUT_REQUIRED
            - SURPLUS_USED
            - OUTSTANDING
    BuyOutSurplusTransactionUpdateAmountDTO:
      required:
        - amount
        - comments
      type: object
      properties:
        amount:
          type: string
          format: decimal
        comments:
          maxLength: 10000
          minLength: 0
          type: string
        evidenceFiles:
          type: object
          additionalProperties:
            type: string
      description: The Transaction Update Amount
    PerformanceAccountTemplateDataContainer:
      required:
        - file
        - targetUnitIdentityAndPerformance
      type: object
      properties:
        targetUnitIdentityAndPerformance:
          $ref: '#/components/schemas/TargetUnitIdentityAndPerformance'
        energyOrCarbonSavingActionsAndMeasuresImplementedItems:
          type: array
          items:
            $ref: >-
              #/components/schemas/EnergyOrCarbonSavingActionsAndMeasuresImplementedItem
        file:
          $ref: '#/components/schemas/FileInfoDTO'
    InvitedUserCredentialsDTO:
      required:
        - invitationToken
        - password
      type: object
      properties:
        invitationToken:
          type: string
        password:
          type: string
      description: The operator user credentials
    UnderlyingAgreementVariationNotifyOperatorForDecisionRequestTaskActionPayload:
      required:
        - decisionNotification
        - underlyingAgreementProposed
      type: object
      properties:
        payloadType:
          type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        underlyingAgreementProposed:
          $ref: '#/components/schemas/UnderlyingAgreementVariationPayload'
    Cca3ExistingFacilitiesMigrationAccountProcessingActivatedRequestActionPayload:
      required:
        - activationDetails
        - decisionNotification
        - defaultContacts
        - officialNotice
        - underlyingAgreementDocument
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        activationDetails:
          $ref: >-
            #/components/schemas/Cca3ExistingFacilitiesMigrationAccountProcessingActivationDetails
        activationAttachments:
          type: object
          additionalProperties:
            type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        officialNotice:
          $ref: '#/components/schemas/FileInfoDTO'
        underlyingAgreementDocument:
          $ref: '#/components/schemas/FileInfoDTO'
    SectorAssociationDetails:
      type: object
      properties:
        subsectorAssociationName:
          type: string
        schemeDataMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SchemeData'
    AdminTerminationFinalDecisionSaveRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        adminTerminationFinalDecisionReasonDetails:
          $ref: '#/components/schemas/AdminTerminationFinalDecisionReasonDetails'
        sectionsCompleted:
          type: object
          additionalProperties:
            type: string
    Cca3ExistingFacilitiesMigrationAccountProcessingActivationDetails:
      required:
        - evidenceFiles
      type: object
      properties:
        evidenceFiles:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        comments:
          maxLength: 10000
          minLength: 0
          type: string
    FacilityItem:
      required:
        - apply70Rule
        - eligibilityDetailsAndAuthorisation
        - facilityContact
        - facilityDetails
        - facilityExtent
        - facilityId
      type: object
      properties:
        facilityId:
          maxLength: 255
          minLength: 0
          pattern: ^[A-Z0-9_]+-F\d{5}$
          type: string
        facilityDetails:
          $ref: '#/components/schemas/FacilityDetails'
        facilityContact:
          $ref: '#/components/schemas/TargetUnitAccountContactDTO'
        eligibilityDetailsAndAuthorisation:
          $ref: '#/components/schemas/EligibilityDetailsAndAuthorisation'
        facilityExtent:
          $ref: '#/components/schemas/FacilityExtent'
        apply70Rule:
          $ref: '#/components/schemas/Apply70Rule'
        cca3BaselineAndTargets:
          $ref: '#/components/schemas/Cca3FacilityBaselineAndTargets'
    TargetPeriodBuyOutCostUpdateDTO:
      required:
        - buyOutCost
      type: object
      properties:
        buyOutCost:
          type: integer
          format: int32
      description: The buy-out cost
    TP6PerformanceData:
      required:
        - actualTargetPeriodPerformance
        - buyOutCost
        - performanceResult
        - primaryDetermination
        - secondaryDetermination
        - sector
        - submissionType
        - targetPeriod
        - targetType
        - targetUnitDetails
        - templateVersion
        - type
      type: object
      allOf:
        - $ref: '#/components/schemas/PerformanceData'
        - type: object
          properties:
            targetUnitDetails:
              $ref: '#/components/schemas/PerformanceDataTargetUnitDetails'
            actualTargetPeriodPerformance:
              $ref: '#/components/schemas/ActualTargetPeriodPerformance'
            performanceResult:
              $ref: '#/components/schemas/TargetPeriodPerformanceResult'
            primaryDetermination:
              $ref: '#/components/schemas/PrimaryDetermination'
            secondaryDetermination:
              $ref: '#/components/schemas/SecondaryDetermination'
    ProductVariableEnergyConsumptionData:
      required:
        - baselineYear
        - energy
        - productName
        - productStatus
        - throughput
        - throughputUnit
      type: object
      properties:
        productName:
          maxLength: 255
          minLength: 0
          type: string
        baselineYear:
          type: integer
          format: int16
        productStatus:
          type: string
          enum:
            - NEW
            - LIVE
            - EXCLUDED
        energy:
          type: string
          format: decimal
        throughput:
          type: string
          format: decimal
        throughputUnit:
          maxLength: 255
          minLength: 0
          type: string
        energyCarbonIntensity:
          type: string
          format: decimal
          readOnly: true
    UnderlyingAgreementSaveReviewDeterminationRequestTaskActionPayload:
      type: object
      properties:
        payloadType:
          type: string
        determination:
          $ref: '#/components/schemas/Determination'
        reviewSectionsCompleted:
          type: object
          additionalProperties:
            type: string
    AddressDTO:
      required:
        - city
        - line1
        - postcode
      type: object
      properties:
        line1:
          maxLength: 255
          minLength: 0
          type: string
        line2:
          maxLength: 255
          minLength: 0
          type: string
        city:
          maxLength: 255
          minLength: 0
          type: string
        county:
          maxLength: 255
          minLength: 0
          type: string
        postcode:
          maxLength: 64
          minLength: 0
          type: string
    RequestSearchCriteria:
      required:
        - historyCategory
        - pageNumber
        - pageSize
        - resourceId
        - resourceType
      type: object
      properties:
        resourceType:
          type: string
        resourceId:
          type: string
        requestTypes:
          uniqueItems: true
          type: array
          items:
            type: string
        requestStatuses:
          uniqueItems: true
          type: array
          items:
            type: string
        historyCategory:
          type: string
        pageNumber:
          minimum: 0
          type: integer
          format: int32
        pageSize:
          minimum: 1
          type: integer
          format: int32
      description: The search criteria
    CertificationPeriodInfoDTO:
      required:
        - endDate
        - id
        - startDate
      type: object
      properties:
        id:
          type: integer
          format: int64
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
    PagingRequest:
      required:
        - pageNumber
        - pageSize
      type: object
      properties:
        pageNumber:
          minimum: 0
          type: integer
          format: int32
        pageSize:
          minimum: 1
          type: integer
          format: int32
    RequestCreateActionEmptyPayload:
      type: object
      properties:
        payloadType:
          type: string
    OtherFuel:
      required:
        - consumption
        - conversionFactor
      type: object
      properties:
        name:
          type: string
        conversionFactor:
          type: string
          format: decimal
        consumption:
          type: string
          format: decimal
    UnderlyingAgreementNotifyOperatorForDecisionRequestTaskActionPayload:
      required:
        - decisionNotification
        - underlyingAgreementProposed
      type: object
      properties:
        payloadType:
          type: string
        decisionNotification:
          $ref: '#/components/schemas/CcaDecisionNotification'
        underlyingAgreementProposed:
          $ref: '#/components/schemas/UnderlyingAgreementPayload'
    SectorUserAuthorityUpdateWrapperDTO:
      required:
        - sectorUserAuthorityUpdateDTOList
      type: object
      properties:
        sectorUserAuthorityUpdateDTOList:
          type: array
          items:
            $ref: '#/components/schemas/SectorUserAuthorityUpdateDTO'
      description: The sector user authority to update
    SecondaryMoASurplusBuyOutDTO:
      type: object
      properties:
        co2Emissions:
          type: string
          format: decimal
        priBuyOutCarbon:
          type: string
          format: decimal
        prevBuyOutCo2:
          type: string
          format: decimal
        prevSurplusUsed:
          type: string
          format: decimal
        prevSurplusGained:
          type: string
          format: decimal
        secondaryBuyOutCo2:
          type: string
          format: decimal
        secondaryBuyOutCost:
          type: string
          format: decimal
    TargetPeriodYear:
      required:
        - endDate
        - reportingStartDate
        - startDate
        - targetYear
      type: object
      properties:
        targetYear:
          type: integer
          format: int16
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        reportingStartDate:
          type: string
          format: date
        reportingEndDate:
          type: string
          format: date
    AuditTrackCorrectiveActions:
      required:
        - correctiveActionResponses
      type: object
      properties:
        correctiveActionResponses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AuditCorrectiveActionResponse'
    MiReportSystemParams:
      type: object
      properties:
        reportType:
          type: string
      description: The parameters based on which the report will be generated
      discriminator:
        propertyName: reportType
    SubsectorAssociationSchemeDTO:
      required:
        - id
        - targetSet
      type: object
      properties:
        id:
          type: integer
          format: int64
        targetSet:
          $ref: '#/components/schemas/TargetSetDTO'
        editable:
          type: boolean
    CcaOperatorUserDetailsDTO:
      required:
        - contactType
        - email
        - firstName
        - lastName
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        status:
          type: string
          enum:
            - REGISTERED
            - PENDING
            - DELETED
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        mobileNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        contactType:
          type: string
          enum:
            - SECTOR_ASSOCIATION
            - OPERATOR
            - CONSULTANT
        organisationName:
          type: string
    RequestCreateActionProcessResponseDTO:
      type: object
      properties:
        requestId:
          type: string
    FacilityInfoDTO:
      type: object
      properties:
        facilityId:
          type: integer
          format: int64
        facilityBusinessId:
          type: string
        status:
          type: string
          enum:
            - LIVE
            - INACTIVE
        chargeStartDate:
          type: string
          format: date
        siteName:
          type: string
        schemeExitDate:
          type: string
          format: date
        address:
          $ref: '#/components/schemas/FacilityAddressDTO'
        facilityCertificationDetails:
          type: array
          items:
            $ref: '#/components/schemas/FacilityCertificationDetailsDTO'
    FacilityCertificationStatusUpdateDTO:
      required:
        - certificationPeriodId
        - certificationStatus
      type: object
      properties:
        certificationPeriodId:
          type: integer
          format: int64
        certificationStatus:
          type: string
          enum:
            - CERTIFIED
            - DECERTIFIED
            - NOT_YET_DEFINED
        startDate:
          type: string
          format: date
      description: The updated certification status
    RfiSubmitPayload:
      required:
        - deadline
        - questions
        - signatory
      type: object
      properties:
        questions:
          type: array
          items:
            maxLength: 10000
            minLength: 0
            type: string
        files:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        deadline:
          type: string
          format: date
        operators:
          uniqueItems: true
          type: array
          items:
            type: string
        signatory:
          type: string
    NonComplianceNoticeOfIntentSubmittedRequestActionPayload:
      required:
        - decisionNotification
        - defaultContacts
        - noticeOfIntent
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        noticeOfIntent:
          $ref: '#/components/schemas/NonComplianceNoticeOfIntent'
        decisionNotification:
          $ref: '#/components/schemas/DecisionNotification'
        nonComplianceAttachments:
          type: object
          additionalProperties:
            type: string
        usersInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RequestActionUserInfo'
        defaultContacts:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
    PerformanceDataFacilityFuel:
      required:
        - conversionFactor
        - deliveredEnergy
        - name
        - primaryConversionFactor
        - primaryEnergy
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 0
          type: string
        fixedConversionFactorCode:
          type: string
          enum:
            - GRID_ELECTRICITY
            - NON_GRID_ELECTRICITY
            - NATURAL_GAS
            - LPG
            - GAS_DIESEL_OIL
            - FUEL_OIL
            - KEROSENE
            - COAL
            - COKE
            - PETROL
            - NITROGEN_COOLING
            - CARBON_DIOXIDE_COOLING
            - ETHANE
            - NAPHTHA
            - PETROLEUM_COKE
            - REFINERY_GAS
        conversionFactor:
          type: string
          format: decimal
        deliveredEnergy:
          type: string
          format: decimal
        primaryConversionFactor:
          type: string
          format: decimal
        primaryEnergy:
          type: string
          format: decimal
    SectorUserAuthorityInfoDTO:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        roleName:
          type: string
        roleCode:
          type: string
        contactType:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - TEMP_DISABLED_PENDING
            - ACTIVE
            - DISABLED
            - ACCEPTED
            - TEMP_DISABLED
        userId:
          type: string
    TargetCommitmentsUpdateDTO:
      required:
        - targetCommitments
      type: object
      properties:
        targetCommitments:
          type: array
          items:
            $ref: '#/components/schemas/TargetCommitmentUpdateDTO'
      description: The sector association scheme commitments fields
    CustomMiReportQuery:
      required:
        - sqlQuery
      type: object
      properties:
        sqlQuery:
          type: string
      description: The custom sql query
    NotificationTemplateInfoDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        roleType:
          type: string
        workflow:
          type: string
        lastUpdatedDate:
          type: string
          format: date-time
    RequestedDocuments:
      required:
        - auditMaterialReceivedDate
      type: object
      properties:
        auditMaterialReceivedDate:
          type: string
          format: date
        manufacturingProcessFile:
          type: string
          format: uuid
        processFlowMapsFile:
          type: string
          format: uuid
        annotatedSitePlansFile:
          type: string
          format: uuid
        eligibleProcessFile:
          type: string
          format: uuid
        directlyAssociatedActivitiesFile:
          type: string
          format: uuid
        seventyPerCentRuleEvidenceFile:
          type: string
          format: uuid
        baseYearTargetPeriodEvidenceFiles:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        additionalDocuments:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
        additionalInformation:
          maxLength: 10000
          minLength: 0
          type: string
    RdePayload:
      required:
        - deadline
        - extensionDate
        - signatory
      type: object
      properties:
        extensionDate:
          type: string
          format: date
        deadline:
          type: string
          format: date
        operators:
          uniqueItems: true
          type: array
          items:
            type: string
        signatory:
          type: string
    RegulatorUserUpdateStatusDTO:
      required:
        - authorityStatus
        - userId
      type: object
      properties:
        userId:
          type: string
        authorityStatus:
          type: string
          enum:
            - PENDING
            - TEMP_DISABLED_PENDING
            - ACTIVE
            - DISABLED
            - ACCEPTED
            - TEMP_DISABLED
    PerformanceDataUploadProcessingRequestTaskActionPayload:
      required:
        - performanceDataUpload
      type: object
      properties:
        payloadType:
          type: string
        performanceDataUpload:
          $ref: '#/components/schemas/PerformanceDataUpload'
    UnderlyingAgreementDetailsDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        underlyingAgreementDocumentMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UnderlyingAgreementDocumentDetailsDTO'
    UserTermsVersionUpdateDTO:
      required:
        - version
      type: object
      properties:
        version:
          type: integer
          format: int32
    ItemDTOResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ItemDTO'
        totalItems:
          type: integer
          format: int64
    SectorUserAuthorityDetailsDTO:
      required:
        - contactType
        - email
        - firstName
        - lastName
      type: object
      properties:
        email:
          maxLength: 255
          minLength: 0
          type: string
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        status:
          type: string
          enum:
            - REGISTERED
            - PENDING
            - DELETED
        jobTitle:
          maxLength: 255
          minLength: 0
          type: string
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        mobileNumber:
          $ref: '#/components/schemas/PhoneNumberDTO'
        contactType:
          type: string
          enum:
            - SECTOR_ASSOCIATION
            - OPERATOR
            - CONSULTANT
        organisationName:
          type: string
    TargetUnitAccountDetailsDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        businessId:
          type: string
        status:
          type: string
          enum:
            - NEW
            - LIVE
            - CANCELLED
            - TERMINATED
            - REJECTED
        name:
          type: string
        competentAuthority:
          type: string
          enum:
            - ENGLAND
            - NORTHERN_IRELAND
            - OPRED
            - SCOTLAND
            - WALES
        operatorType:
          type: string
          enum:
            - LIMITED_COMPANY
            - PARTNERSHIP
            - SOLE_TRADER
            - NONE
        companyRegistrationNumber:
          type: string
        registrationNumberMissingReason:
          type: string
        sicCodes:
          type: array
          items:
            type: string
        sectorAssociationId:
          type: integer
          format: int64
        subsectorAssociationId:
          type: integer
          format: int64
        financialIndependenceStatus:
          type: string
          enum:
            - NON_FINANCIALLY_INDEPENDENT
            - FINANCIALLY_INDEPENDENT
        address:
          $ref: '#/components/schemas/AccountAddressDTO'
        responsiblePerson:
          $ref: '#/components/schemas/TargetUnitAccountContactDTO'
        administrativeContactDetails:
          $ref: '#/components/schemas/TargetUnitAccountContactDTO'
        createdBy:
          type: string
    AccountPerformanceAccountTemplateDataReportDetailsDTO:
      type: object
      properties:
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        targetPeriodName:
          type: string
        targetPeriodYear:
          type: integer
          format: int16
        data:
          $ref: '#/components/schemas/PerformanceAccountTemplateDataContainer'
    PerformanceDataFacilityUploadResults:
      type: object
      properties:
        totalFilesUploaded:
          type: integer
          format: int32
        facilitiesSucceeded:
          type: integer
          format: int32
        facilitiesFailed:
          type: integer
          format: int32
        uploadSummaryFile:
          type: string
          format: uuid
        submittedDate:
          type: string
          format: date-time
    TargetUnitMoaGeneratedRequestActionPayload:
      required:
        - chargingYear
        - moaDocument
        - paymentRequestId
        - recipients
        - transactionId
      type: object
      properties:
        payloadType:
          type: string
        businessId:
          type: string
        paymentRequestId:
          type: string
        chargingYear:
          type: integer
          format: int16
        transactionId:
          type: string
        moaDocument:
          $ref: '#/components/schemas/FileInfoDTO'
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNoticeRecipient'
    PaymentCancelRequestTaskActionPayload:
      required:
        - reason
      type: object
      properties:
        payloadType:
          type: string
        reason:
          type: string
    BuyOutSurplusAccountProcessingRequestMetadata:
      type: object
      properties:
        type:
          type: string
        parentRequestId:
          type: string
        accountBusinessId:
          type: string
        targetPeriodType:
          type: string
          enum:
            - TP5
            - TP6
            - TP7
            - TP8
            - TP9
        performanceDataId:
          type: integer
          format: int64
        performanceDataReportVersion:
          type: integer
          format: int32
        tpOutcome:
          type: string
          enum:
            - TARGET_MET
            - BUY_OUT_REQUIRED
            - SURPLUS_USED_BUY_OUT_REQUIRED
            - SURPLUS_USED
            - OUTSTANDING
        transactionCode:
          type: string
    RegulatorUserUpdateDTO:
      required:
        - permissions
        - user
      type: object
      properties:
        user:
          $ref: '#/components/schemas/RegulatorUserDTO'
        permissions:
          type: object
          additionalProperties:
            type: string
            enum:
              - NONE
              - VIEW_ONLY
              - EXECUTE
    ItemAssigneeDTO:
      type: object
      properties:
        taskAssignee:
          $ref: '#/components/schemas/UserInfoDTO'
        taskAssigneeType:
          type: string
    SubsistenceFeesMoaReceivedAmountDetailsDTO:
      required:
        - transactionAmount
      type: object
      properties:
        transactionAmount:
          type: string
          format: decimal
        comments:
          maxLength: 10000
          minLength: 0
          type: string
        evidenceFiles:
          type: object
          additionalProperties:
            type: string
      description: The received amount details
    RequestCreateActionPayload:
      type: object
      properties:
        payloadType:
          type: string
      discriminator:
        propertyName: payloadType
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer