openapi: 3.0.1
info:
  title: Fundacred - OpenApi Specification
  description: Documentação para a API renewal-api
  contact:
    name: Infra Fundacred
    email: infra@fundacred.org.br
  version: '1.1'
servers:
  - url: https://tst-api.fundacred.org.br/renewal-api
    description: TST
  - url: https://hml-api.fundacred.org.br/renewal-api
    description: HML
  - url: https://api.fundacred.org.br/renewal-api
    description: PRD
security:
  - bearerAuth: []
tags:
  - name: '[V3] Mais Ações'
    description: Ações executadas na jornada do estudante
  - name: '[V2] VALORES'
  - name: '[V2] PLANILHAS AUXILIARES'
  - name: '[V2] MANUTENÇÃO DE VÍNCULO'
  - name: '[V2] DASHBOARD'
  - name: '[V2] MATRICULA'
    description: Resource para a manipulação da situação da matrícula
  - name: '[V2] MAIS AÇÕES'
  - name: '[V2] JORNADAS'
  - name: '[V2] TIMELINE'
  - name: '[V2] NOTIFICAÇÕES'
  - name: '[V2] NOTIFICAÇÕES IEs'
  - name: '[V1] VALORES'
  - name: '[V1] TASKS'
  - name: '[V1] MATRICULA'
    description: Resource para a manipulação da situação da matrícula
  - name: '[V1] + AÇÕES'
  - name: '[V1] INCLUIR NA JORNADA'
    description: Resource para a manipulação de beneficiarios para inserir nas jornadas
  - name: '[V1] DASHBOARD'
    description: Resource para a consulta de dados do Dashboard
