Valorizza API Docs

Permite retornar os registros do cadastro de convênios incluídos e/ou alterados no período especificado.

Detalhamento dos campos do serviço - dados de entrada:

Campo	Tipo	Descrição
`token`	Varchar	Código/Token fornecido pela Valorizza para a integração
`dataInicio`	Data	Data inicial para retornar os elementos cadastrados no período informado
`dataFim`	Data	Data final para retornar os elementos cadastrados no período informado
`identificacao`	Numérico	Identificação do convênio. Retorna somente dados relativos ao convênio solicitado
`quantidade`	Numérico	Quantidade de elementos por página, quando não informado, não irá existir paginação
`pagina`	Numérico	Página a ser visualizada quando for utilizado a paginação

Detalhamento dos campos do serviço - dados de saída:

Campo	Tipo	Descrição
`totalElementos`	Varchar	Total de elementos encontrados
`totalPaginas`	Varchar	Total de páginas de acordo com a quantidade informada nos dados de entrada
`paginaAtual`	Varchar	Página que está sendo visualizada, visível quando quantidade for informada nos dados de entrada
`elementos[].identificadorConvenio`	Numérico	Identificador do convênio
`elementos[].descricao`	Varchar	Descrição
`elementos[].tipoConvenio`	Varchar	Tipo do convênio Agente de integração Instituição de ensino Concedente Agente concedente Convênio de colaboração Jurídica
`elementos[].processo`	Varchar	Processo Estágio obrigatório (requer disciplina) Estágio (requer matrícula) Monitoria (requer matrícula) Outros (não requer matrícula)
`elementos[].conveniado`	Varchar	Conveniado
`elementos[].unidade`	Varchar	Unidade
`elementos[].situacao`	Varchar	Situação Em elaboração Em aprovação Aprovado Cancelado Suspenso
`elementos[].tipoFaturamento`	Varchar	Tipo do faturamento Não gera cobrança Percentual valor da parcela Percentual valor da bolsa Valor fixo mensal Valor fixo proporcional
`elementos[].pagarBolsa`	Varchar	Convênio paga bolsa Sim Não
`elementos[].percentualReceber`	Numérico	Percentual a receber
`elementos[].valorReceber`	Varchar	Valor a receber
`elementos[].valorMinimoReceber`	Varchar	Valor mínimo a receber
`elementos[].cobrarValorMinimo`	Varchar	Cobrar valor mínimo Parcela com mês inteiro Parcela com mês parcial Ambos
`elementos[].dadosBancarios`	Varchar	Dados bancários Opcional Obrigatório
`elementos[].efetividadeObrigatoria`	Varchar	Efetividade obrigatória Sim Não
`elementos[].pagaRecessoRescisaoSeparado`	Varchar	Paga recesso de rescisão separado Sim Não
`elementos[].pagaRecessoDiasUteis`	Varchar	Paga recesso por dias úteis Sim Não
`elementos[].incluiBeneficio`	Varchar	Inclui benefício Sim Não
`elementos[].agregaBeneficioAdministracaoEstagio`	Varchar	Agrega benefício na administração de estágio Sim Não
`elementos[].agregaRecessoAdministracaoEstagio`	Varchar	Agrega recesso na administração de estágio Sim Não
`elementos[].recebeDiasUteis`	Varchar	Recebe por dias úteis Sim Não
`elementos[].percentualPagar`	Numérico	Percentual a pagar
`elementos[].valorPagar`	Varchar	Valor a pagar
`elementos[].diaCalculoParcela`	Numérico	Dia de cálculo da parcela
`elementos[].tipoMonitoria`	Varchar	Tipo de monitoria Não remunerado Remunerado
`elementos[].quantidadeMaximaAlunos`	Numérico	Quantidade máxima de alunos
`elementos[].preceptor`	Varchar	Preceptor Do conveniado Da instituição de ensino
`elementos[].calculoFinanceiro`	Varchar	Cálculo financeiro Dia mês Trinta dias
`elementos[].autoatendimento`	Varchar	Autoatendimento Sim Não
`elementos[].inicio`	Data	Data de início
`elementos[].validade`	Data	Data de validade
`elementos[].seguro`	Varchar	Seguro Próprio Concedente
`elementos[].seguradora`	Varchar	Seguradora
`elementos[].apoliceSeguro`	Varchar	Apólice do seguro
`elementos[].observacao`	Varchar	Observação do cadastro
`elementos[].inclusao`	DataHora	Data de Inclusão
`elementos[].usuario`	Varchar	Usuário do cadastro
`elementos[].atualizacao`	DataHora	Data de atualização
`elementos[].estimativaEstagiarios`	Numérico	Valor da estimativa de estagiários
`elementos[].cursos[].curso`	Varchar	Nome do curso
`elementos[].cursos[].cursoDisciplina`	Varchar	Nome da disciplina do curso
`elementos[].cursos[].cursoAgrupador`	Varchar	Nome do agrupador do curso
`elementos[].cursos[].cursoQuantidadeMaximaAlunos`	Numérico	Quantidade máxima de alunos do curso
`elementos[].cursos[].cursoCep`	Varchar	CEP
`elementos[].cursos[].cursoEndereco`	Varchar	Endereço
`elementos[].cursos[].cursoNumero`	Varchar	Número
`elementos[].cursos[].cursoUf`	Varchar	Estado
`elementos[].cursos[].cursoCidade`	Varchar	Cidade
`elementos[].cursos[].inclusao`	DataHora	Data de Inclusão
`elementos[].cursos[].usuario`	Varchar	Usuário do cadastro
`elementos[].descontos[].descontoDe`	Numérico	Desconto de
`elementos[].descontos[].descontoAte`	Numérico	Desconto até
`elementos[].descontos[].descontoValor`	Varchar	Valor do desconto
`elementos[].descontos[].inclusao`	DataHora	Data de Inclusão
`elementos[].descontos[].usuario`	Varchar	Usuário do cadastro
`elementos[].beneficios[].beneficio`	Varchar	Benefício
`elementos[].beneficios[].beneficioValor`	Varchar	Valor do benefício
`elementos[].beneficios[].beneficioPercentual`	Numérico	Percentual do benefício
`elementos[].beneficios[].beneficioTipo`	Varchar	Tipo do benefício Diário Mensal
`elementos[].beneficios[].beneficioDiasUteis`	Varchar	Benefício dias úteis Sim Não
`elementos[].beneficios[].inclusao`	DataHora	Data de Inclusão
`elementos[].beneficios[].usuario`	Varchar	Usuário do cadastro
`elementos[].percentuais[].percentualTipoVaga`	Varchar	Tipo da vaga
`elementos[].percentuais[].percentualReceber`	Varchar	Percentual a receber
`elementos[].percentuais[].beneficioPercentual`	Varchar	Valor a receber
`elementos[].percentuais[].inclusao`	DataHora	Data de Inclusão
`elementos[].percentuais[].usuario`	Varchar	Usuário do cadastro
`elementos[].arquivos[].identificador`	Varchar	Identificador do arquivo
`elementos[].arquivos[].nomeArquivo`	Varchar	Nome do arquivo
`elementos[].arquivos[].nomeArquivoFisico`	Varchar	Nome do arquivo físico
`elementos[].arquivos[].atualizacao`	DataHora	Data de atualização
`elementos[].arquivos[].situacao`	Varchar	Situação do arquivo Aprovado Recusado Em Aprovação

RetornaDadosConvenios

Request

Responses