1. API de Integração
  2. Métodos do Financeiro padronizados (V3)
  • Boletos - Consulta de boletos
  • Boletos - Dados do Boleto atualizado
  • Boletos - Download do PDF do boleto
  • Boletos - Download do PDF do boleto
  • Boletos - Obter link compartilhável
  • Boletos - Renovar vencimento
  • Boletos - URL pública para impressão de um boleto bancário
  • Consulta de Centros de Custos
  • Consulta de Contas Bancárias
  • Consulta de Contratos de matrícula
  • Consulta de Planos de Contas
  • Consulta de Vendedores
  • Contrato de Matrícula - Download do Contrato
  • Convênios - Consulta dos convênios
  • Convênios - Consulta dos convênios dos alunos
  • Planos de Pagamento - Consulta
  • Planos de Pagamento - Matrizes
  • Planos de Pagamento - Turmas
  • Planos de Pagamento - Unidades Físicas
  • Tabela de Preço - Tabela completa
  • Tabela de Preço - Valor do Curso
  • Transações - Consulta de contas a receber
  • Transações - Criar conta a receber
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna os dados básicos dos boletos bancários no sistema
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/boletos
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da Organização
idPagador Não java.lang.Integer Código do Pagador
idMetodoRecebimento Não java.lang.Integer Código do Cedente
idTransacao Não java.lang.Integer Código da Transação
dataVencimentoInicio Não java.sql.Date Data de vencimento - início
dataVencimentoFim Não java.sql.Date Data de vencimento - fim
dataEmissaoInicio Não java.sql.Date Data de emissão - início
dataEmissaoFim Não java.sql.Date Data de emissão - fim
like Não java.lang.String Like a ser aplicado nos campos 'nome do pagador, nome do cedente'
statusBoleto Não java.lang.String Status do boleto bancário (ABERTO, RECEBIDO ou CANCELADO)
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idBoleto (Integer)": null,
  "nossoNumero (String)": null,
  "status (String)": null,
  "idPagador (Integer)": null,
  "pagadorNome (String)": null,
  "idMetodoRecebimento (Integer)": null,
  "idAgencia (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "metodoRecebimento (String)": null,
  "agencia (String)": null,
  "conta (String)": null,
  "codigoCedente (String)": null,
  "cedente (String)": null,
  "carteira (String)": null,
  "unidadeCedente (String)": null,
  "content (BoletoContentRest)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna os dados atualizados (calculados) de um boleto bancário em ABERTO
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/boletos/dados-boleto
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idBoleto Sim java.lang.Integer Código do boleto
{
  "idBoleto (Integer)": null,
  "nossoNumero (String)": null,
  "status (String)": null,
  "idPagador (Integer)": null,
  "pagadorNome (String)": null,
  "idMetodoRecebimento (Integer)": null,
  "idAgencia (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "metodoRecebimento (String)": null,
  "agencia (String)": null,
  "conta (String)": null,
  "codigoCedente (String)": null,
  "cedente (String)": null,
  "carteira (String)": null,
  "unidadeCedente (String)": null,
  "content (BoletoContentRest)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null
}
{ "dataVencimento (String)": null, "nomeSacado (String)": null, "cpfSacado (String)": null, "cnpjSacado (String)": null, "enderecoSacado (String)": null, "cepSacado (String)": null, "bairroSacado (String)": null, "cidadeSacado (String)": null, "ufSacado (String)": null, "curso (String)": null, "infoComplementar2 (String)": null, "instrucao1 (String)": null, "instrucao2 (String)": null, "instrucao3 (String)": null, "instrucao4 (String)": null, "instrucao5 (String)": null, "noDocumento (String)": null, "dataDocumento (String)": null, "especieDocumento (String)": null, "aceite (String)": null, "dataProcessamento (String)": null, "carteiraFormatted (String)": null, "valorBoletoFormatted (String)": null, "cedente (String)": null, "codigoCedente (String)": null, "localPagamento (String)": null, "bancoFormatted (String)": null, "agenciaCedenteFormatted (String)": null, "nossoNumeroFormatted (String)": null, "linhaDigitavelFormatted (String)": null, "codigoBarras (String)": null, "unidadeCedente (String)": null, "enderecoCedente (String)": null, "ufEnderecoCedente (String)": null, "cepEnderecoCedente (String)": null, "cnpjCedente (String)": null, "localPagamento2 (String)": null, "idBoleto (String)": null }
  • Detalhes
  • Parâmetros
  • Descrição:
  • Retorna o arquivo PDF do boleto bancário informado.
  • Verbo:
  • POST
  • Resposta:
  • application/pdf
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/director/data/report/demonstrativo-cobranca
Parâmetro Obrigatório Tipo Descrição
format Sim java.lang.String Formato do retorno (JSON/XML)
mes Sim java.lang.Integer Mês de referência
ano Não java.lang.Integer Ano de referência
  • Detalhes
  • Parâmetros
  • Descrição:
  • Retorna o arquivo PDF do boleto bancário informado.
  • Verbo:
  • POST
  • Resposta:
  • application/pdf
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/boletos/dados-boleto/download
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idBoleto Sim java.lang.Integer Código do boleto bancário
idTransacao Não java.lang.Integer Código da transação
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna o link para compartilhamento do boleto bancário informado.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/boletos/dados-boleto/obter-link
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idBoleto Sim java.lang.Integer Código do boleto bancário
idTransacao Não java.lang.Integer Código da transação
{
  "url (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna os dados atualizados de um boleto bancário informado
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/boletos/renovar-boleto
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idTransacao Sim java.lang.Integer Código da transação
idBoleto Sim java.lang.Integer Código do boleto
diasProrrogacaoVencimento Não java.lang.Integer Quantidade de dias para prorrogação do vencimento
dataVencimento Não java.sql.Date Nova data de vencimento
isAplicarEncargosNaRenovacao Não boolean Aplicar encargos na renovação do boleto
{
  "idBoleto (Integer)": null,
  "nossoNumero (String)": null,
  "status (String)": null,
  "idPagador (Integer)": null,
  "pagadorNome (String)": null,
  "idMetodoRecebimento (Integer)": null,
  "idAgencia (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "metodoRecebimento (String)": null,
  "agencia (String)": null,
  "conta (String)": null,
  "codigoCedente (String)": null,
  "cedente (String)": null,
  "carteira (String)": null,
  "unidadeCedente (String)": null,
  "content (BoletoContentRest)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null
}
{ "dataVencimento (String)": null, "nomeSacado (String)": null, "cpfSacado (String)": null, "cnpjSacado (String)": null, "enderecoSacado (String)": null, "cepSacado (String)": null, "bairroSacado (String)": null, "cidadeSacado (String)": null, "ufSacado (String)": null, "curso (String)": null, "infoComplementar2 (String)": null, "instrucao1 (String)": null, "instrucao2 (String)": null, "instrucao3 (String)": null, "instrucao4 (String)": null, "instrucao5 (String)": null, "noDocumento (String)": null, "dataDocumento (String)": null, "especieDocumento (String)": null, "aceite (String)": null, "dataProcessamento (String)": null, "carteiraFormatted (String)": null, "valorBoletoFormatted (String)": null, "cedente (String)": null, "codigoCedente (String)": null, "localPagamento (String)": null, "bancoFormatted (String)": null, "agenciaCedenteFormatted (String)": null, "nossoNumeroFormatted (String)": null, "linhaDigitavelFormatted (String)": null, "codigoBarras (String)": null, "unidadeCedente (String)": null, "enderecoCedente (String)": null, "ufEnderecoCedente (String)": null, "cepEnderecoCedente (String)": null, "cnpjCedente (String)": null, "localPagamento2 (String)": null, "idBoleto (String)": null }
  • Detalhes
  • Parâmetros
  • Descrição:
  • Retorna o arquivo PDF do boleto bancário informado.
  • Verbo:
  • POST
  • Resposta:
  • application/pdf
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/boletos/dados-boleto/link/{token}/{browserView}
    https://catuai.jacad.com.br:443/academico/api/v3/financeiro/boletos/dados-boleto/link/{token}
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token de autorização único
browserView Não boolean Forçar Visualização no Navegador
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna todos os centros de custos ativos da instituição
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/basicos/centros-de-custos
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idCentroCusto Não java.lang.Integer Código do centro de custos
tipo Não java.lang.String Tipo (S ou A)
like Não java.lang.String Like a ser aplicado nos campos 'código e descrição'
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idCentroCusto (Integer)": null,
  "descricao (String)": null,
  "status (String)": null,
  "codigo (String)": null,
  "indice (String)": null,
  "idCliente (Integer)": null,
  "tipo (String)": null,
  "nivel (Integer)": null,
  "nrSubCentrosCusto (Integer)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna todas as contas bancárias da instituição
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/basicos/contas-bancarias
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idAgenciaConta Não java.lang.Integer Código da conta bancária
tipoConta Não java.lang.String Tipo (CONTA_BANCARIA, CAIXA,INVESTIMENTO)
status Não java.lang.String Status (ATIVO/INATIVO)
like Não java.lang.String Like a ser aplicado nos campos (Banco, Agenda e nome da conta)
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idCentroCusto (Integer)": null,
  "descricao (String)": null,
  "status (String)": null,
  "codigo (String)": null,
  "indice (String)": null,
  "idCliente (Integer)": null,
  "tipo (String)": null,
  "nivel (Integer)": null,
  "nrSubCentrosCusto (Integer)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna os contratos de matrícula para os filtros informados.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/academico/aluno/matricula/contratos
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Sim java.lang.Integer Código da organização
idPeriodoLetivo Não java.lang.Integer Código do período letivo
idTurma Não java.lang.Integer Código da turma
idMatriz Não java.lang.Integer Código da matriz
idCursoBase Não java.lang.Integer Código do curso base
idAluno Não java.lang.Integer Código do aluno
idPerfil Não java.lang.Integer Código do perfil
idPlanoPagamento Não java.lang.Integer Código do plano de pagamento
idUnidadeFisica Não java.lang.Integer Código da unidade física
idContrato Não java.lang.Integer Código do contrato
status Não java.lang.String Status do contrato (PENDENTE,ENTREGUE,CANCELADO)
statusMatricula Não java.lang.String Status da matrícula
dataVigenciaInicio Não java.sql.Date Data vigência início
dataVigenciaTermino Não java.sql.Date Data vigência termino
like Não java.lang.String Like sobre os campos (RA,Nome do aluno)
vinculoContrato Não java.lang.String Vínculo com contrato (COM_MATRICULA,SEM_MATRICULA)
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idContrato (Integer)": null,
  "idPerfil (Integer)": null,
  "idAluno (Integer)": null,
  "idCurso (Integer)": null,
  "idCursoBase (Integer)": null,
  "idPeriodoLetivo (Integer)": null,
  "idTabelaPreco (Integer)": null,
  "idPlanoPagamento (Integer)": null,
  "status (String)": null,
  "alunoNome (String)": null,
  "alunoRa (String)": null,
  "idMatricula (Integer)": null,
  "statusMatricula (String)": null,
  "idTurma (Integer)": null,
  "turmaNome (String)": null,
  "tabelaPreco (String)": null,
  "idUnidadeFisica (Integer)": null,
  "planoPagamento (String)": null,
  "unidadeFisica (String)": null,
  "descontoConcedido (Double)": null,
  "diaPreferencialVencimento (Integer)": null,
  "dataVigenciaInicio (Date)": null,
  "dataVigenciaTermino (Date)": null,
  "dataContrato (Date)": null,
  "dataAceiteContrato (Timestamp)": null,
  "ipAceiteContrato (String)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null,
  "parcelas (List)": []
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna todos os planos de contas ativos da instituição
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/basicos/planos-de-contas
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idPlanoConta Não java.lang.Integer Código do plano de contas
operacao Não java.lang.String Operação (SOMA ou SUBTRAI)
tipoConta Não java.lang.String Tipo da conta (ANALITA OU SINTETICA)
natureza Não java.lang.String Natureza (ATIVO,PASSIVO,PATRIMONIO,RECEITA,DESPESA)
like Não java.lang.String Like a ser aplicado nos campos 'código e descrição'
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idPlanoConta (Integer)": null,
  "descricao (String)": null,
  "codigo (String)": null,
  "indice (String)": null,
  "operacao (String)": null,
  "tipoConta (String)": null,
  "natureza (String)": null,
  "idCliente (Integer)": null,
  "nrSubPlanos (Integer)": null,
  "idPlanoContaPassivo (Integer)": null,
  "idPlanoContaAtivo (Integer)": null,
  "idPlanoContaAdiantamento (Integer)": null,
  "contaResultado (String)": null,
  "contaAtivo (String)": null,
  "contaPassivo (String)": null,
  "contaAdiantamento (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna todos os vendedores da instituição
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/basicos/vendedores
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idFuncao Não java.lang.Integer Código da função
like Não java.lang.String Like a ser aplicado nos campos (Nome, CPF e função)
status Não java.lang.String Status (ATIVO/INATIVO)
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idVendedor (Integer)": null,
  "idPerfil (Integer)": null,
  "idFuncao (Integer)": null,
  "status (String)": null,
  "nome (String)": null,
  "cpf (String)": null,
  "email (String)": null,
  "fone (String)": null,
  "celular (String)": null,
  "funcao (String)": null,
  "numeroBanco (String)": null,
  "numeroAgencia (String)": null,
  "numeroConta (String)": null,
  "codigoVendedor (String)": null
}
  • Detalhes
  • Parâmetros
  • Descrição:
  • Retorna o PDF do contrato de matrícula do aluno.
  • Verbo:
  • POST
  • Resposta:
  • application/pdf
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/academico/aluno/matricula/contratos/download
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idContrato Sim java.lang.Integer Código do contrato
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Lista todos os convênios da instituição
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/convenios/
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idConvenio Não java.lang.Integer Código do convênio
idEmpresa Não java.lang.Integer Código da empresa do convênio
status Não java.lang.String Status (ATIVO, INATIVO)
dataVigenciaInicio Não java.sql.Date Data de vigência inicial
dataVigenciaFim Não java.sql.Date Data de vigência final
like Não java.lang.String Like a ser aplicado nos campos 'nome convênio e empresa'
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idConvenio (Integer)": null,
  "idPlanoConta (Integer)": null,
  "descricao (String)": null,
  "status (String)": null,
  "perdeAposVencimento (Integer)": null,
  "calculoSobValorOriginal (Integer)": null,
  "tipo (String)": null,
  "valor (Double)": null,
  "idEmpresa (Integer)": null,
  "tipoLimiteValidade (String)": null,
  "diaLimite (Integer)": null,
  "tipoVencimento (String)": null,
  "tipoFinanciamento (String)": null,
  "apresentaDescricaoInstrucaoBancaria (Integer)": null,
  "instrucaoBancaria (String)": null,
  "deduzirValorOriginal (Integer)": null,
  "considerarSabadosComoDiaUtil (Integer)": null,
  "aplicarSobReembolsoConvenio (Integer)": null,
  "dataVigenciaInicio (Date)": null,
  "dataVigenciaTermino (Date)": null,
  "naoParticipaCenso (Integer)": null,
  "descontoIrmao (Integer)": null,
  "programaFinanciamentoCodigo (Integer)": null,
  "programaFinanciamentoDescricao (String)": null,
  "planoContaDescricao (String)": null,
  "planoContaCodigo (String)": null,
  "convenioEmpresaNome (String)": null,
  "convenioEmpresaCnpj (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Lista todos os convênios dos alunos para cada organização
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/convenios/alunos
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da organização
idAluno Não java.lang.Integer Código do aluno
idConvenio Não java.lang.Integer Código do convênio
idEmpresa Não java.lang.Integer Código da empresa do convênio
idPeriodoLetivo Não java.lang.Integer Código do Período letivo (de aplicação)
idMatriz Não java.lang.Integer Código da Matriz (de aplicação)
status Não java.lang.String Status (ATIVO, INATIVO) do convênio no aluno
dataVigenciaInicio Não java.sql.Date Data de vigência inicial
dataVigenciaFim Não java.sql.Date Data de vigência final
dataContratacaoInicio Não java.sql.Date Data de contratação inicial
dataContratacaoFim Não java.sql.Date Data de contratação final
like Não java.lang.String Like a ser aplicado nos campos 'nome convênio, nome aluno, empresa'
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idConvenioPagador (Integer)": null,
  "alunoIdAluno (Integer)": null,
  "alunoRa (String)": null,
  "alunoNome (String)": null,
  "idConvenio (Integer)": null,
  "convenioDescricao (String)": null,
  "convenioTipoFinanciamento (String)": null,
  "convenioIdEmpresa (Integer)": null,
  "convenioEmpresaNome (String)": null,
  "convenioEmpresaCnpj (String)": null,
  "ordem (Integer)": null,
  "valor (Double)": null,
  "tipoCalculo (String)": null,
  "dataInicio (Date)": null,
  "dataFim (Date)": null,
  "dataContratacaoConvenio (Date)": null,
  "observacao (String)": null,
  "status (String)": null,
  "naoAplicarResponsavel (Integer)": null,
  "perdeAposVencimento (Integer)": null,
  "deduzirValorOriginal (Integer)": null,
  "idAlunoCursoIngresso (Integer)": null,
  "cursoIngressoMatriz (String)": null,
  "cursoIngressoIdMatriz (Integer)": null,
  "idPeriodoLetivo (Integer)": null,
  "periodoLetivoDescricao (String)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna todos os planos de pagamento cadastrados numa organização
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/planos-pagamento/
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Sim java.lang.Integer Código da organização
idCurso Não java.lang.Integer Código da Matriz
idUnidadeFisica Não java.lang.Integer Código da Unidade Física
idTurma Não java.lang.Integer Código da Turma
idPlanoPagamento Não java.lang.Integer Código do Plano de Pagamento
isApenasAssociadoTurma Não boolean Com turmas associadas
isApenasAssociadoCurso Não boolean Com matrizes associadas
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idPlanoPagamento (Integer)": null,
  "descricao (String)": null,
  "status (String)": null,
  "observacao (String)": null,
  "bloquearEdicaoServicos (Integer)": null,
  "permitirInformarDataPrimeiraParcela (Integer)": null,
  "recalcularParcelasComBaseNaPrimeiraParcela (Integer)": null,
  "validarFlagGerarNasParcelas (Integer)": null,
  "ajusteDatasParcelasDinamica (Integer)": null,
  "usaDiasPreferenciaisVencimento (Integer)": null,
  "utilizarDescontoMaximoTabelaPreco (Integer)": null,
  "utilizarValorTabelaPreco (Integer)": null,
  "vigenciaContratoTempo (Integer)": null,
  "vigenciaContratoTipoInicio (String)": null,
  "permitirProrrogacaoContrato (Integer)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null,
  "servicos (List)": [],
  "parcelas (List)": []
}
{ "idPlanoPagamentoServico (Integer)": null, "idPlanoPagamento (Integer)": null, "idServico (Integer)": null, "diaInicio (Integer)": null, "mesInicio (Integer)": null, "anoInicio (Integer)": null, "numeroParcelas (Integer)": null, "servicoAdicional (Integer)": null, "valor (Double)": null, "taxa (Integer)": null, "contrato (Integer)": null, "separar (Integer)": null, "calculadoContrato (Integer)": null, "grupo (String)": null, "servicoDescricao (String)": null, "servicoPlanoContaDescricao (String)": null, "servicoPlanoContaCodigo (String)": null }
{ "idPlanoPagamentoParcela (Integer)": null, "idPlanoPagamento (Integer)": null, "parcela (String)": null, "dataVencimento (Date)": null, "valor (Double)": null, "aplicarDescontos (Integer)": null, "aplicarConvenios (Integer)": null, "gerar (Integer)": null, "vectoVariavelNrDias (Integer)": null, "ignorarCalculoContrato (Integer)": null, "grupo (String)": null }
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna todas as matrizes atendidas por um plano de pagamento informado.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/planos-pagamento/matrizes
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idPlanoPagamento Sim java.lang.Integer Código do plano de pagamento
{
  "idCurso (Integer)": null,
  "idCursoBase (Integer)": null,
  "nome (String)": null,
  "nomeRed (String)": null,
  "prazoConclusao (Integer)": null,
  "enfase (String)": null,
  "modalidade (String)": null,
  "horasAtividade (Integer)": null,
  "tipoAtividade (String)": null,
  "mediaMin (Double)": null,
  "mediaNormal (Double)": null,
  "frequencia (Double)": null,
  "recMedMin (Double)": null,
  "recMedNormal (Double)": null,
  "notaMenor (Double)": null,
  "notaMaior (Double)": null,
  "cargaHoraria (String)": null,
  "cargaHorariaTeorica (String)": null,
  "cargaHorariaPratica (String)": null,
  "cargaHorariaEstagio (String)": null,
  "prazoEm (String)": null,
  "podeTrancarPrimeiroPeriodo (Integer)": null,
  "prazoMaximoConclusao (Integer)": null,
  "habilidadesCompetencias (String)": null,
  "creditosExigidos (Double)": null,
  "idInep (Integer)": null,
  "idEixoTecnologico (Integer)": null,
  "eixoTecnologicoDescricao (String)": null,
  "descricao (String)": null,
  "tema (String)": null,
  "tipoCalculoFrequencia (String)": null,
  "periodicidade (String)": null,
  "status (String)": null,
  "naoApresentarParaUsuarioPolo (Integer)": null,
  "cargaHorariaTcc (String)": null,
  "idProfessorCoordenador (Integer)": null,
  "professorCoordenadorNome (String)": null,
  "qtdeMaximaVagas (Integer)": null,
  "grauGraduacao (String)": null,
  "idGrauGraduacao (Integer)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna todas as turmas atendidas por um plano de pagamento informado.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/planos-pagamento/turmas
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idPlanoPagamento Sim java.lang.Integer Código do plano de pagamento
{
  "idTurma (Integer)": null,
  "turmaNome (String)": null,
  "turmaNomeRed (String)": null,
  "turmaDescricao (String)": null,
  "turmaIdUnidadeFisica (Integer)": null,
  "turmaUnidadeFisica (String)": null,
  "turmaIdPeriodoLetivo (Integer)": null,
  "turmaPeriodoLetivo (String)": null,
  "turmaPeriodoLetivoSituacao (String)": null,
  "turmaPeriodoLetivoDataInicio (Date)": null,
  "turmaPeriodoLetivoDataTermino (Date)": null,
  "turmaIdMatriz (Integer)": null,
  "turmaMatriz (String)": null,
  "turmaIdCurso (Integer)": null,
  "turmaCurso (String)": null,
  "turmaIdTurmaDestino (Integer)": null,
  "turmaTurmaDestinoNome (String)": null,
  "turmaTurmaDestinoNomeRed (String)": null,
  "turmaTurmaDestinoPeriodoLetivo (String)": null,
  "turmaPeriodoItem (String)": null,
  "turmaTurno (String)": null,
  "turmaIdInep (Integer)": null,
  "turmaMediaMin (Double)": null,
  "turmaMediaNormal (Double)": null,
  "turmaFrequencia (Double)": null,
  "turmaRecMedMin (Double)": null,
  "turmaMedNormal (Double)": null,
  "turmaNotaMenor (Double)": null,
  "turmaNotaMaior (Double)": null,
  "turmaIdTurmaBase (Integer)": null,
  "turmaTurmaBase (String)": null,
  "turmaStatus (String)": null,
  "turmaDataInicio (Date)": null,
  "turmaDataFim (Date)": null,
  "turmaDataAbonoFalta (Date)": null,
  "turmaDataFechamentoDiarioClasse (Date)": null,
  "turmaValorTotal (Double)": null,
  "turmaObservacao (String)": null,
  "turmaQtdeDisciplina (Integer)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null,
  "turmaIdMetodoRecebimento (Integer)": null,
  "turmaMetodoRecebimento (String)": null,
  "habilitadoVenda (Integer)": null,
  "naoApresentarParaMatriculaNoPortal (Integer)": null,
  "turmaCalendarioRotativoSegunda (Integer)": null,
  "turmaCalendarioRotativoTerca (Integer)": null,
  "turmaCalendarioRotativoQuarta (Integer)": null,
  "turmaCalendarioRotativoQuinta (Integer)": null,
  "turmaCalendarioRotativoSexta (Integer)": null,
  "turmaCalendarioRotativoSabado (Integer)": null,
  "turmaCalendarioRotativoDomingo (Integer)": null,
  "turmaCalendarioRotativoTurmaFechada (Integer)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna todas as unidade físicas atendidas por um plano de pagamento informado.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/planos-pagamento/unidades-fisicas
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idPlanoPagamento Sim java.lang.Integer Código do plano de pagamento
{
  "idUnidadeFisica (Integer)": null,
  "nome (String)": null,
  "nomeImpressao (String)": null,
  "sigla (String)": null,
  "logradouro (String)": null,
  "numero (String)": null,
  "bairro (String)": null,
  "cep (String)": null,
  "email (String)": null,
  "cnpj (String)": null,
  "fones (String)": null,
  "idCidade (Integer)": null,
  "idEstado (Integer)": null,
  "status (String)": null,
  "dataAtivacao (Date)": null,
  "dataInativacao (Date)": null,
  "codigoInep (Integer)": null,
  "nomeCidade (String)": null,
  "siglaEstado (String)": null,
  "nomeEstado (String)": null,
  "responsavelNome (String)": null,
  "responsavelTelefone (String)": null,
  "responsavelCelular (String)": null,
  "responsavelEmail (String)": null,
  "idPerfilResponsavel (Integer)": null,
  "naoApresentarNoFormularioAtendimento (Integer)": null,
  "naoApresentarNaRematriculaWeb (Integer)": null,
  "naoApresentarCaptacaoWeb (Integer)": null,
  "complemento (String)": null,
  "tipoUnidade (String)": null,
  "observacaoHorarioAtendimento (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna os cursos e os seus respectivos valores e descontos máximos por unidades físicas (polos).
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/planos-pagamento/tabela-preco-completa
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idCursoBase Sim java.lang.Integer Código do Curso Base
idUnidadeFisica Não java.lang.Integer Código da Unidade Física (Polo)
dataVigenciaInicio Não java.sql.Date Data de vigência - Início
dataVigenciaTermino Não java.sql.Date Data de vigência - Término
{
  "idTabelaPreco (Integer)": null,
  "descricao (String)": null,
  "dataInicio (Timestamp)": null,
  "dataTermino (Timestamp)": null,
  "status (String)": null,
  "cursos (ArrayList)": []
}
{ "idCursoBase (Integer)": null, "descontoMaximo (Double)": null, "valor (Double)": null, "cursoBaseNomeParaImpressao (String)": null, "idOrg (Integer)": null, "orgDescricao (String)": null, "unidades (ArrayList)": [] }
{ "idUnidadeFisica (Integer)": null, "idCursoBase (Integer)": null, "descontoMaximo (Double)": null, "valor (Double)": null, "unidadeFisica (String)": null }
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna os valores de um curso base informado na tabela de preços vigente, ou mais recente caso informado as datas de início e término.
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/planos-pagamento/tabela-preco
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idCursoBase Sim java.lang.Integer Código do Curso Base
idUnidadeFisica Não java.lang.Integer Código da Unidade Física (Polo)
dataVigenciaInicio Não java.sql.Date Data de vigência - Início (Se não informado será a data atual)
dataVigenciaTermino Não java.sql.Date Data de vigência - Término (Se não informado será a data atual)
{
  "idTabelaPreco (Integer)": null,
  "tabelaPreco (String)": null,
  "valor (Double)": null,
  "descontoMaximo (Double)": null,
  "descontoFixo (Double)": null,
  "dataVigenciaInicio (Timestamp)": null,
  "dataVigenciaTermino (Timestamp)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Retorna os dados dos contas a receber de uma instituição
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/transacoes/contas-receber
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da Organização
dataVencimentoInicio Sim java.sql.Date Data de vencimento - início
dataVencimentoFim Sim java.sql.Date Data de vencimento - fim
idPagador Sim java.lang.Integer Código do Pagador (Perfil)
idPeriodoLetivo Não java.lang.Integer Código do Período letivo
idMatriz Não java.lang.Integer Código da Matriz
idCurso Não java.lang.Integer Código do Curso
idPlanoPagamento Não java.lang.Integer Código do Plano de Pagamento
isPossuiBoletoBancario Não boolean Possui boleto bancário
isPossuiContratoMatricula Não boolean Possui contrato matrícula
origem Não java.lang.String Origem da transação (MENSALIDADE,OUTROS,ACORDO,PARCELA,UNIFICACAO,MULTA_BIBLIOTECA)
tipoReferencia Não java.lang.String Tipo da referência da transação (MATRICULA,PERFIL,EMPRESTIMO_BIBLIOTECA)
idReferencia Não java.lang.Integer Código da Referência
situacao Não java.lang.String Situação da Transação (ABERTO, PAGO, PARCIAL, ACORDADO e BAIXADA)
statusBoleto Não java.lang.String Status do boleto bancário (ABERTO, RECEBIDO ou CANCELADO)
statusMatricula Não java.lang.String Status da Matrícula(CANCELADA,TRANCADA,TRANSFERIDA,REENQUADRADA,INFREQUENTE,DESISTENTE,REMANEJADA,BLOQUEADA,ATIVA,AGUARDANDO,APROVADO,APROVADO_PARECER_DESCRITIVO,APROVADO_PARCIALMENTE,REPROVADO)
like Não java.lang.String Like a ser aplicado no nome do aluno, ra, nome, cpf do curso e turma
offset Sim java.lang.Integer Número de registros a serem pulados na realização da consulta (paginação)
{
  "idTransacao (Integer)": null,
  "transacaoIdReferencia (Integer)": null,
  "transacaoTipoReferencia (String)": null,
  "transacaoDataVencimento (Date)": null,
  "transacaoDataCompetencia (Date)": null,
  "transacaoValorOriginal (Double)": null,
  "transacaoValor (Double)": null,
  "transacaoSituacao (String)": null,
  "transacaoNumero (String)": null,
  "transacaoIdBoleto (Integer)": null,
  "transacaoBoletoStatus (String)": null,
  "transacaoBoletoNossoNumero (String)": null,
  "transacaoBoletoNossoNumeroDigitoVerificador (String)": null,
  "transacaoBoletoLiberadoWeb (Integer)": null,
  "transacaoOrigem (String)": null,
  "pagadorNome (String)": null,
  "pagadorCpf (String)": null,
  "pagadorRa (String)": null,
  "pagadorIdPagador (Integer)": null,
  "pagadorIdAluno (Integer)": null,
  "pagadorEmail (String)": null,
  "pagadorTelefone (String)": null,
  "pagadorCelular (String)": null,
  "pagadorDataNascimento (Date)": null,
  "curso (String)": null,
  "cursoIdCurso (Integer)": null,
  "matriz (String)": null,
  "matrizIdMatriz (Integer)": null,
  "turma (String)": null,
  "turmaNomeReduzido (String)": null,
  "turmaNomePeriodoCurso (String)": null,
  "turmaIdTurma (Integer)": null,
  "periodoLetivo (String)": null,
  "periodoLetivoIdPeriodoLetivo (Integer)": null,
  "matriculaIdContrato (Integer)": null,
  "matriculaIdMatricula (Integer)": null,
  "matriculaIdAlunoCursoIngresso (Integer)": null,
  "matriculaStatus (String)": null,
  "matriculaPlanoPagamento (String)": null,
  "matriculaIdPlanoPagamento (Integer)": null,
  "matriculaDataMatricula (Date)": null,
  "matriculaUnidadeFisicaNome (String)": null,
  "matriculaUnidadeFisicaCodigo (Integer)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null
}
  • Detalhes
  • Parâmetros
  • Formato do Objeto de Retorno
  • Descrição:
  • Cria e retorna os dados de uma nova conta a receber
  • Verbo:
  • POST
  • Resposta:
  • JSON/XML
  • URIs de Acesso:
  • https://catuai.jacad.com.br:443/academico/api/v3/financeiro/transacoes/contas-receber/criar-nova
Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Sim java.lang.Integer Código da Organização
idPerfil Sim java.lang.Integer Código do Perfil
descricao Sim java.lang.String Descrição da conta a receber
valor Sim java.lang.Double Valor da conta a receber (deve ser maior que zero)
dataVencimento Sim java.sql.Date Data de vencimento da conta a receber
idPlanoConta Sim java.lang.Integer Código do Plano de Contas da conta a receber
idCentroCusto Sim java.lang.Integer Código do Centro de Custo da conta a receber
origem Não java.lang.String Origem da transação (ACORDO,
CHEQUE,
CONVENIO_RETROATIVO,
CREDITO,
EVENTO_INSCRICAO,
IMPORTACAO,
INSCRICAO_VESTIBULAR,
MENSALIDADE,
OUTROS,
PARCELA,
REEMBOLSAR,
REEMBOLSO,
REEMBOLSO_CONVENIO,
REMATRICULA,
UNIFICACAO)
{
  "idTransacao (Integer)": null,
  "transacaoIdReferencia (Integer)": null,
  "transacaoTipoReferencia (String)": null,
  "transacaoDataVencimento (Date)": null,
  "transacaoDataCompetencia (Date)": null,
  "transacaoValorOriginal (Double)": null,
  "transacaoValor (Double)": null,
  "transacaoSituacao (String)": null,
  "transacaoNumero (String)": null,
  "transacaoIdBoleto (Integer)": null,
  "transacaoBoletoStatus (String)": null,
  "transacaoBoletoNossoNumero (String)": null,
  "transacaoBoletoNossoNumeroDigitoVerificador (String)": null,
  "transacaoBoletoLiberadoWeb (Integer)": null,
  "transacaoOrigem (String)": null,
  "pagadorNome (String)": null,
  "pagadorCpf (String)": null,
  "pagadorRa (String)": null,
  "pagadorIdPagador (Integer)": null,
  "pagadorIdAluno (Integer)": null,
  "pagadorEmail (String)": null,
  "pagadorTelefone (String)": null,
  "pagadorCelular (String)": null,
  "pagadorDataNascimento (Date)": null,
  "curso (String)": null,
  "cursoIdCurso (Integer)": null,
  "matriz (String)": null,
  "matrizIdMatriz (Integer)": null,
  "turma (String)": null,
  "turmaNomeReduzido (String)": null,
  "turmaNomePeriodoCurso (String)": null,
  "turmaIdTurma (Integer)": null,
  "periodoLetivo (String)": null,
  "periodoLetivoIdPeriodoLetivo (Integer)": null,
  "matriculaIdContrato (Integer)": null,
  "matriculaIdMatricula (Integer)": null,
  "matriculaIdAlunoCursoIngresso (Integer)": null,
  "matriculaStatus (String)": null,
  "matriculaPlanoPagamento (String)": null,
  "matriculaIdPlanoPagamento (Integer)": null,
  "matriculaDataMatricula (Date)": null,
  "matriculaUnidadeFisicaNome (String)": null,
  "matriculaUnidadeFisicaCodigo (Integer)": null,
  "idOrg (Integer)": null,
  "orgDescricao (String)": null
}