paths:
  /atualizar-tipo-ticket:
    put:
      tags:
        - update-controller
      operationId: update
      responses:
        '200':
          description: OK
  /s/v3/mais-acoes/trancamento:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Trancamento de Matrícula
      operationId: locking
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentLockInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/previsao-formatura:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Enviar nova previsão de formatura
      description: Nesta ação é possível informar dados para envio de valores.
      operationId: newGraduationDate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewGraduationDateInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/NewGraduationDateOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/manutencao-vinculo:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Manuntenção de Vínculo
      operationId: bondMaintenance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BondMaintenanceInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/manter-trancamento:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Manter Trancamento
      operationId: maintainLocking
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MaintainLockingInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/inativar-estudante:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Inativar estudante na jornada
      operationId: inactivateStudent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InactivateStudentInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/excluir-contrato:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Excluir Contrato
      operationId: deleteContract
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteContractInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/enviar-valores:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Enviar Valores
      operationId: sendValues
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendValuesInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SendValuesOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/cancelar-contrato:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Cancelar Contrato
      operationId: cancelContract
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelContractInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/alterar-status/trancamento:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Alterar Status - Trancamento
      description: >-
        Realizar a ação Alterar Status / Trancamento para estudantes na situação
        Sem Renovação.
      operationId: updateStatusLocking
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentLockInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/alterar-status/revisao-analise:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Alterar Status - Revisão de Análise
      description: >-
        Realizar a ação Alterar Status / Revisão de Análise para estudantes na
        situação Sem Renovação.
      operationId: updateStatusAnalysisReview
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalysisReviewInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/alterar-status/manutencao-vinculo:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Alterar Status - Manutenção de Vínculo
      description: >-
        Realizar a ação Alterar Status / Manutenção de Vínculo para estudantes
        na situação Sem Renovação.
      operationId: updateStatusBondMaintenance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BondMaintenanceInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/alterar-status/manter-trancamento:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Alterar Status - Manter Trancamento
      description: >-
        Realizar a ação Alterar Status / Manter Trancamento para estudantes na
        situação Sem Renovação.
      operationId: updateStatusMaintainLocking
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MaintainLockingInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/alterar-status/inativar-estudante:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Inativar estudante na aba Sem Renovação
      operationId: updateStatusInactivateStudent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InactivateStudentInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/alterar-status/enviar-valores:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Alterar Status - Enviar Valores
      description: >-
        Realizar a ação Alterar Status / enviar Valores para estudantes na
        situação Sem Renovação.
      operationId: updateStatusSendValues
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendValuesInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SendValuesOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/alterar-status/afastamento-evasao:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Alterar Status - Afastamento ou Evasão
      description: >-
        Realizar a ação Alterar Status / Afastamento ou Evasão para estudantes
        na situação Sem Renovação.
      operationId: updateStatusRemovalEvasion
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemovalEvasionInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/mais-acoes/afastamento-evasao:
    post:
      tags:
        - '[V3] Mais Ações'
      summary: Afastamento ou Evasão
      operationId: removalEvasion
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemovalEvasionInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '400':
          description: Falha ao processar dados necessários para a requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a realizar a ação na jornada do estudante
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/status-contrato/{contractId}/id-contrato/{studentshipId}/id-bolsa/excluir:
    post:
      tags:
        - contract-status-controller
      operationId: deleteContract_1
      parameters:
        - name: contractId
          in: path
          description: Id do Contrato
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketDetailInDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /s/v2/status-contrato/{contractId}/id-contrato/{studentshipId}/id-bolsa/excluir:
    post:
      tags:
        - contract-status-controller
      operationId: deleteContract_2
      parameters:
        - name: contractId
          in: path
          description: Id do Contrato
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketDetailInDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /s/v2/renovacao/status-contrato/{contractId}/id-contrato/{studentshipId}/id-bolsa/cancelar:
    post:
      tags:
        - contract-status-controller
      operationId: cancelContract_1
      parameters:
        - name: contractId
          in: path
          description: Id do Contrato
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketDetailInDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /s/v2/status-contrato/{contractId}/id-contrato/{studentshipId}/id-bolsa/cancelar:
    post:
      tags:
        - contract-status-controller
      operationId: cancelContract_2
      parameters:
        - name: contractId
          in: path
          description: Id do Contrato
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketDetailInDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /s/v2/renovacao/status-contrato/{brbId}/brb-id/alterar:
    post:
      tags:
        - '[V2] MAIS AÇÕES'
      summary: Alterar status da Jornada
      description: >-
        <h1>Alterar status da Jornada</h1>


        <h2>Parâmetros para Definição de Tipo Ação</h2>


        <h3>Revisão de Análise</h3>

        <p>{ "motivo": "string", "situacao": "REVISAO_ANALISE" }</p>


        <h3>Trancamento de Matrícula</h3>

        <p>{ "situacao": "TRANCAMENTO",  "situacaoMatricula": { "tipo": "D",
        "situacaoMatricula": "T", "data-ocorrido": "dd-mm-yyyy" } }</p>


        <h3>Afastamento ou Evasão</h3>

        <p>{ "situacao": "AFASTAMENTO_EVASAO", "situacaoMatricula": { "tipo":
        "F", "situacao-matricula": "S", "motivo": "5", "situacao-restituicao":
        "A", "data-ocorrido": "dd-mm-yyyy" } }</p>

        <p><i>ou</i></p>

        <p>{ "situacao": "AFASTAMENTO_EVASAO", "situacaoMatricula": { "tipo":
        "E", "situacao-matricula": "S", "motivo": "string",
        "situacao-restituicao": "A", "data-ocorrido": "dd-mm-yyyy" } }</p>


        <h3>Manutenção de Vínculo</h3>

        <p>{ "situacao": "MANUTENCAO_VINCULO", "situacaoMatricula": { "tipo" :
        "S", "motivo" : "string", "motivo-complementar" : "string",
        "situacao-matricula" : "A", "situacao-restituicao" : "A",
        "data-ocorrido" : "dd-mm-yyyy", "contratos-firmados" : number,
        "inicio-reembolso" : "yyyy-mm-dd"} }</p>


        <h3>Enviar Valores</h3>

        <p>{ "situacao": "ENVIO_VALORES", "valoresRenovacao": [{...campos }]</p>
      operationId: returnToAnalysisReview
      parameters:
        - name: brbId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalysisReviewInDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UpdateStatusOutDto'
  /s/v2/status-contrato/{brbId}/brb-id/alterar:
    post:
      tags:
        - '[V2] MAIS AÇÕES'
      summary: Alterar status da Jornada
      description: >-
        <h1>Alterar status da Jornada</h1>


        <h2>Parâmetros para Definição de Tipo Ação</h2>


        <h3>Revisão de Análise</h3>

        <p>{ "motivo": "string", "situacao": "REVISAO_ANALISE" }</p>


        <h3>Trancamento de Matrícula</h3>

        <p>{ "situacao": "TRANCAMENTO",  "situacaoMatricula": { "tipo": "D",
        "situacaoMatricula": "T", "data-ocorrido": "dd-mm-yyyy" } }</p>


        <h3>Afastamento ou Evasão</h3>

        <p>{ "situacao": "AFASTAMENTO_EVASAO", "situacaoMatricula": { "tipo":
        "F", "situacao-matricula": "S", "motivo": "5", "situacao-restituicao":
        "A", "data-ocorrido": "dd-mm-yyyy" } }</p>

        <p><i>ou</i></p>

        <p>{ "situacao": "AFASTAMENTO_EVASAO", "situacaoMatricula": { "tipo":
        "E", "situacao-matricula": "S", "motivo": "string",
        "situacao-restituicao": "A", "data-ocorrido": "dd-mm-yyyy" } }</p>


        <h3>Manutenção de Vínculo</h3>

        <p>{ "situacao": "MANUTENCAO_VINCULO", "situacaoMatricula": { "tipo" :
        "S", "motivo" : "string", "motivo-complementar" : "string",
        "situacao-matricula" : "A", "situacao-restituicao" : "A",
        "data-ocorrido" : "dd-mm-yyyy", "contratos-firmados" : number,
        "inicio-reembolso" : "yyyy-mm-dd"} }</p>


        <h3>Enviar Valores</h3>

        <p>{ "situacao": "ENVIO_VALORES", "valoresRenovacao": [{...campos }]</p>
      operationId: returnToAnalysisReview_1
      parameters:
        - name: brbId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalysisReviewInDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UpdateStatusOutDto'
  /s/v2/renovacao/situacao-matricula/trancamento:
    post:
      tags:
        - '[V2] MATRICULA'
      description: Realizar trancamento de matrícula
      operationId: executeEnrollmentLock
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentStatusV2InDto'
        required: true
      responses:
        '200':
          description: Sucesso ao realizar trancamento da matrícula.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnrollmentStatusV2OutDto'
        '400':
          description: 'Erro ao atualizar a situação da matrícula '
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para atualizar a situação da matrícula
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/situacao-matricula/manutencao-vinculo:
    post:
      tags:
        - '[V2] MATRICULA'
      description: Realizar manutenção de vínculo
      operationId: executeBondMaintenance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentStatusV2InDto'
        required: true
      responses:
        '200':
          description: Sucesso ao realizar manutenção de vínculo.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnrollmentStatusV2OutDto'
        '400':
          description: 'Erro ao atualizar a situação da matrícula '
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para atualizar a situação da matrícula
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/situacao-matricula/afastamento-evasao:
    post:
      tags:
        - '[V2] MATRICULA'
      description: Realizar afastamento ou evasão
      operationId: executeRemovalEvasion
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentStatusV2InDto'
        required: true
      responses:
        '200':
          description: Sucesso ao realizar o afastamento ou evasão.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnrollmentStatusV2OutDto'
        '400':
          description: 'Erro ao atualizar a situação da matrícula '
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para atualizar a situação da matrícula
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/processos/previsao-formatura:
    post:
      tags:
        - '[V1] + AÇÕES'
      description: Informar nova data de formatura
      operationId: postNewGraduationDate
      parameters:
        - name: enviar-valores
          in: query
          description: >-
            flag indicando se a requisição processará também valores enviados
            para renovação
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GraduationDateInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao informar nova data de formatura.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GraduationDateWithValuesOutDto'
        '400':
          description: 'Dados inválidos. '
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro ao informar nova data de formatura
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /processos/previsao-formatura:
    post:
      tags:
        - '[V1] + AÇÕES'
      description: Informar nova data de formatura
      operationId: postNewGraduationDate_1
      parameters:
        - name: enviar-valores
          in: query
          description: >-
            flag indicando se a requisição processará também valores enviados
            para renovação
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GraduationDateInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao informar nova data de formatura.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GraduationDateWithValuesOutDto'
        '400':
          description: 'Dados inválidos. '
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro ao informar nova data de formatura
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/jornadas/{tipo}/abrir:
    post:
      tags:
        - '[V2] JORNADAS'
      description: Abrir novas jornadas de renovação
      operationId: open
      parameters:
        - name: tipo
          in: path
          description: >-
            Código do tipo contrato, ex: T (Anual e Semestral), Q
            (Quadrimestral)
          required: true
          schema:
            type: string
        - name: ano
          in: query
          required: false
          schema:
            type: integer
            format: int32
          example: 2024
        - name: periodo
          in: query
          required: false
          schema:
            type: integer
            format: int32
          example: 1
        - name: dto
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/OpenJourneyInDto'
      responses:
        '200':
          description: Sucesso ao abrir jornadas
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OpenJourneyOutDto'
        '400':
          description: Falha na manipulação dos dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/jornadas/atualizar:
    post:
      tags:
        - '[V2] JORNADAS'
      description: Atualizar (refresh) estudantes na jornada atual
      operationId: refresh
      parameters:
        - name: grbId
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: instId
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Sucesso ao atualizar jornada atual
          content:
            '*/*':
              schema:
                type: boolean
        '400':
          description: Falha na manipulação dos dados da requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/jornadas/abrir:
    post:
      tags:
        - '[V2] JORNADAS'
      description: Abrir novas jornadas de renovação
      operationId: open_1
      parameters:
        - name: dto
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/OpenJourneyInDto'
      responses:
        '200':
          description: Sucesso ao abrir jornadas
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OpenJourneyOutDto'
        '400':
          description: Falha na manipulação dos dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/manter-trancamento:
    post:
      tags:
        - locking-enrollment-controller
      operationId: maintainLocking_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentStatusInDto'
        required: true
      responses:
        '200':
          description: OK
  /s/v2/mais-acoes/{brbId}/excluir-contrato:
    post:
      tags:
        - '[V2] MAIS AÇÕES'
      description: Realizar exclusão do contrato do estudante
      operationId: deleteContract_3
      parameters:
        - name: brbId
          in: path
          description: ID da jornada do estudante
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoreActionsContractDeleteInDto'
        required: true
      responses:
        '200':
          description: Sucesso realizar exclusão
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MoreActionsContractDeleteOutDto'
        '404':
          description: Dados não encontrados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro não esperado
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/mais-acoes/{brbId}/cancelar-contrato:
    post:
      tags:
        - '[V2] MAIS AÇÕES'
      description: Realizar cancelamento do contrato do estudante
      operationId: cancelContract_3
      parameters:
        - name: brbId
          in: path
          description: ID da jornada do estudante
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoreActionsContractDeleteInDto'
        required: true
      responses:
        '200':
          description: Sucesso realizar cancelamento
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MoreActionsContractDeleteOutDto'
        '404':
          description: Dados não encontrados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro não esperado
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/mais-acoes/trancamento:
    post:
      tags:
        - '[V2] MAIS AÇÕES'
      description: Realizar trancamento de matrícula do estudante
      operationId: maintainLocking_2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentStatusInDto'
        required: true
      responses:
        '200':
          description: Sucesso realizar trancamento
        '404':
          description: Dados não encontrados
        '500':
          description: Erro não esperado
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/ies/notificacoes/{id-notificacao}/visualizada:
    post:
      tags:
        - user-ies-notifications-controller
      operationId: markViewed
      parameters:
        - name: id-notificacao
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: boolean
  /s/v2/ies/notificacoes/{id-notificacao}/fechar-modal:
    post:
      tags:
        - '[V2] Notificações IEs'
      description: Marcar notificação como fechada
      operationId: closeModal
      parameters:
        - name: id-notificacao
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao atualizar status da notificação
          content:
            '*/*':
              schema:
                type: boolean
        '500':
          description: Erro interno na atualização dos dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/contrato/valores/enviar:
    post:
      tags:
        - '[V2] VALORES'
      description: Envio de valores de contrato
      operationId: batchImport
      parameters:
        - name: reenvio
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - name: dto
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/IntegrationLoggingDto'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: JSON contendo os dados e valores de contratos
              items:
                $ref: '#/components/schemas/FillValuesInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao enviar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FillValuesOutDto'
        '400':
          description: Erro ao processar a importação de valores de contrato
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: >-
            Erro na manipulação de dados para a importação de valores de
            contrato
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/insere-jornada:
    get:
      tags:
        - '[V1] INCLUIR NA JORNADA'
      description: Listar beneficiarios disponiveis para inserir na jornada
      operationId: get_2
      parameters:
        - name: param
          in: query
          description: Parametro de pesquisa (Nome/CPF)
          required: true
          schema:
            type: string
        - name: idRenovacao
          in: query
          description: ID da jornada renovação para filtrar beneficiarios
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao listar beneficiarios
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StudentsAvailableOutDto'
        '400':
          description: Erro ao listar beneficiarios
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação dos dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
    post:
      tags:
        - '[V1] INCLUIR NA JORNADA'
      description: Incluir beneficiario jornada
      operationId: insertInJourney
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsertInJourneyInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao incluir beneficiario
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/InsertInJourneyOutDto'
        '400':
          description: Erro ao incluir beneficiario
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação dos dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/valores/importar-lote:
    post:
      tags:
        - '[V1] VALORES'
      description: Importar planilha para preenchimento de valores de contrato
      operationId: batchImport_1
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Arquivo CSV
                  format: binary
        required: true
      responses:
        '200':
          description: Sucesso ao importar CSV
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FillValuesOutDto'
        '400':
          description: Erro ao processar a importação de valores de contrato
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: >-
            Erro na manipulação de dados para a importação de valores de
            contrato
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/valores/dados-complementares:
    post:
      tags:
        - '[V1] VALORES'
      description: Buscar dados complementares para compor a planilha
      operationId: getComplimentaryData
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FillValuesComplimentatyDataInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FillValuesComplimentatyDataOutDto'
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/situacao-matricula/processo/{id-processo}/manter-trancamento:
    post:
      tags:
        - enrollment-status-controller
      operationId: maintainLeaveOfAbsence
      parameters:
        - name: id-processo
          in: path
          required: true
          schema:
            type: integer
            format: int64
        - name: antecipar-restituicao
          in: query
          required: true
          schema:
            type: boolean
        - name: manter-trancamento
          in: query
          required: true
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /s/v1/contrato/situacao-matricula/atualizar:
    post:
      tags:
        - '[V1] MATRICULA'
      description: Atualizar situação da matrícula
      operationId: update_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentStatusInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao atualizar a situação da matrícula.
        '400':
          description: 'Erro ao atualizar a situação da matrícula '
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para atualizar a situação da matrícula
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/mais-acoes/dados-complementares:
    post:
      tags:
        - '[V1] + AÇÕES'
      description: Buscar dados complementares
      operationId: getComplimentaryData_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BondMaintenanceComplimentaryDataInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BondMaintenanceComplimentaryDataOutDto'
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/mais-acoes/cadastrar-preferencia-grupoie/{grupie}:
    post:
      tags:
        - '[V1] + AÇÕES'
      description: Cadastrar Grupo como preferencie da IE
      operationId: registerDefaultPreferenceIe
      parameters:
        - name: grupie
          in: path
          description: Grupo IE
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                type: string
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/mais-acoes/cadastrar-preferencia-grupoie/:
    post:
      tags:
        - '[V1] + AÇÕES'
      description: Cadastrar Grupo como preferencie da IE
      operationId: registrarTodosDefault
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                type: string
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/beta/convenios/cadastrar-preferencia/{id}:
    post:
      tags:
        - '[V1] convenios'
      description: Cadastrar o convenio como default BETA
      operationId: registerDefaultPreferenceConvenio
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                type: string
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/beta/convenios/cadastrar-preferencia/:
    post:
      tags:
        - '[V1] convenios'
      description: Cadastrar o convenio como default BETA
      operationId: registerDefaultPreferenceConvenioNull
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                type: string
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/dashboard:
    post:
      tags:
        - dashboard-controller
      description: Consulta de dados para compor as células do Dashboard
      operationId: getDashboard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao buscar dados do dashboard
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DashboardOutDto'
        '400':
          description: Erro ao ler dados de resposta dos dados do dashboard
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados da consulta
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/dashboard/filtros-bolsas:
    post:
      tags:
        - dashboard-controller
      description: Filtros bolsas. Usado como base para montar os filtros do Dashboard.
      operationId: getMainFilter
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao consultar filtros bolsas
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/StudentshipFilterOutDto'
        '400':
          description: Erro ao ler dados de resposta dos filtros bolsas
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados da consulta
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/dashboard/detalhes:
    post:
      tags:
        - dashboard-controller
      description: Consulta de dados detalhados do dashboard
      operationId: getDashboardDetail
      parameters:
        - name: page
          in: query
          description: Número da página de resultados
          required: false
          schema:
            type: integer
            format: int32
        - name: size
          in: query
          description: Número de registros por página
          required: false
          schema:
            type: integer
            format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao buscar dados do dashboard
          content:
            '*/*':
              schema:
                type: string
        '400':
          description: Erro ao ler dados de resposta dos dados do dashboard
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados da consulta
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/api/v3/mais-acoes/inativar-estudante:
    post:
      tags:
        - '[V3] API EXTERNA'
      description: Inativar estudante na jornada
      operationId: inactivateStudent_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InactivateStudentAPIInDto'
        required: true
      responses:
        '200':
          description: Sucesso ao executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResultOutDto'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno na execução da ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/matricula/processo/{prcId}:
    patch:
      tags:
        - '[V2] MATRICULA'
      description: Editar número de matrícula
      operationId: editEnrollmentNumber
      parameters:
        - name: prcId
          in: path
          description: id do processo
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentNumberInDto'
        required: true
      responses:
        '204':
          description: Sucesso ao realizar a edição da matrícula
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '404':
          description: Registro não encontrato
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para atualizar a matrícula
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/renovacao/journey:
    get:
      tags:
        - '[V3] Renovação'
      summary: Listar jornada de renovação por filtros
      operationId: getStudentshipJourney
      parameters:
        - name: year
          in: query
          description: Ano da renovação
          required: true
          schema:
            type: integer
            format: int32
          example: 2025
        - name: period
          in: query
          description: Semestre da renovação (1 ou 2)
          required: true
          schema:
            type: integer
            format: int32
          example: 2
        - name: studentshipId
          in: query
          description: Lista de BOL_ID
          required: false
          schema:
            type: string
          example:
            - 1
            - 3
            - 5
        - name: instId
          in: query
          description: Lista de INST_ID
          required: false
          schema:
            type: string
          example:
            - 13
            - 45
            - 54
        - name: studentshipGroupId
          in: query
          description: Lista de GRUPO_IES_ID
          required: false
          schema:
            type: string
          example:
            - 10
            - 11
      responses:
        '200':
          description: Lista obtida com sucesso
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RenewalStudentshipJourneyResumeResponse'
        '400':
          description: Parâmetros inválidos
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Não autorizado
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/renovacao/carousel:
    get:
      tags:
        - '[V3] Renovação'
      summary: Listar carrossel de renovação
      operationId: getCarousel
      parameters:
        - name: bolId
          in: query
          description: 'Lista de BOL_ID. Ex.: [1,3,5]'
          required: false
          schema:
            type: string
          example:
            - 1
            - 3
            - 5
        - name: groupIesId
          in: query
          description: 'Lista de GRUPO_IES_ID. Ex.: [10,11]'
          required: false
          schema:
            type: string
          example:
            - 10
            - 11
        - name: instId
          in: query
          description: 'Lista de INST_ID. Ex.: [13,45,54]'
          required: false
          schema:
            type: string
          example:
            - 13
            - 45
            - 54
        - name: year
          in: query
          description: Ano da renovação
          required: false
          schema:
            type: integer
            format: int32
          example: 2025
        - name: semester
          in: query
          description: Semestre da renovação (1 ou 2)
          required: false
          schema:
            type: integer
            format: int32
          example: 2
      responses:
        '200':
          description: Lista obtida com sucesso
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RenewalCarouselItemResumeResponse'
        '400':
          description: Parâmetros inválidos
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Não autorizado
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v3/estudantes/pendentes-assinatura:
    get:
      tags:
        - '[V3] Estudantes'
      description: Buscar estudantes com contrato pendente de assinatura
      operationId: getPendingSignature
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StudentPendingSignatureOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Não autorizado
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/repasse/{competencia}:
    get:
      tags:
        - '[V1] api-externa'
      description: valores consolidados de repasse mensal por competência
      operationId: buscarPorCompetencia
      parameters:
        - name: competencia
          in: path
          required: true
          schema:
            type: string
        - name: grbId
          in: query
          required: false
          schema:
            type: integer
            format: int64
        - name: idBolsas
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: dataRepasse
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                type: object
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/{renewalTabEnum}:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: 'Consultar contratos '
      operationId: get
      parameters:
        - name: renewalTabEnum
          in: path
          required: true
          schema:
            type: string
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagingRenewalConcessionOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/{brbId}/existe-andamento:
    get:
      tags:
        - '[V2] MAIS AÇÕES'
      description: Verificar se já existe ações em andamento para a renovação
      operationId: existsInProgress
      parameters:
        - name: brbId
          in: path
          description: ID da renovação a ser consultada
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Consulta realizada com sucesso
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/VerifyProcessStatusOutDto'
        '500':
          description: Erro na manipulação de dados para a consulta
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/tags:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar quais tags cada brbId tem
      operationId: tags
      parameters:
        - name: brbIds
          in: query
          description: Ids para verificar as tags
          required: true
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TagByIdDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/status-contrato/{brbId}/brb-id:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Busca status do contrato pelo ID e ID da bolsa
      operationId: getContractsByContractId
      parameters:
        - name: brbId
          in: path
          description: BRB_ID
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContractStatusIesOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/status-contrato/{brbId}/brb-id:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Busca status do contrato pelo ID e ID da bolsa
      operationId: getContractsByContractId_1
      parameters:
        - name: brbId
          in: path
          description: BRB_ID
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ContractStatusIesOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/sem-renovacao:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar contratos sem renovação
      operationId: getWithoutRenewal
      parameters:
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagingRenewalConcessionOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/planilhas-auxiliares/turnos:
    get:
      tags:
        - '[V2] PLANILHAS AUXILIARES'
      description: Listar turnos disponíveis ao usuário IE
      operationId: getTurns
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AuxiliarySpreadsheetsTurnsOutDto'
        '500':
          description: Erro interno na consulta
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/planilhas-auxiliares/cursos:
    get:
      tags:
        - '[V2] PLANILHAS AUXILIARES'
      description: Listar cursos disponíveis ao usuário IE
      operationId: getCourses
      parameters:
        - name: codBolsa
          in: query
          description: Código da bolsa
          required: false
          schema:
            type: string
        - name: nome
          in: query
          description: Nome do curso (busca parcial)
          required: false
          schema:
            type: string
        - name: turno
          in: query
          description: Turno do curso
          required: false
          schema:
            type: string
        - name: nomeBolsa
          in: query
          description: Nome da bolsa (busca parcial)
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CourseListOutDto'
        '500':
          description: Erro interno na consulta
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/planilhas-auxiliares/campus:
    get:
      tags:
        - '[V2] PLANILHAS AUXILIARES'
      description: Listar campus disponíveis ao usuário IE
      operationId: getCampuses
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AuxiliarySpreadsheetsCampusesOutDto'
        '500':
          description: Erro interno na consulta
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/manutencao-vinculo/estudantes/autocomplete:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar dados para o autocomplete
      operationId: getAutocomplete
      parameters:
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/JourneyAutocompleteInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RenewalAutocompleteListOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/manutencao-vinculo/estudantes/autocomplete:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar dados para o autocomplete
      operationId: getAutocomplete_1
      parameters:
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/JourneyAutocompleteInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RenewalAutocompleteListOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/manutencao-vinculo/estudantes:
    get:
      tags:
        - '[V2] MANUTENÇÃO DE VÍNCULO'
      description: Listar todos os beneficarios com manutenção de vínculo para a jornada
      operationId: listBondMaintenanceBeneficiaries
      parameters:
        - name: dto
          in: query
          description: Dados de entrada para filtrar beneficiarios
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao listar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagingRenewalConcessionOutDto'
        '400':
          description: Falha ao listar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/manutencao-vinculo/estudantes:
    get:
      tags:
        - '[V2] MANUTENÇÃO DE VÍNCULO'
      description: Listar todos os beneficarios com manutenção de vínculo para a jornada
      operationId: listBondMaintenanceBeneficiaries_1
      parameters:
        - name: dto
          in: query
          description: Dados de entrada para filtrar beneficiarios
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao listar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagingRenewalConcessionOutDto'
        '400':
          description: Falha ao listar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/manutencao-vinculo:
    get:
      tags:
        - '[V2] MANUTENÇÃO DE VÍNCULO'
      description: Validar se existem beneficarios com manutenção de vínculo para a jornada
      operationId: hasBondMaintenanceBeneficiaries
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                type: boolean
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/manutencao-vinculo:
    get:
      tags:
        - '[V2] MANUTENÇÃO DE VÍNCULO'
      description: Validar se existem beneficarios com manutenção de vínculo para a jornada
      operationId: hasBondMaintenanceBeneficiaries_1
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                type: boolean
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/jornadas:
    get:
      tags:
        - '[V2] JORNADAS'
      description: Listar jornadas de renovação
      operationId: getJourneys
      parameters:
        - name: grbId
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: instId
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Sucesso ao listar jornadas
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RenewalJourneysOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/jornadas/{journeyId}:
    get:
      tags:
        - '[V2] JORNADAS'
      description: Detalhar jornada
      operationId: getJourneyDetail
      parameters:
        - name: journeyId
          in: path
          description: journeyId
          required: true
          schema:
            type: integer
            format: int64
        - name: grbId
          in: query
          description: grbId
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: instId
          in: query
          description: instId
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Sucesso ao listar jornadas
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/JourneyOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/jornadas/tipos:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Listar tipos de jornadas para renovação
      operationId: getTypes
      parameters:
        - name: grbId
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
        - name: instId
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RenewalTypeOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/jornadas/listar:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar contratos de uma jornada para renovação
      operationId: list
      parameters:
        - name: dto
          in: query
          description: dados para consulta
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagingRenewalConcessionOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/jornadas/groups:
    get:
      tags:
        - '[V2] JORNADAS'
      description: Listar Grupos grb IDs
      operationId: getGroups
      responses:
        '200':
          description: Sucesso ao listar jornadas
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupsDTO'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/finalizados:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar contratos com processo de renovação finalizados
      operationId: getFinished
      parameters:
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagingRenewalConcessionOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/filtros:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Buscar filtros utilizados nas telas de renovação
      operationId: getFilters
      parameters:
        - name: dto
          in: query
          description: Parâmetros para montar os filtros
          required: true
          schema:
            $ref: '#/components/schemas/RenewalFiltersInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RenewalFiltersOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/em-processamento:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar contratos com renovação em processamento
      operationId: getProcessing
      parameters:
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagingRenewalConcessionOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/dashboard/contadores:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Buscar contadores de registros para cada aba do dashboard
      operationId: getCount
      parameters:
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TabsCounterOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/autocomplete:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar dados para o autocomplete
      operationId: getAutocomplete_2
      parameters:
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/JourneyAutocompleteInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RenewalAutocompleteListOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/renovacao/aptos:
    get:
      tags:
        - '[V2] DASHBOARD'
      description: Consultar contratos aptos para renovação
      operationId: getApt
      parameters:
        - name: queryString
          in: query
          description: parâmetros passados via query string
          required: true
          schema:
            $ref: '#/components/schemas/RenewalBeneficiariesInDto'
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagingRenewalConcessionOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/processos/{processId}/timeline:
    get:
      tags:
        - '[V2] TIMELINE'
      description: Buscar dados da timeline para um processo
      operationId: searchByProcess
      parameters:
        - name: processId
          in: path
          description: Identificador único do processo
          required: true
          schema:
            type: integer
            format: int64
        - name: modulos
          in: query
          description: Identificador(es) do(s) módulo(s)
          required: false
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TimelineWrapperOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/mais-acoes/situacoes:
    get:
      tags:
        - '[V2] MAIS AÇÕES'
      description: Listar situações permitidas para Exclusão ou Cancelamento de contrato
      operationId: listSituations
      parameters:
        - name: exclusaoCancelamento
          in: query
          description: >-
            Indica se deve listar apenas tipos para as ações Exclusão ou
            Cancelamento de contrato.
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: Sucesso realizar trancamento
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MoreActionsListSituationsOutDto'
        '500':
          description: Erro não esperado
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/ies/notificacoes:
    get:
      tags:
        - '[V2] NOTIFICAÇÕES'
      description: Buscar notificações do usuário IE
      operationId: get_1
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationUserIEOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/ies/notificacoes/historico:
    get:
      tags:
        - user-ies-notifications-controller
      operationId: getHistory
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationUserIEOutDto'
  /s/v2/contrato/valores/{id-processo}/{ano}/{semestre}:
    get:
      tags:
        - '[V2] VALORES'
      description: Buscar dados enviados para renovação
      operationId: search
      parameters: []
      responses:
        '200':
          description: Sucesso ao buscar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SearchFillValuesOutDto'
        '500':
          description: Erro interno na requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/contrato/valores/{brbId}:
    get:
      tags:
        - '[V2] VALORES'
      description: Buscar dados enviados para renovação
      operationId: search_1
      parameters:
        - name: brbId
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao buscar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SearchFillValuesOutDto'
        '500':
          description: Erro interno na requisição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v2/contrato/valores/calcular-parcelas-reembolso:
    get:
      tags:
        - contract-fill-values-controller
      operationId: calculateRefundInstallments
      parameters:
        - name: id-bolsa
          in: query
          required: true
          schema:
            type: integer
            format: int64
        - name: percentual-concedido
          in: query
          required: true
          schema:
            type: number
            format: float
        - name: parcelas-cobertura
          in: query
          required: true
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: integer
                format: int32
  /s/v1/tarefas/situacao/{processId}:
    get:
      tags:
        - '[V1] TASKS'
      description: Buscar tarefas não concluídas, do tipo TRANCAMENTO ou AFASTAMENTO
      operationId: validateSituation
      parameters:
        - name: processId
          in: path
          description: Id do processo
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao buscar os dados.
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
        '400':
          description: Erro ao buscar os dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na buscar dos dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/tarefas/detalhes/{solicitationId}:
    get:
      tags:
        - '[V1] TASKS'
      description: Buscar dados das tarefas de Afastamento ou Evasão
      operationId: getTaskDetail
      parameters:
        - name: solicitationId
          in: path
          description: Id da solicitação web
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao buscar os dados.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RemovalOrEvasionDetailDto'
        '400':
          description: Erro ao buscar os dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na buscar dos dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/tarefas/detalhes-trancamento/{solicitationId}:
    get:
      tags:
        - '[V1] TASKS'
      description: Buscar situação de trancamento de matrícula
      operationId: getLockingEnrollmentTaskDetail
      parameters:
        - name: solicitationId
          in: path
          description: Id da solicitação web
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Sucesso ao buscar os dados.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LockingEnrollmentDetailDto'
        '400':
          description: Erro ao buscar os dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na buscar dos dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/processo-solicitacao/{processId}/existe-andamento:
    get:
      tags:
        - '[V1] + AÇÕES'
      description: Verificar se já existe processo de renovação em andamento
      operationId: existsInProgress_1
      parameters:
        - name: processId
          in: path
          description: ID do processo a ser consultado
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Consulta realizada com sucesso
          content:
            '*/*':
              schema:
                type: boolean
        '500':
          description: Erro na manipulação de dados para a consulta
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/situacao-matricula/tipos:
    get:
      tags:
        - '[V1] MATRICULA'
      description: Buscar lista de tipos de situação da matrícula
      operationId: getTypes_1
      parameters:
        - name: situacao-matricula
          in: query
          description: Id da situação da matrícula
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Sucesso ao buscar lista de tipos de situação da matrícula.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnrollmentTypesListOutDto'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na busca da lista de tipos de situação da matrícula
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnrollmentTypesListOutDto'
  /s/v1/contrato/situacao-matricula/situacoes:
    get:
      tags:
        - '[V1] MATRICULA'
      description: Buscar lista de situação da matrícula
      operationId: getStatuses
      responses:
        '200':
          description: Sucesso ao buscar lista de situação da matrícula.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnrollmentStatusListOutDto'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na busca da lista de situação da matrícula
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnrollmentStatusListOutDto'
  /s/v1/contrato/situacao-matricula/situacoes-restituicao:
    get:
      tags:
        - '[V1] MATRICULA'
      description: Buscar lista de situação da restituição
      operationId: getRestitutionStatuses
      responses:
        '200':
          description: Sucesso ao buscar lista de situação da restituição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RestitutionStatusListOutDto'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na busca da lista de situação da restituição
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/situacao-matricula/processo/{id-processo}/trancamento-anterior/bolsa/{id-bolsa}:
    get:
      tags:
        - enrollment-status-controller
      operationId: searchPreviousLeaveOfAbsence
      parameters:
        - name: id-processo
          in: path
          required: true
          schema:
            type: integer
            format: int64
        - name: id-bolsa
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProcessStatusOutDto'
  /s/v1/contrato/situacao-matricula/motivos:
    get:
      tags:
        - '[V1] MATRICULA'
      description: Buscar lista de motivos para a situação da matrícula
      operationId: getMotives
      parameters:
        - name: tipo-situacao
          in: query
          description: Id do tipo da situação
          required: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Sucesso ao buscar lista de motivos para a situação da matrícula.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EnrollmentMotivesListOutDto'
        '401':
          description: Usuário não autorizado a executar a ação
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na busca da lista de motivos para a situação da matrícula
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/contrato/mais-acoes/obter-preferencia-grupoie:
    get:
      tags:
        - '[V1] + AÇÕES'
      description: Obter Grupo como preferencie da IE
      operationId: findByPreferenceIe
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                type: integer
                format: int64
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/beta/convenios:
    get:
      tags:
        - '[V1] convenios'
      description: Listar os convenios do BETA
      operationId: getAgreementBeta
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgreementBetaResponse'
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/beta/convenios/{grbId}:
    get:
      tags:
        - '[V1] convenios'
      description: Listar os convenios do BETA por GRBID
      operationId: getByGrbId
      parameters:
        - name: grbId
          in: path
          required: true
          schema:
            type: array
            items:
              type: integer
              format: int64
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgreementBetaResponse'
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /s/v1/beta/convenios/obter-preferencia-grupoie:
    get:
      tags:
        - '[V1] convenios'
      description: obter o convenio default BETA
      operationId: findByPreferenceConvenio
      responses:
        '200':
          description: Sucesso ao buscar daos
          content:
            '*/*':
              schema:
                type: integer
                format: int64
        '400':
          description: Erro ao buscar dados complementares
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro na manipulação de dados para a consulta no banco de dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /motivo-espera:
    get:
      tags:
        - '[V1] + AÇÕES'
      description: Motivos de espera para o portal da IE
      operationId: getMotives_1
      parameters:
        - name: param
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Sucesso ao buscar motivos de espera.
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
        '400':
          description: 'Dados inválidos. '
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro ao buscar motivos de espera
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
  /api/v3/estudantes/pendentes-assinatura:
    get:
      tags:
        - '[V3] API EXTERNA'
        - '[V3] Estudantes'
      description: Buscar estudantes com contrato pendente de assinatura
      operationId: getPendingSignature_1
      responses:
        '200':
          description: Sucesso ao consultar dados
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StudentPendingSignatureOutDto'
        '400':
          description: Falha ao consultar dados
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '401':
          description: Não autorizado
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
        '500':
          description: Erro interno
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/HandlerResponse'
components:
  schemas:
    EnrollmentLockInDto:
      required:
        - brbId
        - dataOcorrido
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        dataOcorrido:
          type: string
          description: data da solicitação de trancamento
          example: 01-01-2025
        caminhoArquivo:
          type: string
      description: parâmetros
    HandlerResponse:
      type: object
      properties:
        message:
          type: string
    ResultOutDto:
      type: object
      properties:
        resultado:
          type: string
        erro:
          type: string
    FillValuesInDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        nomeEstudante:
          type: string
        qtdParcelasCobertura:
          type: integer
          format: int32
        qtdCreditos:
          type: integer
          format: int32
        valorContrato:
          type: number
        valorCtrPrestServico:
          type: number
        percentualConcedido:
          type: number
          format: float
        parcMeses:
          type: string
        idCurso:
          type: integer
          format: int64
        regimeContrato:
          type: string
        contratoAnual:
          type: string
        motivoReenvio:
          type: string
        motivo:
          type: string
        serieSemestre:
          type: string
    NewGraduationDateInDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        valores:
          $ref: '#/components/schemas/FillValuesInDto'
        dadosEnvioValores:
          $ref: '#/components/schemas/FillValuesInDto'
        ano:
          type: integer
          format: int32
        mes:
          type: integer
          format: int32
        dados-envio-valores:
          $ref: '#/components/schemas/FillValuesInDto'
      description: parâmetros
    NewGraduationDateOutDto:
      type: object
      properties:
        sucessoPrevisaoFormatura:
          type: boolean
        sucessoEnvioValores:
          type: boolean
        retornoEnvioValores:
          $ref: '#/components/schemas/SendValuesOutDto'
    SendValuesOutDto:
      type: object
      properties:
        registrosComSucesso:
          type: integer
          format: int64
        registrosComErro:
          type: integer
          format: int64
        registrosPendentes:
          type: integer
          format: int64
        erro:
          type: string
        linhasComErro:
          type: array
          items:
            type: string
        linhasPendenteFundacred:
          type: array
          items:
            type: string
        lote:
          type: integer
          format: int64
        trancamento:
          $ref: '#/components/schemas/ResultOutDto'
    BondMaintenanceInDto:
      required:
        - brbId
        - motivo
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        motivo:
          type: string
        motivo-complementar:
          type: string
      description: parâmetros
    MaintainLockingInDto:
      required:
        - brbId
        - dataOcorrido
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        dataOcorrido:
          type: string
          description: data da solicitação
          example: 01-01-2025
        caminhoArquivo:
          type: string
      description: parâmetros
    InactivateStudentInDto:
      type: object
      properties:
        brb-id:
          type: integer
          format: int64
        motivo:
          type: string
      description: parâmetros
    DeleteContractInDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        situacao:
          type: string
        motivo:
          type: string
        motivoComplementar:
          type: string
        data:
          type: string
          description: data da ocorrência
          example: 01-01-2025
        arquivo:
          type: string
      description: parâmetros
    SendValuesInDto:
      required:
        - valores
      type: object
      properties:
        reenvio:
          type: boolean
        valores:
          type: array
          items:
            $ref: '#/components/schemas/FillValuesInDto'
        dadosTrancamento:
          $ref: '#/components/schemas/EnrollmentLockInDto'
      description: parâmetros
    CancelContractInDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        situacao:
          type: string
        motivo:
          type: string
        motivoComplementar:
          type: string
        data:
          type: string
          description: data da ocorrência
          example: 01-01-2025
        arquivo:
          type: string
      description: parâmetros
    AnalysisReviewInDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        motivo:
          type: string
      description: parâmetros
    RemovalEvasionInDto:
      required:
        - brbId
        - dataOcorrido
        - motivo
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        dataOcorrido:
          type: string
          description: data da solicitação do Afastamento ou Evasão
          example: 01-01-2025
        motivo:
          type: string
        caminhoArquivo:
          type: string
      description: parâmetros
    TicketDetailInDto:
      type: object
      properties:
        motivo:
          type: string
      description: Dados para cancelamento do contrato
    EnrollmentStatusInDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        id-processo:
          type: integer
          format: int64
        id-solicitacao:
          type: integer
          format: int64
        nome-estudante:
          type: string
        cpf:
          type: string
        cod-bolsa:
          type: string
        bolsa:
          type: string
        situacao-matricula:
          type: string
        tipo:
          type: string
        motivo:
          type: string
        motivo-complementar:
          type: string
        situacao-restituicao:
          type: string
        data-ocorrido:
          type: string
          format: date-time
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        matricula:
          type: string
        inicio-reembolso:
          type: string
          format: date-time
        ultimo-contrato:
          type: string
        texto-livre:
          type: string
        caminho-arquivo:
          type: string
      description: Dados para a utilização no filtro da consulta
    FillValuesOutDto:
      type: object
      properties:
        registrosComSucesso:
          type: integer
          format: int64
        registrosComErro:
          type: integer
          format: int64
        registrosPendentes:
          type: integer
          format: int64
        erro:
          type: string
        linhasComErro:
          type: array
          items:
            type: string
        linhasPendenteFundacred:
          type: array
          items:
            type: string
        lote:
          type: integer
          format: int64
    UpdateStatusOutDto:
      type: object
      properties:
        envio-valores:
          $ref: '#/components/schemas/FillValuesOutDto'
    EnrollmentStatusV2InDto:
      type: object
      properties:
        cpf:
          type: string
        motivo:
          type: string
        motivo-complementar:
          type: string
        data-ocorrido:
          type: string
          format: date-time
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        caminho-arquivo:
          type: string
        situacao-restituicao:
          type: string
      description: Dados para processamento da requisição
    EnrollmentStatusV2OutDto:
      type: object
      properties:
        message:
          type: string
    GraduationDateInDto:
      type: object
      properties:
        month:
          type: string
        year:
          type: string
        brbId:
          type: integer
          format: int64
        valores:
          $ref: '#/components/schemas/FillValuesInDto'
      description: Dados para atualização de previsão de formatura
    GraduationDateWithValuesOutDto:
      type: object
      properties:
        sucessoPrevisaoFormatura:
          type: boolean
        sucessoEnvioValores:
          type: boolean
        retornoEnvioValores:
          $ref: '#/components/schemas/FillValuesOutDto'
    OpenJourneyInDto:
      type: object
      properties:
        grbId:
          type: array
          items:
            type: integer
            format: int64
        instId:
          type: array
          items:
            type: integer
            format: int64
        type:
          type: string
        year:
          type: integer
          format: int32
        period:
          type: integer
          format: int32
    OpenJourneyOutDto:
      type: object
      properties:
        log:
          type: array
          items:
            type: string
        sucesso:
          type: boolean
        mensagemErro:
          type: string
        mensagem:
          type: string
    MoreActionsContractDeleteInDto:
      type: object
      properties:
        situacao:
          type: string
        motivo:
          type: string
        motivo-complementar:
          type: string
        data:
          type: string
          format: date-time
        arquivo:
          type: string
      description: DTO com dados de entrada
    MoreActionsContractDeleteOutDto:
      type: object
      properties:
        sucesso:
          type: boolean
        mensagem:
          type: string
    IntegrationLoggingDto:
      type: object
    InsertInJourneyInDto:
      type: object
      properties:
        idBolsa:
          type: integer
          format: int64
        idProcesso:
          type: integer
          format: int64
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        novaDataFormatura:
          $ref: '#/components/schemas/GraduationDateInDto'
      description: Parametros de pesquisa
    InsertInJourneyOutDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        incluidoJornada:
          type: boolean
        novaFormaturaEnviada:
          type: boolean
    FillValuesComplimentatyDataInDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/StudentshipCourseDto'
      description: Dados para a utilização no filtro da consulta
    StudentshipCourseDto:
      type: object
      properties:
        cod_bolsa:
          type: integer
          format: int64
        cod_curso:
          type: string
    ComplimentaryDataOutDto:
      type: object
      properties:
        campus:
          type: string
        codBolsa:
          type: integer
          format: int64
        codCurso:
          type: string
        turno:
          type: string
        curso:
          type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
    FillValuesComplimentatyDataOutDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ComplimentaryDataOutDto'
    BondMaintenanceComplimentaryDataInDto:
      type: object
      properties:
        cod_bolsa:
          type: integer
          format: int64
        cod_curso:
          type: string
        id_contrato:
          type: integer
          format: int64
      description: Dados para a utilização no filtro da consulta
    BondMaintenanceComplimentaryDataOutDto:
      type: object
      properties:
        campus:
          type: string
        codBolsa:
          type: integer
          format: int64
        codCurso:
          type: string
        turno:
          type: string
        curso:
          type: string
        data_inicio_reembolso:
          type: string
          format: date-time
        numero-processo:
          type: string
        digito-processo:
          type: integer
          format: int32
        id-bolsa:
          type: integer
          format: int64
    DashboardInDto:
      type: object
      properties:
        like:
          type: array
          items:
            $ref: '#/components/schemas/LikeFilterDto'
        order:
          $ref: '#/components/schemas/OrderFilterDto'
        Tabela:
          type: string
        Filtro:
          type: string
      description: Dados para a consulta
    LikeFilterDto:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    OrderFilterDto:
      type: object
      properties:
        orderBy:
          type: string
        reversed:
          type: boolean
    Card:
      type: object
      properties:
        titulo:
          type: string
        total:
          type: integer
          format: int32
        percentual:
          type: number
          format: float
        ordem:
          type: integer
          format: int32
    CardGroup:
      type: object
      properties:
        label:
          type: string
        total:
          type: integer
          format: int32
        groups:
          type: array
          items:
            $ref: '#/components/schemas/Group'
        titulo:
          type: string
    DashboardOutDto:
      type: object
      properties:
        cardGroupList:
          type: array
          items:
            $ref: '#/components/schemas/CardGroup'
    Group:
      type: object
      properties:
        cards:
          type: array
          items:
            $ref: '#/components/schemas/Card'
        titulo:
          type: string
        percentual:
          type: number
          format: float
    CourseDto:
      type: object
      properties:
        studentshipCourseId:
          type: integer
          format: int64
        name:
          type: string
        code:
          type: string
        grade:
          type: string
        modality:
          type: string
    MaintainerDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        studentships:
          type: array
          items:
            $ref: '#/components/schemas/StudentshipDto'
    StudentshipDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        code:
          type: string
        name:
          type: string
        initials:
          type: string
        friendlyName:
          type: string
        uf:
          type: string
        contractType:
          type: string
        studentshipCampusId:
          type: integer
          format: int64
        studentshipCampusCode:
          type: string
        studentshipCampusName:
          type: string
        studentshipCampusCity:
          type: string
        studentshipCampusUF:
          type: string
        courses:
          type: array
          items:
            $ref: '#/components/schemas/CourseDto'
    StudentshipFilterOutDto:
      type: object
      properties:
        bolsasId:
          type: array
          items:
            type: integer
            format: int64
        mantenedoras:
          type: array
          items:
            $ref: '#/components/schemas/MaintainerDto'
    InactivateStudentAPIInDto:
      type: object
      properties:
        cpf:
          type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        motivo:
          type: string
      description: Dados da requisição
    EnrollmentNumberInDto:
      type: object
      properties:
        numMatricula:
          type: string
      description: Parametros para edição da matrícula
    RenewalStudentshipJourneyResumeResponse:
      type: object
      properties:
        idRenovacao:
          type: integer
          format: int64
        year:
          type: integer
          format: int32
        period:
          type: integer
          format: int32
        contractType:
          type: string
        renewDesc:
          type: string
        aptos:
          type: integer
          format: int64
        emProcessamento:
          type: integer
          format: int64
        finalizados:
          type: integer
          format: int64
        semRenovacao:
          type: integer
          format: int64
    RenewalCarouselItemResumeResponse:
      type: object
      properties:
        renewalYear:
          type: integer
          format: int32
        renewalSemester:
          type: integer
          format: int32
        aptos:
          type: integer
          format: int64
        emProcessamento:
          type: integer
          format: int64
        finalizados:
          type: integer
          format: int64
        semRenovacao:
          type: integer
          format: int64
    StudentPendingSignatureOutDto:
      type: object
      properties:
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        nome:
          type: string
        cpf:
          type: string
    RenewalBeneficiariesInDto:
      type: object
      properties:
        status:
          type: array
          items:
            type: string
        page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        maintenanceMotiveCodes:
          type: array
          items:
            type: string
        maintenanceMotiveObservation:
          type: string
        idMantenedora:
          type: array
          items:
            type: integer
            format: int64
        idBolsa:
          type: array
          items:
            type: integer
            format: int64
        modalidade:
          type: array
          items:
            type: string
        idCampus:
          type: array
          items:
            type: integer
            format: int64
        codMotivoManutencaoVinculo:
          type: array
          writeOnly: true
          items:
            type: string
        obsMotivoManutencaoVinculo:
          type: string
          writeOnly: true
        dtFormatura:
          type: string
        pesquisa:
          type: string
        ordenarPor:
          type: string
        ordem:
          type: string
        formandos:
          type: boolean
        idCurso:
          type: array
          items:
            type: integer
            format: int64
        grauEnsino:
          type: array
          items:
            type: string
        tagAtuCad:
          type: array
          items:
            type: string
        tagAltCtr:
          type: array
          items:
            type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        idRenovacao:
          type: integer
          format: int64
        grupo:
          type: string
          writeOnly: true
        idsBolsa:
          type: array
          items:
            type: integer
            format: int64
        dtStatusIni:
          type: string
          format: date-time
        dtStatusFim:
          type: string
          format: date-time
        idRenovacoes:
          type: array
          items:
            type: integer
            format: int64
        tagAltTra:
          type: array
          items:
            type: string
        inativo:
          type: boolean
        courseId:
          type: array
          writeOnly: true
          items:
            type: integer
            format: int64
        grbId:
          type: array
          items:
            type: integer
            format: int64
        instId:
          type: array
          items:
            type: integer
            format: int64
    PagingRenewalConcessionOutDto:
      type: object
      properties:
        resultados:
          type: array
          items:
            $ref: '#/components/schemas/RenewalConcessionOutDto'
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        totalEstudantes:
          type: integer
          format: int64
        total_paginas:
          type: integer
          format: int32
        total_resultados:
          type: integer
          format: int64
        tamanho:
          type: integer
          format: int32
        pagina:
          type: integer
          format: int32
    PersonOutDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        cpf:
          type: string
        nome:
          type: string
    RenewalConcessionOutDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        breId:
          type: integer
          format: int64
        status:
          type: string
        campus:
          type: string
        digitalizado:
          type: boolean
        idRenovacao:
          type: integer
          format: int64
        descricao:
          type: string
        anoRenovacao:
          type: integer
          format: int32
        semestreRenovacao:
          type: integer
          format: int32
        tipoStatus:
          type: string
        grupo:
          type: string
        prcId:
          type: integer
          format: int64
        psaId:
          type: integer
          format: int64
        nome:
          type: string
        cpf:
          type: string
        nrMatricula:
          type: string
        dtFormatura:
          type: string
          format: date-time
        dtInclusao:
          type: string
          format: date-time
        ctrId:
          type: integer
          format: int64
        nrContrato:
          type: string
        sitContrato:
          type: string
        anoContrato:
          type: integer
          format: int32
        semestreContrato:
          type: integer
          format: int32
        serie_semestre:
          type: string
        idBolsa:
          type: integer
          format: int64
        codBolsa:
          type: integer
          format: int64
        nomeBolsa:
          type: string
        nomeCurso:
          type: string
        idCurso:
          type: integer
          format: int64
        tagAtualizacaoCadastral:
          $ref: '#/components/schemas/TagDto'
        tagAlteracaoContratual:
          $ref: '#/components/schemas/TagDto'
        tagAlteracaoTrancamento:
          $ref: '#/components/schemas/TagDto'
        jsonHistorico:
          type: string
        tipoContrato:
          type: integer
          format: int32
        turno:
          type: string
        valoresEnviados:
          $ref: '#/components/schemas/SentDataOutDto'
        inicio-reembolso:
          type: string
          format: date-time
        fiadores:
          type: array
          items:
            $ref: '#/components/schemas/PersonOutDto'
        codMotivoManutencaoVinculo:
          type: string
        descMotivoManutencaoVinculo:
          type: string
        obsMotivoManutencaoVinculo:
          type: string
        trancamento:
          type: string
        extinto:
          type: boolean
        ocultarRenovacao:
          type: boolean
    SentDataOutDto:
      type: object
      properties:
        valorContrato:
          type: number
        valorCtrPrestServico:
          type: number
        qtdParcelasCobertura:
          type: integer
          format: int32
    TagDto:
      type: object
      properties:
        operacao:
          type: string
        descricao:
          type: string
        mensagem:
          type: string
        cor:
          type: string
        operacaoStatus:
          type: string
    VerifyProcessStatusOutDto:
      type: object
      properties:
        envioValores:
          type: boolean
        trancamento:
          type: boolean
        afastamentoEvasao:
          type: boolean
        previsaoFormatura:
          type: boolean
        manutencaoVinculo:
          type: boolean
        assinaturaContratoAnterior:
          type: boolean
    TagByIdDto:
      type: object
      properties:
        brbId:
          type: integer
          format: int64
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagDto'
    ContractStatusIesOutDto:
      type: object
      properties:
        cpf:
          type: string
        idProcesso:
          type: string
        processo:
          type: string
        digitoProcesso:
          type: string
        bolsa:
          type: string
        curso:
          type: string
        turno:
          type: string
        campus:
          type: string
        nome:
          type: string
        numeroMatricula:
          type: string
        numeroContrato:
          type: string
        tipoContrato:
          type: string
        inicioReembolso:
          type: string
        dataFormatura:
          type: string
        situacaoContrato:
          type: string
        valorContrato:
          type: string
        valorContratoCredies:
          type: string
        anoSemestre:
          type: string
        contratosFirmados:
          type: string
        ultimoContrato:
          type: string
        percentual:
          type: string
        idSolicitacao:
          type: integer
          format: int64
        inicioReembolsoProcesso:
          type: string
        serieSemestre:
          type: string
        nivelSemestre:
          type: integer
          format: int32
        codBolsa:
          type: integer
          format: int64
        brbId:
          type: integer
          format: int64
        propriedadesJson:
          type: string
        cursoInativo:
          type: boolean
        fiadores:
          type: array
          items:
            $ref: '#/components/schemas/PersonOutDto'
        contratoUltimoPeriodo:
          type: boolean
        idCurso:
          type: integer
          format: int64
        bcsIdSerieSemestrePermitidos:
          type: array
          items:
            type: integer
            format: int64
    AuxiliarySpreadsheetsTurnsOutDto:
      type: object
      properties:
        turnos:
          type: array
          items:
            type: string
    CourseListOutDto:
      type: object
      properties:
        cursos:
          type: array
          items:
            $ref: '#/components/schemas/CourseOutDto'
    CourseOutDto:
      type: object
      properties:
        campusId:
          type: integer
          format: int64
        campus:
          type: string
        idCurso:
          type: integer
          format: int64
        nomeBolsa:
          type: string
        modalidade:
          type: string
        grau:
          type: string
        codBolsa:
          type: string
        nome:
          type: string
        turno:
          type: string
        serieSemestre:
          type: string
        siglaBolsa:
          type: string
    AuxiliarySpreadsheetsCampusesOutDto:
      type: object
      properties:
        campus:
          type: array
          items:
            type: string
    JourneyAutocompleteInDto:
      type: object
      properties:
        pesquisa:
          type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        idRenovacao:
          type: integer
          format: int64
    RenewalAutocompleteListOutDto:
      type: object
      properties:
        autocomplete:
          type: array
          items:
            $ref: '#/components/schemas/RenewalAutocompleteOutDto'
    RenewalAutocompleteOutDto:
      type: object
      properties:
        cpf:
          type: string
        status:
          type: string
        nome:
          type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        tipoStatus:
          type: string
        grupo:
          type: string
        idRenovacao:
          type: integer
          format: int64
        statusJornada:
          type: string
        descricaoJornada:
          type: string
    JourneyBriefOutDto:
      type: object
      properties:
        idRenovacao:
          type: integer
          format: int64
        descricao:
          type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        dtInicio:
          type: string
          format: date-time
        dtFim:
          type: string
          format: date-time
        tpContrato:
          type: integer
          format: int32
    RenewalJourneysOutDto:
      type: object
      properties:
        atual:
          type: array
          items:
            $ref: '#/components/schemas/JourneyBriefOutDto'
        anteriores:
          type: array
          items:
            $ref: '#/components/schemas/JourneyBriefOutDto'
    JourneyOutDto:
      type: object
      properties:
        total:
          type: integer
          format: int64
        idRenovacao:
          type: integer
          format: int64
        descricao:
          type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        dtInicio:
          type: string
          format: date-time
        dtFim:
          type: string
          format: date-time
        tpContrato:
          type: integer
          format: int32
        totalAptos:
          type: integer
          format: int64
        totalEmProcessamento:
          type: integer
          format: int64
        totalFinalizados:
          type: integer
          format: int64
        totalSemRenovacao:
          type: integer
          format: int64
    RenewalTypeOutDto:
      type: object
      properties:
        tipo:
          type: string
        descricao:
          type: string
        ano:
          type: integer
          format: int32
        periodo:
          type: integer
          format: int32
    GroupsDTO:
      type: object
      properties:
        grupoIesId:
          type: integer
          format: int64
        nome:
          type: string
        grupoPadrao:
          type: string
        descricao:
          type: string
        valor:
          type: integer
          format: int64
    RenewalFiltersInDto:
      type: object
      properties:
        idMantenedora:
          type: array
          items:
            type: integer
            format: int64
        idBolsa:
          type: array
          items:
            type: integer
            format: int64
        modalidade:
          type: array
          items:
            type: string
        idCampus:
          type: array
          items:
            type: integer
            format: int64
        grbId:
          type: array
          items:
            type: integer
            format: int64
        instId:
          type: array
          items:
            type: integer
            format: int64
    AgreementBetaDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        nomeAmigavel:
          type: string
        razaoSocial:
          type: string
        padrao:
          type: string
        sigla:
          type: string
        codigo:
          type: integer
          format: int32
        solucoes:
          type: array
          items:
            $ref: '#/components/schemas/AgreementDTO'
        descricao:
          type: string
        valor:
          type: integer
          format: int64
    AgreementDTO:
      type: object
      properties:
        nome:
          type: string
        convId:
          type: integer
          format: int64
        codConvenio:
          type: integer
          format: int32
        nomeAmigavelCampus:
          type: string
    FilterOptionDto:
      type: object
      properties:
        descricao:
          type: string
        valor:
          type: string
        ano:
          type: string
        semestre:
          type: string
        grupo:
          type: string
        idRenovacao:
          type: integer
          format: int64
    RenewalFiltersOutDto:
      type: object
      properties:
        status:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        campus:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        tags:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/FilterOptionDto'
        cursos:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        mantenedoras:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        ies:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        modalidades:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        graus:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        convenios:
          type: array
          items:
            $ref: '#/components/schemas/AgreementBetaDTO'
        grupos:
          type: array
          items:
            $ref: '#/components/schemas/GroupsDTO'
        modulosTimeline:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        semestres:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
        jornadas:
          type: array
          items:
            $ref: '#/components/schemas/FilterOptionDto'
    TabOutDto:
      type: object
      properties:
        total:
          type: integer
          format: int64
        nome:
          type: string
    TabsCounterOutDto:
      type: object
      properties:
        tabs:
          type: array
          items:
            $ref: '#/components/schemas/TabOutDto'
    TimelineOutDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        id-processo:
          type: integer
          format: int64
        operador:
          type: string
        desc-operador:
          type: string
        modulo:
          type: string
        desc-modulo:
          type: string
        id-operador:
          type: integer
          format: int64
        nome-operador:
          type: string
        dt-timeline:
          type: string
          format: date-time
        dt-inclusao:
          type: string
          format: date-time
        descricao:
          type: string
    TimelineWrapperOutDto:
      type: object
      properties:
        timeline:
          type: array
          items:
            $ref: '#/components/schemas/TimelineOutDto'
        header:
          type: string
    MoreActionsListSituationsOutDto:
      type: object
      properties:
        statusTypeIds:
          type: array
          items:
            type: string
        description:
          type: string
        id:
          type: string
    NotificationUserIEOutDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        path:
          type: string
        email:
          type: string
        idNotificacao:
          type: integer
          format: int64
        descricao:
          type: string
        texto:
          type: string
        idUsuarioIes:
          type: integer
          format: int64
        grbId:
          type: integer
          format: int64
        perfil:
          type: string
        primeiroNome:
          type: string
        fechadoModal:
          type: string
          enum:
            - S
            - 'N'
        visualizado:
          type: string
          enum:
            - S
            - 'N'
        dataNot:
          type: string
          format: date-time
        dataInclusao:
          type: string
          format: date-time
        dataUltAlteracao:
          type: string
          format: date-time
        idModulo:
          type: integer
          format: int64
        modulo:
          type: string
        idProduto:
          type: integer
          format: int64
        produto:
          type: string
    JourneyStatusOutDto:
      type: object
      properties:
        status:
          type: string
        descricao:
          type: string
    SearchFillValuesOutDto:
      type: object
      properties:
        cpf:
          type: string
        campus:
          type: string
        nome-estudante:
          type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        qtd-parcelas-cobertura:
          type: integer
          format: int32
        nr-parcela:
          type: integer
          format: int32
        qtd-creditos:
          type: integer
          format: int32
        valor-contrato:
          type: number
        valor-ctr-prest-servico:
          type: number
        percentual-concedido:
          type: number
          format: float
        nome-curso:
          type: string
        turno:
          type: string
        matricula:
          type: string
        parc-meses:
          type: string
        id-curso:
          type: integer
          format: int64
        regime-contrato:
          type: string
        cod-bolsa:
          type: string
        id-processo:
          type: integer
          format: int64
        statusJornada:
          $ref: '#/components/schemas/JourneyStatusOutDto'
        serie-semestre:
          type: string
    RemovalOrEvasionDetailDto:
      type: object
      properties:
        id-processo:
          type: integer
          format: int64
        motivo:
          type: string
        motivo-complementar:
          type: string
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        data-ocorrencia:
          type: string
          format: date-time
    LockingEnrollmentDetailDto:
      type: object
      properties:
        id-processo:
          type: integer
          format: int64
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        data-ocorrencia:
          type: string
          format: date-time
    StudentsAvailableOutDto:
      type: object
      properties:
        cpf:
          type: string
        nome:
          type: string
        bolsa:
          type: string
        idBolsa:
          type: integer
          format: int64
        idProcesso:
          type: integer
          format: int64
        formaturaVencida:
          type: string
    EnrollmentTypesListOutDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EnumMappingOutDto'
    EnumMappingOutDto:
      type: object
      properties:
        id:
          type: string
        description:
          type: string
    EnrollmentStatusListOutDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EnumMappingOutDto'
    RestitutionStatusListOutDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EnumMappingOutDto'
    ProcessStatusOutDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        idProcesso:
          type: integer
          format: int64
        dataOcorrencia:
          type: string
          format: date-time
        ano:
          type: integer
          format: int32
        semestre:
          type: integer
          format: int32
        situacaoRestituicao:
          type: string
        possuiTrancamentoAnterior:
          type: boolean
        anteciparRestituicao:
          type: boolean
        manterTrancamento:
          type: boolean
    EnrollmentMotiveItemOutDto:
      type: object
      properties:
        id:
          type: string
        description:
          type: string
        statusType:
          type: string
    EnrollmentMotivesListOutDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EnrollmentMotiveItemOutDto'
    AgreementBetaResponse:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/AgreementBetaDTO'
  securitySchemes:
    bearerAuth:
      type: http
      description: JWT TOKEN
      in: header
      scheme: bearer
      bearerFormat: JWT
