Skip to content

Fundacred - OpenApi Specification (1.1)

Documentação para a API renewal-api

Download OpenAPI description
Overview
Infra Fundacred
Languages
Servers
Mock server
https://docs.fundacred.org.br/_mock/renewal-api/
TST
https://tst-api.fundacred.org.br/renewal-api/
HML
https://hml-api.fundacred.org.br/renewal-api/
PRD
https://api.fundacred.org.br/renewal-api/

[V3] Mais Ações

Ações executadas na jornada do estudante

Operations

[V2] VALORES

Operations

batchImport

Request

Envio de valores de contrato

Security
bearerAuth
Query
reenvioboolean
Default false
dtoobject(IntegrationLoggingDto)required
Bodyapplication/jsonrequiredArray [
brbIdinteger(int64)
nomeEstudantestring
qtdParcelasCoberturainteger(int32)
qtdCreditosinteger(int32)
valorContratonumber
valorCtrPrestServiconumber
percentualConcedidonumber(float)
parcMesesstring
idCursointeger(int64)
regimeContratostring
contratoAnualstring
motivoReenviostring
motivostring
serieSemestrestring
]
curl -i -X POST \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/contrato/valores/enviar?reenvio=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "brbId": 0,
      "nomeEstudante": "string",
      "qtdParcelasCobertura": 0,
      "qtdCreditos": 0,
      "valorContrato": 0,
      "valorCtrPrestServico": 0,
      "percentualConcedido": 0.1,
      "parcMeses": "string",
      "idCurso": 0,
      "regimeContrato": "string",
      "contratoAnual": "string",
      "motivoReenvio": "string",
      "motivo": "string",
      "serieSemestre": "string"
    }
  ]'

Responses

Sucesso ao enviar dados

Body*/*
registrosComSucessointeger(int64)
registrosComErrointeger(int64)
registrosPendentesinteger(int64)
errostring
linhasComErroArray of strings
linhasPendenteFundacredArray of strings
loteinteger(int64)

search

Request

Buscar dados enviados para renovação

Security
bearerAuth
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/contrato/valores/{id-processo}/{ano}/{semestre}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao buscar dados

Body*/*
cpfstring
campusstring
nome-estudantestring
anointeger(int32)
semestreinteger(int32)
qtd-parcelas-coberturainteger(int32)
nr-parcelainteger(int32)
qtd-creditosinteger(int32)
valor-contratonumber
valor-ctr-prest-serviconumber
percentual-concedidonumber(float)
nome-cursostring
turnostring
matriculastring
parc-mesesstring
id-cursointeger(int64)
regime-contratostring
cod-bolsastring
id-processointeger(int64)
statusJornadaobject(JourneyStatusOutDto)
serie-semestrestring

search_1

Request

Buscar dados enviados para renovação

Security
bearerAuth
Path
brbIdinteger(int64)required
curl -i -X GET \
  'https://docs.fundacred.org.br/_mock/renewal-api/s/v2/contrato/valores/{brbId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sucesso ao buscar dados

Body*/*
cpfstring
campusstring
nome-estudantestring
anointeger(int32)
semestreinteger(int32)
qtd-parcelas-coberturainteger(int32)
nr-parcelainteger(int32)
qtd-creditosinteger(int32)
valor-contratonumber
valor-ctr-prest-serviconumber
percentual-concedidonumber(float)
nome-cursostring
turnostring
matriculastring
parc-mesesstring
id-cursointeger(int64)
regime-contratostring
cod-bolsastring
id-processointeger(int64)
statusJornadaobject(JourneyStatusOutDto)
serie-semestrestring

[V2] PLANILHAS AUXILIARES

Operations

[V2] MANUTENÇÃO DE VÍNCULO

Operations

[V2] DASHBOARD

Operations

[V2] MATRICULA

Resource para a manipulação da situação da matrícula

Operations

[V2] MAIS AÇÕES

Operations

[V2] JORNADAS

Operations

[V2] TIMELINE

Operations

[V2] NOTIFICAÇÕES

Operations

[V2] NOTIFICAÇÕES IEs

[V1] VALORES

Operations

[V1] TASKS

Operations

[V1] MATRICULA

Resource para a manipulação da situação da matrícula

Operations

[V1] + AÇÕES

Operations

[V1] INCLUIR NA JORNADA

Resource para a manipulação de beneficiarios para inserir nas jornadas

Operations

[V1] DASHBOARD

Resource para a consulta de dados do Dashboard

update-controller

Operations

contract-status-controller

Operations

locking-enrollment-controller

Operations

user-ies-notifications-controller

Operations

[V2] Notificações IEs

Operations

enrollment-status-controller

Operations

[V1] convenios

Operations

dashboard-controller

Operations

[V3] API EXTERNA

Operations

[V3] Renovação

Operations

[V3] Estudantes

Operations

[V1] api-externa

Operations

contract-fill-values-controller

Operations