API de Integração - Documentação | Sistema Acadêmico SWA.JACAD

Financeiro - Impressão de Boleto Bancário (PDF)

Permite imprimir um boleto bancário de uma transação ABERTA no formato PDF.
Método: POST
Resposta: application/pdf

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) para as mensagens de erro (caso houver)
idTransacao	Sim	java.lang.Integer	Código de uma transação ativa

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/boleto/imprimir/

Básicos - Demonstrativo de parcelas do plano de pagamento

Este método gera um demonstrativo das parcelas de um plano de pagamento informado.
Método: POST
Resposta: JSON/XML

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
idCursoBase	Não	java.lang.Integer	Código do Curso Base
idUnidadeFisica	Não	java.lang.Integer	Código da Unidade Física
dataPrimeiraParcela	Não	java.sql.Date	Data da primeira parcela
diaPreferencialVencimento	Não	java.lang.Integer	Dia preferencial de vencimento
disciplinasTurma	Não	[Ljava.lang.Integer;	Disciplinas da turma

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/planos-de-pagamento/demonstrativo-parcelas

Formato do objeto de retorno

{
  "idContratoParcela (Integer)": null,
  "idContrato (Integer)": null,
  "idPlanoPagamentoParcela (Integer)": null,
  "parcela (String)": null,
  "dataVencimento (Date)": null,
  "valor (Double)": null,
  "aplicarDescontos (Integer)": null,
  "aplicarConvenios (Integer)": null,
  "isParcelaAdicional (Integer)": null,
  "grupo (String)": null,
  "ignorarCalculoContrato (Integer)": null,
  "gerar (Integer)": null,
  "_bDescontos (Boolean)": null,
  "_bConvenios (Boolean)": null,
  "_bGerar (Boolean)": null,
  "_gerar (Integer)": null,
  "_idPlanoPagamento (Integer)": null,
  "itens (ArrayList)": [],
  "itensParaDeletar (ArrayList)": [],
  "transacao (Transacao)": null,
  "idsServicos (ArrayList)": [],
  "primeiraParcela (boolean)": false,
  "dataVencimentoOriginal (Date)": null,
  "id_org (Integer)": null
}

Básicos - Consultar Planos de Pagamento

Lista todos os planos de pagamento ativos da instituição.
Método: POST
Resposta: JSON/XML

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)
idCurso	Não	java.lang.Integer	Código do Curso (matriz)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/planos-de-pagamento/

Formato do objeto de retorno

{
  "servicos (ArrayList)": [],
  "parcelas (ArrayList)": [],
  "idPlanoPagamento (Integer)": null,
  "descricao (String)": null,
  "status (String)": null,
  "todos (Integer)": null,
  "bloquearEdicaoServicos (Integer)": null,
  "permitirInformarDataPrimeiraParcela (Integer)": null,
  "recalcularParcelasComBaseNaPrimeiraParcela (Integer)": null,
  "validarFlagGerarNasParcelas (Integer)": null,
  "ajusteDatasParcelasDinamica (Integer)": null,
  "observacao (String)": null,
  "_descPlano (String)": null,
  "_valorParcela (Double)": null,
  "_nrParcelas (Integer)": null,
  "usaDiasPreferenciaisVencimento (Integer)": null,
  "permitirUtilizarTabelaPreco (Integer)": null,
  "vigenciaContratoTempo (Integer)": null,
  "vigenciaContratoTipoInicio (String)": null,
  "permitirProrrogacaoContrato (Integer)": null,
  "habilitarAtualizacaoVencParcelas (Integer)": null,
  "numeroDiasAtualizarVencParcelas (Integer)": null,
  "id_org (Integer)": null
}
{
  "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,
  "_servico (String)": null,
  "_idPlanoConta (Integer)": null,
  "_planoConta (String)": null,
  "_operacao (String)": null,
  "_tipoVencimento (String)": "DIA_FIXO",
  "centrosCusto (ArrayList)": [],
  "transacoes (ArrayList)": [],
  "id_org (Integer)": 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,
  "_bDescontos (Boolean)": null,
  "_bConvenios (Boolean)": null,
  "_bGerar (Boolean)": null,
  "primeiraParcela (boolean)": false,
  "dataVencimentoOriginal (Date)": null,
  "itens (ArrayList)": [],
  "id_org (Integer)": null
}

Financeiro - Consultar Recebimentos por Unidade Física (Polo)

Lista todos os recebimentos efetuados na instituição ou numa organização específica combinado com vários filtros. Obs: aplicável apenas para quem utiliza unidades físicas (polos)
Método: POST
Resposta: JSON/XML

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)
dataInicio	Sim	java.sql.Date	Data de início dos pagamentos
dataFim	Sim	java.sql.Date	Data limite dos pagamentos
idAgenciaConta	Não	java.lang.Integer	Código da Conta em que foram efetuados os recebimentos
idTipoRecebimento	Não	java.lang.Integer	Código do Tipo do recebimento
idTransacao	Não	java.lang.Integer	Código da transação
idPerfil	Não	java.lang.Integer	Código do perfil do pagador
idUnidadeFisica	Não	java.lang.Integer	Código da Unidade Física (Polo)
idCursoBase	Não	java.lang.Integer	Código do curso base
idPeriodoLetivo	Não	java.lang.Integer	Código do período letivo
idVendedor	Não	java.lang.Integer	Código do vendedor(opcional)
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/listar-recebimentos/unidades-fisicas/

Formato do objeto de retorno

{
  "idUnidadeFisica (Integer)": null,
  "idTransacaoRecebimento (Integer)": null,
  "idTransacao (Integer)": null,
  "idMatricula (Integer)": null,
  "idReferencia (Integer)": null,
  "idCursoBase (Integer)": null,
  "idPeriodoLetivo (Integer)": null,
  "idPagador (Integer)": null,
  "idUsuarioRecebimento (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "idBoletoRecebimento (Integer)": null,
  "idTipoRecebimento (Integer)": null,
  "valorRecebido (Double)": null,
  "valorEncargos (Double)": null,
  "valorDescontos (Double)": null,
  "valorOriginalTransacao (Double)": null,
  "dataRecebimento (Date)": null,
  "dataCancelamento (Date)": null,
  "dataLiquidacao (Date)": null,
  "dataVencimento (Date)": null,
  "ra (String)": null,
  "pagador (String)": null,
  "cpf (String)": null,
  "periodoLetivo (String)": null,
  "curso (String)": null,
  "unidadeFisica (String)": null,
  "organizacao (String)": null,
  "descricaoTipoRecebimento (String)": null,
  "tipoRecebimento (String)": null,
  "statusRecebimento (String)": null,
  "usuarioRecebimento (String)": null,
  "obsRecebimento (String)": null,
  "contaNome (String)": null,
  "contaNumero (String)": null,
  "contaDv (String)": null,
  "operacao (String)": null,
  "vendedorNome (String)": null,
  "vendedorCpf (String)": null,
  "idVendedor (Integer)": null,
  "id_org (Integer)": null
}

Financeiro - Impressão da NFS-e

Permite imprimir a NFS-e que foi previamente autorizada através do ManagerSaas.
Método: POST
Resposta: application/pdf

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) para as mensagens de erro (caso houver)
idTransacao	Sim	java.lang.Integer	Código de uma transação que possua uma NFS-e

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/transacoes/nfse/

Financeiro - Cancelar Conta a Receber

Cancela um determinado conta a receber informado.
Método: POST
Resposta: JSON/XML

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
motivo	Sim	java.lang.String	Motivo do cancelamento

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/contas-receber/cancelar/

Formato do objeto de retorno

{
  "idTransacao (Integer)": null,
  "consolidado (Integer)": null,
  "status (String)": null,
  "situacao (String)": null,
  "origem (String)": null,
  "idPagador (Integer)": null,
  "tipoPagador (String)": null,
  "index1 (Integer)": null,
  "idResponsavel (Integer)": null,
  "idReferencia (Integer)": null,
  "tipoReferencia (String)": null,
  "idAcordoFinanceiro (Integer)": null,
  "idAcordoFinanceiroCancelamento (Integer)": null,
  "dataCancelamento (Date)": null,
  "dataEmissao (Date)": null,
  "dataVencimento (Date)": null,
  "dataCompetencia (Date)": null,
  "dataPrevisaoPagamento (Date)": null,
  "idUsuarioCancelamento (Integer)": null,
  "_usuarioCancelamento (String)": null,
  "valor (Double)": null,
  "valorOriginal (Double)": null,
  "dataPagamento (Date)": null,
  "valorPago (Double)": null,
  "valorPagoReal (Double)": null,
  "valorAPagar (Double)": null,
  "valorEncargos (Double)": null,
  "valorDescontos (Double)": null,
  "totalPago (Double)": null,
  "valorDevedor (Double)": null,
  "valorBaixa (Double)": null,
  "dataSpcSerasa (Date)": null,
  "dataProtestado (Date)": null,
  "numeroParcela (String)": null,
  "notaFiscal (String)": null,
  "nfseStatus (String)": null,
  "nfseNumero (String)": null,
  "nfseEmissao (Timestamp)": null,
  "nfseLote (String)": null,
  "nfseRetorno (String)": null,
  "motivo (String)": null,
  "observacao (String)": null,
  "motivoCancelamento (String)": null,
  "idBoletoAtivo (Integer)": null,
  "itens (ArrayList)": [],
  "descontos (ArrayList)": [],
  "descontosPerdidos (ArrayList)": [],
  "encargos (ArrayList)": [],
  "boletos (ArrayList)": [],
  "_pagador (String)": null,
  "_responsavel (String)": null,
  "isNotaFiscal (Integer)": null,
  "isAssessoriaCobranca (Integer)": null,
  "isSCPCSerasa (Integer)": null,
  "isProtestado (Integer)": null,
  "operacao (String)": null,
  "idTransacaoReferencia (Integer)": null,
  "isPrevisto (Integer)": null,
  "descricao (String)": null,
  "dadosProcessados (Integer)": null,
  "possuiRateioPagadores (Integer)": null,
  "_descricaoOrg (String)": null,
  "idContratoParcela (Integer)": null,
  "idContrato (Integer)": null,
  "_ordemSituacao (Integer)": null,
  "_ano (Integer)": null,
  "_boletoDataVencimento (Date)": null,
  "_boletoDataRemessa (Date)": null,
  "_boletoNossoNumero (String)": null,
  "_boletoDigitoVerificador (String)": null,
  "_boletoLiberadoWeb (Integer)": null,
  "_liberacaoImpressaoWeb (Integer)": null,
  "idMotivoCancelamentoTransacao (Integer)": null,
  "_descricaoMotivoCancelamentoTransacao (String)": null,
  "_quantidadeRenovacoes (Integer)": null,
  "_nomeEmpCob (String)": null,
  "_idBoletoGateway (Integer)": null,
  "id_org (Integer)": null
}

Financeiro - Registrar Pagamento

Este método permite que sistema externos registrem pagamentos no SWA.JACAD. Para que tenha sucesso, deverão ser informados todos os parâmetros listados abaixo.
Este método retorna um objeto contendo as informações do recebimento no SWA.JACAD.
Método: POST
Resposta: JSON/XML

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 para o registro do recebimento
idAgenciaConta	Sim	java.lang.Integer	Código da Conta para o registro do recebimento
idTipoRecebimento	Sim	java.lang.Integer	Código do Tipo de Recebimento para o registro do recebimento
idBoleto	Não	java.lang.Integer	Código do Boleto Bancário (opcional) para o registro do recebimento
valorPago	Sim	java.lang.Double	Valor pago para o registro do recebimento
valorEncargos	Sim	java.lang.Double	Valor de encargos
valorDescontos	Sim	java.lang.Double	Valor de descontos concedidos
dataPagamento	Sim	java.sql.Date	Data do pagamento
dataLiquidacao	Não	java.sql.Date	Data de liquidação (opcional)
observacao	Sim	java.lang.String	Alguma observação para o registro do recebimento

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/registrar-pagamento/

Formato do objeto de retorno

{
  "idTransacaoRecebimento (Integer)": null,
  "idTransacao (Integer)": null,
  "idTipoRecebimento (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "idCheque (Integer)": null,
  "idUsuarioRecebimento (Integer)": null,
  "idBoletoRecebimento (Integer)": null,
  "idRecebimentoCartao (Integer)": null,
  "dataRecebimento (Timestamp)": null,
  "dataDeposito (Timestamp)": null,
  "dataLiquidacao (Timestamp)": null,
  "valorRecebido (Double)": null,
  "valorDescontos (Double)": null,
  "valorEncargos (Double)": null,
  "consolidado (Integer)": null,
  "observacao (String)": null,
  "valorDescontoManual (Double)": null,
  "status (String)": null,
  "idUsuarioCancelamento (Integer)": null,
  "dataCancelamento (Timestamp)": null,
  "_usuarioCancelamento (String)": null,
  "_tipoRecebimento (String)": null,
  "_conta (String)": null,
  "_numeroConta (String)": null,
  "_dvConta (String)": null,
  "_usuarioRecebimento (String)": null,
  "motivo (String)": null,
  "_idCheque (Integer)": null,
  "_chequeNumero (String)": null,
  "_valorCheque (Double)": null,
  "_idResponsavel (Integer)": null,
  "_responsavel (String)": null,
  "_valorOriginal (Double)": null,
  "_valor (Double)": null,
  "_operacao (String)": null,
  "_idPagador (Integer)": null,
  "_pagador (String)": null,
  "_organizacao (String)": null,
  "_tipoReferenciaTransacao (String)": null,
  "_idReferenciaTransacao (Integer)": null,
  "_dataVencimentoTransacao (Date)": null,
  "id_org (Integer)": null
}

Financeiro - Registrar Boleto Bancário

Este método irá criar um novo boleto para uma transaçao informada. Este boleto irá respeitar o valor da transação em questão e irá utilizar o Nosso Número informado por um sistema terceiro.
Método: POST
Resposta: JSON/XML

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)
nossoNumero	Sim	java.lang.String	Nosso número gerado por um sistema terceiro
digitoVerificador	Não	java.lang.String	Dígito verificador informado por um sistema terceiro
idTransacao	Sim	java.lang.Integer	Código da transação para registro do boleto
idMetodoRecebimento	Sim	java.lang.Integer	Código do Método Recebimento/Cedente

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/boleto/registrar/

Formato do objeto de retorno

{
  "idBoleto (Integer)": null,
  "idMetodoRecebimento (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "idBoletoRateio (Integer)": null,
  "nossoNumero (String)": null,
  "digitoVerificador (String)": null,
  "dataVencimento (Date)": null,
  "dataEmissao (Date)": null,
  "valorBoleto (Double)": null,
  "liberadoWeb (Integer)": null,
  "_liberacaoImpressaoWeb (Integer)": null,
  "status (String)": null,
  "dataRemessa (Date)": null,
  "arquivoRemessa (String)": null,
  "idPagador (Integer)": null,
  "_pagador (String)": null,
  "_email (String)": null,
  "_metodoRecebimento (String)": null,
  "_cedente (String)": null,
  "_carteira (String)": null,
  "_codigoCedente (String)": null,
  "_numeroAgencia (String)": null,
  "_idTipoRecebimentoCedente (Integer)": null,
  "_valor_atualizado (Double)": null,
  "dataLiquidacao (Date)": null,
  "dataRecebimento (Date)": null,
  "valorDescontos (Double)": null,
  "valorJuros (Double)": null,
  "valorMulta (Double)": null,
  "valorRecebido (Double)": null,
  "observacaoRetorno (String)": null,
  "dataProcessamentoBanco (Date)": null,
  "motivoOcorrencia (String)": null,
  "codigoBarras (String)": null,
  "linhaDigitavel (String)": null,
  "_bancoNumero (String)": null,
  "idTransacaoRecebimentoBoleto (Integer)": null,
  "boletosDuplicados (ArrayList)": null,
  "_usuarioCancelamento (String)": null,
  "_organizacao (String)": null,
  "valorPagoAMaior (boolean)": false,
  "isAssessoriaCobranca (Integer)": null,
  "rateiosConta (ArrayList)": null,
  "rateiosRetorno (ArrayList)": null,
  "_situacaoTransacao (String)": null,
  "valorBaixado (Double)": null,
  "inconsistenciaBaixa (boolean)": false,
  "_isScpcSerasa (Integer)": null,
  "quantidadeRenovacoes (Integer)": null,
  "_idBoletoGateway (Integer)": null,
  "_utilizarConfigMetodoRecebimento (Integer)": null,
  "_statusBoletoRegistroGateway (String)": null,
  "idBoletoArquivo (Integer)": null,
  "_boletoArquivo (String)": null,
  "id_org (Integer)": null
}

Financeiro - Criar Conta a Receber (transação)

Permite criar um registro de conta a receber no sistema acadêmico com base nos parâmetros informados. Irá retornar todas as transações que foram criadas.
Método: POST
Resposta: JSON/XML

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

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/criar-conta-receber

Formato do objeto de retorno

{
  "idTransacao (Integer)": null,
  "consolidado (Integer)": null,
  "status (String)": null,
  "situacao (String)": null,
  "origem (String)": null,
  "idPagador (Integer)": null,
  "tipoPagador (String)": null,
  "index1 (Integer)": null,
  "idResponsavel (Integer)": null,
  "idReferencia (Integer)": null,
  "tipoReferencia (String)": null,
  "idAcordoFinanceiro (Integer)": null,
  "idAcordoFinanceiroCancelamento (Integer)": null,
  "dataCancelamento (Date)": null,
  "dataEmissao (Date)": null,
  "dataVencimento (Date)": null,
  "dataCompetencia (Date)": null,
  "dataPrevisaoPagamento (Date)": null,
  "idUsuarioCancelamento (Integer)": null,
  "_usuarioCancelamento (String)": null,
  "valor (Double)": null,
  "valorOriginal (Double)": null,
  "dataPagamento (Date)": null,
  "valorPago (Double)": null,
  "valorPagoReal (Double)": null,
  "valorAPagar (Double)": null,
  "valorEncargos (Double)": null,
  "valorDescontos (Double)": null,
  "totalPago (Double)": null,
  "valorDevedor (Double)": null,
  "valorBaixa (Double)": null,
  "dataSpcSerasa (Date)": null,
  "dataProtestado (Date)": null,
  "numeroParcela (String)": null,
  "notaFiscal (String)": null,
  "nfseStatus (String)": null,
  "nfseNumero (String)": null,
  "nfseEmissao (Timestamp)": null,
  "nfseLote (String)": null,
  "nfseRetorno (String)": null,
  "motivo (String)": null,
  "observacao (String)": null,
  "motivoCancelamento (String)": null,
  "idBoletoAtivo (Integer)": null,
  "itens (ArrayList)": [],
  "descontos (ArrayList)": [],
  "descontosPerdidos (ArrayList)": [],
  "encargos (ArrayList)": [],
  "boletos (ArrayList)": [],
  "_pagador (String)": null,
  "_responsavel (String)": null,
  "isNotaFiscal (Integer)": null,
  "isAssessoriaCobranca (Integer)": null,
  "isSCPCSerasa (Integer)": null,
  "isProtestado (Integer)": null,
  "operacao (String)": null,
  "idTransacaoReferencia (Integer)": null,
  "isPrevisto (Integer)": null,
  "descricao (String)": null,
  "dadosProcessados (Integer)": null,
  "possuiRateioPagadores (Integer)": null,
  "_descricaoOrg (String)": null,
  "idContratoParcela (Integer)": null,
  "idContrato (Integer)": null,
  "_ordemSituacao (Integer)": null,
  "_ano (Integer)": null,
  "_boletoDataVencimento (Date)": null,
  "_boletoDataRemessa (Date)": null,
  "_boletoNossoNumero (String)": null,
  "_boletoDigitoVerificador (String)": null,
  "_boletoLiberadoWeb (Integer)": null,
  "_liberacaoImpressaoWeb (Integer)": null,
  "idMotivoCancelamentoTransacao (Integer)": null,
  "_descricaoMotivoCancelamentoTransacao (String)": null,
  "_quantidadeRenovacoes (Integer)": null,
  "_nomeEmpCob (String)": null,
  "_idBoletoGateway (Integer)": null,
  "id_org (Integer)": null
}

Financeiro - Consultar Recebimentos efetuados

Lista todos os recebimentos efetuados na instituição ou numa organização específica combinado com vários filtros.
Método: POST
Resposta: JSON/XML

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)
dataPagamentoInicio	Não	java.sql.Date	Data de início dos pagamentos
dataPagamentoFim	Não	java.sql.Date	Data limite dos pagamentos
idAgenciaConta	Não	java.lang.Integer	Conta em que foram efetuados os recebimentos
idTipoRecebimento	Não	java.lang.Integer	Tipo do recebimento
idTransacao	Não	java.lang.Integer	Código da transação
idPerfil	Não	java.lang.Integer	Código do perfil do pagador
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/listar-recebimentos/

Formato do objeto de retorno

{
  "idTransacaoRecebimento (Integer)": null,
  "idTransacao (Integer)": null,
  "idTipoRecebimento (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "idCheque (Integer)": null,
  "idUsuarioRecebimento (Integer)": null,
  "idBoletoRecebimento (Integer)": null,
  "idRecebimentoCartao (Integer)": null,
  "dataRecebimento (Timestamp)": null,
  "dataDeposito (Timestamp)": null,
  "dataLiquidacao (Timestamp)": null,
  "valorRecebido (Double)": null,
  "valorDescontos (Double)": null,
  "valorEncargos (Double)": null,
  "consolidado (Integer)": null,
  "observacao (String)": null,
  "valorDescontoManual (Double)": null,
  "status (String)": null,
  "idUsuarioCancelamento (Integer)": null,
  "dataCancelamento (Timestamp)": null,
  "_usuarioCancelamento (String)": null,
  "_tipoRecebimento (String)": null,
  "_conta (String)": null,
  "_numeroConta (String)": null,
  "_dvConta (String)": null,
  "_usuarioRecebimento (String)": null,
  "motivo (String)": null,
  "_idCheque (Integer)": null,
  "_chequeNumero (String)": null,
  "_valorCheque (Double)": null,
  "_idResponsavel (Integer)": null,
  "_responsavel (String)": null,
  "_valorOriginal (Double)": null,
  "_valor (Double)": null,
  "_operacao (String)": null,
  "_idPagador (Integer)": null,
  "_pagador (String)": null,
  "_organizacao (String)": null,
  "_tipoReferenciaTransacao (String)": null,
  "_idReferenciaTransacao (Integer)": null,
  "_dataVencimentoTransacao (Date)": null,
  "id_org (Integer)": null
}

Financeiro - Consulta de contas a receber

Permite consultar todas as contas a receber da instituição.
Método: POST
Resposta: JSON/XML

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)
dataInicio	Sim	java.sql.Date	Vencimentos de
dataFim	Sim	java.sql.Date	até da data
idTransacao	Não	java.lang.Integer	Código da transação
idPerfil	Não	java.lang.Integer	Código do perfil do pagador
idOrg	Não	java.lang.Integer	Código da organização
situacao	Não	java.lang.String	Situação da transação (PARCIAL, ABERTO, PAGO,BAIXADA,ACORDADO)
status	Não	java.lang.String	Status da transação (ATIVO, INATIVO, CANCELADO, ACORDO)
isSomenteConsolidada	Não	boolean	Somente consolidadas
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/conta-receber/

Formato do objeto de retorno

{
  "idTransacao (Integer)": null,
  "consolidado (Integer)": null,
  "status (String)": null,
  "situacao (String)": null,
  "origem (String)": null,
  "idPagador (Integer)": null,
  "tipoPagador (String)": null,
  "index1 (Integer)": null,
  "idResponsavel (Integer)": null,
  "idReferencia (Integer)": null,
  "tipoReferencia (String)": null,
  "idAcordoFinanceiro (Integer)": null,
  "idAcordoFinanceiroCancelamento (Integer)": null,
  "dataCancelamento (Date)": null,
  "dataEmissao (Date)": null,
  "dataVencimento (Date)": null,
  "dataCompetencia (Date)": null,
  "dataPrevisaoPagamento (Date)": null,
  "idUsuarioCancelamento (Integer)": null,
  "_usuarioCancelamento (String)": null,
  "valor (Double)": null,
  "valorOriginal (Double)": null,
  "dataPagamento (Date)": null,
  "valorPago (Double)": null,
  "valorPagoReal (Double)": null,
  "valorAPagar (Double)": null,
  "valorEncargos (Double)": null,
  "valorDescontos (Double)": null,
  "totalPago (Double)": null,
  "valorDevedor (Double)": null,
  "valorBaixa (Double)": null,
  "dataSpcSerasa (Date)": null,
  "dataProtestado (Date)": null,
  "numeroParcela (String)": null,
  "notaFiscal (String)": null,
  "nfseStatus (String)": null,
  "nfseNumero (String)": null,
  "nfseEmissao (Timestamp)": null,
  "nfseLote (String)": null,
  "nfseRetorno (String)": null,
  "motivo (String)": null,
  "observacao (String)": null,
  "motivoCancelamento (String)": null,
  "idBoletoAtivo (Integer)": null,
  "itens (ArrayList)": [],
  "descontos (ArrayList)": [],
  "descontosPerdidos (ArrayList)": [],
  "encargos (ArrayList)": [],
  "boletos (ArrayList)": [],
  "_pagador (String)": null,
  "_responsavel (String)": null,
  "isNotaFiscal (Integer)": null,
  "isAssessoriaCobranca (Integer)": null,
  "isSCPCSerasa (Integer)": null,
  "isProtestado (Integer)": null,
  "operacao (String)": null,
  "idTransacaoReferencia (Integer)": null,
  "isPrevisto (Integer)": null,
  "descricao (String)": null,
  "dadosProcessados (Integer)": null,
  "possuiRateioPagadores (Integer)": null,
  "_descricaoOrg (String)": null,
  "idContratoParcela (Integer)": null,
  "idContrato (Integer)": null,
  "_ordemSituacao (Integer)": null,
  "_ano (Integer)": null,
  "_boletoDataVencimento (Date)": null,
  "_boletoDataRemessa (Date)": null,
  "_boletoNossoNumero (String)": null,
  "_boletoDigitoVerificador (String)": null,
  "_boletoLiberadoWeb (Integer)": null,
  "_liberacaoImpressaoWeb (Integer)": null,
  "idMotivoCancelamentoTransacao (Integer)": null,
  "_descricaoMotivoCancelamentoTransacao (String)": null,
  "_quantidadeRenovacoes (Integer)": null,
  "_nomeEmpCob (String)": null,
  "_idBoletoGateway (Integer)": null,
  "id_org (Integer)": null
}

Financeiro - Consulta de contas a pagar

Permite consultar todas as contas a pagar da instituição.
Método: POST
Resposta: JSON/XML

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)
dataInicio	Não	java.sql.Date	Vencimentos de
dataFim	Não	java.sql.Date	até da data
dataCompetenciaInicio	Não	java.sql.Date	data de competencia de
dataCompetenciaFim	Não	java.sql.Date	data de competencia até
dataPrevPgtoInicio	Não	java.sql.Date	data de previsão de pagamento de
dataPrevPgtoFim	Não	java.sql.Date	data de previsão de pagamento até
idTransacao	Não	java.lang.Integer	Código da transação
idPerfil	Não	java.lang.Integer	Código do perfil do fornecedor
idOrg	Não	java.lang.Integer	Código da organização
situacao	Não	java.lang.String	Situação da transação (PARCIAL, ABERTO, PAGO, BAIXADA, ACORDADO)
status	Não	java.lang.String	Status da transação (ATIVO, INATIVO, CANCELADO, ACORDO)
isSomenteConsolidada	Não	boolean	Somente consolidadas
offset	Sim	java.lang.Integer	Número de registros a serem pulados na realização da consulta (paginação)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/financeiro/conta-pagar/

Formato do objeto de retorno

{
  "idTransacao (Integer)": null,
  "consolidado (Integer)": null,
  "status (String)": null,
  "situacao (String)": null,
  "origem (String)": null,
  "idPagador (Integer)": null,
  "tipoPagador (String)": null,
  "index1 (Integer)": null,
  "idResponsavel (Integer)": null,
  "idReferencia (Integer)": null,
  "tipoReferencia (String)": null,
  "idAcordoFinanceiro (Integer)": null,
  "idAcordoFinanceiroCancelamento (Integer)": null,
  "dataCancelamento (Date)": null,
  "dataEmissao (Date)": null,
  "dataVencimento (Date)": null,
  "dataCompetencia (Date)": null,
  "dataPrevisaoPagamento (Date)": null,
  "idUsuarioCancelamento (Integer)": null,
  "_usuarioCancelamento (String)": null,
  "valor (Double)": null,
  "valorOriginal (Double)": null,
  "dataPagamento (Date)": null,
  "valorPago (Double)": null,
  "valorPagoReal (Double)": null,
  "valorAPagar (Double)": null,
  "valorEncargos (Double)": null,
  "valorDescontos (Double)": null,
  "totalPago (Double)": null,
  "valorDevedor (Double)": null,
  "valorBaixa (Double)": null,
  "dataSpcSerasa (Date)": null,
  "dataProtestado (Date)": null,
  "numeroParcela (String)": null,
  "notaFiscal (String)": null,
  "nfseStatus (String)": null,
  "nfseNumero (String)": null,
  "nfseEmissao (Timestamp)": null,
  "nfseLote (String)": null,
  "nfseRetorno (String)": null,
  "motivo (String)": null,
  "observacao (String)": null,
  "motivoCancelamento (String)": null,
  "idBoletoAtivo (Integer)": null,
  "itens (ArrayList)": [],
  "descontos (ArrayList)": [],
  "descontosPerdidos (ArrayList)": [],
  "encargos (ArrayList)": [],
  "boletos (ArrayList)": [],
  "_pagador (String)": null,
  "_responsavel (String)": null,
  "isNotaFiscal (Integer)": null,
  "isAssessoriaCobranca (Integer)": null,
  "isSCPCSerasa (Integer)": null,
  "isProtestado (Integer)": null,
  "operacao (String)": null,
  "idTransacaoReferencia (Integer)": null,
  "isPrevisto (Integer)": null,
  "descricao (String)": null,
  "dadosProcessados (Integer)": null,
  "possuiRateioPagadores (Integer)": null,
  "_descricaoOrg (String)": null,
  "idContratoParcela (Integer)": null,
  "idContrato (Integer)": null,
  "_ordemSituacao (Integer)": null,
  "_ano (Integer)": null,
  "_boletoDataVencimento (Date)": null,
  "_boletoDataRemessa (Date)": null,
  "_boletoNossoNumero (String)": null,
  "_boletoDigitoVerificador (String)": null,
  "_boletoLiberadoWeb (Integer)": null,
  "_liberacaoImpressaoWeb (Integer)": null,
  "idMotivoCancelamentoTransacao (Integer)": null,
  "_descricaoMotivoCancelamentoTransacao (String)": null,
  "_quantidadeRenovacoes (Integer)": null,
  "_nomeEmpCob (String)": null,
  "_idBoletoGateway (Integer)": null,
  "id_org (Integer)": null
}

Básicos - Consultar Métodos de Recebimento

Lista todos os métodos de recebimento/cedente ativos da instituição.
Método: POST
Resposta: JSON/XML

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)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/basicos/metodos-de-recebimento/

Formato do objeto de retorno

{
  "idMetodoRecebimento (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "idTipoRecebimento (Integer)": null,
  "_idBanco (Integer)": null,
  "nome (String)": null,
  "idBoletoGateway (Integer)": null,
  "_utilizarConfigMetodoRecebimento (Integer)": null,
  "_gateway (String)": null,
  "codigoCedente (String)": null,
  "cedente (String)": null,
  "carteira (String)": null,
  "unidadeCedente (String)": null,
  "status (String)": null,
  "sequencia1 (String)": null,
  "sequencia2 (String)": null,
  "sequencia3 (String)": null,
  "sequencia4 (String)": null,
  "sequencia5 (String)": null,
  "especieDocumento (String)": null,
  "localPagamento1 (String)": null,
  "localPagamento2 (String)": null,
  "classNossoNumero (String)": null,
  "classDigitoVerificador (String)": null,
  "classArquivoRemessa (String)": null,
  "classBanco (String)": null,
  "_agenciaConta (String)": null,
  "_numeroAgencia (String)": null,
  "_dvAgencia (String)": null,
  "_numeroConta (String)": null,
  "_dvConta (String)": null,
  "boletosPorPagina (Integer)": null,
  "naoValidarDigitoVerificador (Integer)": null,
  "naoValidarCodigoBoleto (Integer)": null,
  "naoCobrarEncargos (Integer)": null,
  "considerarDescontosRetorno (Integer)": null,
  "naoValidarEnderecoParaRemessa (Integer)": null,
  "utilizarSequencialRemessaBanco (Integer)": null,
  "naoValidarPagadorMenorIdade (Integer)": null,
  "cnpj (String)": null,
  "enderecoCedente (String)": null,
  "ufEnderecoCedente (String)": null,
  "cepEnderecoCedente (String)": null,
  "template (String)": null,
  "liberacaoImpressaoWeb (Integer)": null,
  "considerarSomenteInstrucoesSelecionadas (Integer)": null,
  "diasProtesto (Integer)": null,
  "diasBaixa (Integer)": null,
  "imagemLogoBoleto (String)": null,
  "jasperEnvelopeBoleto (String)": null,
  "jasperBoleto (String)": null,
  "idSequencialRemessaBanco (Integer)": null,
  "_sequencialRemessa (String)": null,
  "codigoOcorrenciaAlteracao (String)": null,
  "integradoNexxera (Integer)": null,
  "nexxeraAmbiente (String)": null,
  "nexxeraServerName (String)": null,
  "nexxeraDataUltimaRemessa (Date)": null,
  "nexxeraNumeroRemessa (Integer)": null,
  "nexxeraIdUsuarioProcessamento (Integer)": null,
  "nexxeraPeriodoQtde (Integer)": null,
  "nexxeraPeriodo (String)": null,
  "nexxeraNaoGerarRemessa (Integer)": null,
  "nexxeraNaoGerenciarRetorno (Integer)": null,
  "id_org (Integer)": null
}

Básicos - Consultar Contas Bancárias

Lista todas as contas bancárias ativas da instituição.
Método: POST
Resposta: JSON/XML

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)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/basicos/contas-bancarias/

Formato do objeto de retorno

{
  "idAgenciaConta (Integer)": null,
  "idAgencia (Integer)": null,
  "nome (String)": null,
  "numero (String)": null,
  "dvConta (String)": null,
  "status (String)": null,
  "saldo (Double)": null,
  "tipoConta (String)": null,
  "sequencialArquivoRemessa (String)": null,
  "consolidado (Integer)": null,
  "_idCliente (Integer)": null,
  "_codBanco (String)": null,
  "_numeroAgencia (String)": null,
  "_dvAgencia (String)": null,
  "_agencia (String)": null,
  "_banco (String)": null,
  "_idBanco (Integer)": null,
  "idPlanoConta (Integer)": null,
  "id_org (Integer)": null
}

Básicos - Consultar Planos de Contas

Lista todos os planos de contas ativos da instituição podendo ser filtrado pelo tipo de operação.
Método: POST
Resposta: JSON/XML

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)
operacao	Sim	java.lang.String	Tipo do plano (SOMA/SUBTRAI)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/basicos/planos-de-contas/

Formato do objeto de retorno

{
  "idPlanoConta (Integer)": null,
  "descricao (String)": null,
  "codigo (String)": null,
  "indice (String)": null,
  "operacao (String)": null,
  "tipoConta (String)": null,
  "idCliente (Integer)": null,
  "idGrupoContabil (Integer)": null,
  "_grupoContabil (String)": null,
  "idGrupoContas (Integer)": null,
  "_grupoContas (String)": null,
  "nrSubPlanos (Integer)": null,
  "status (String)": null,
  "natureza (String)": null,
  "redutora (Integer)": null,
  "baixaCancelamento (Integer)": null,
  "baixaDiversa (Integer)": null,
  "baixaConvenio (Integer)": null,
  "ocultarDemonstrativo (Integer)": null,
  "nivel (Integer)": null,
  "projecoes (ArrayList)": null,
  "projecoesEconomicas (ArrayList)": null,
  "dreRealizados (ArrayList)": null,
  "idPlanoContaPassivo (Integer)": null,
  "idPlanoContaAtivo (Integer)": null,
  "idPlanoContaAdiantamento (Integer)": null,
  "idFornecedor (Integer)": null,
  "contaContabil (String)": null,
  "id_org (Integer)": null
}

Básicos - Consultar Centros de Custos

Lista todos os Centros de Custos ativos na instituição.
Método: POST
Resposta: JSON/XML

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)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/basicos/centros-de-custos/

Formato do objeto de retorno

{
  "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,
  "id_org (Integer)": null
}

Básicos - Consultar Tipo de Acordo Financeiro

Lista todos os Tipos de Acordo Financeiro ativos na instituição.
Método: POST
Resposta: JSON/XML

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)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/basicos/tipos-acordo-financeiro/

Formato do objeto de retorno

{
  "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,
  "id_org (Integer)": null
}

Básicos - Consultar Tipos de Recebimento

Lista todos os tipos de recebimento/pagamento disponíveis na instituição.
Método: POST
Resposta: JSON/XML

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)
tipoRecebimento	Sim	java.lang.String	Tipo do recebimento/pagamento (DINHEIRO, CHEQUE, CARTAO)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/basicos/tipos-de-recebimento/

Formato do objeto de retorno

{
  "idTipoRecebimento (Integer)": null,
  "descricao (String)": null,
  "status (String)": null,
  "tipoRecebimento (String)": null,
  "tipoCredito (String)": null,
  "taxa (Double)": null,
  "maximoParcelas (Integer)": null,
  "diasCarencia (Integer)": null,
  "diaRecebimento (Integer)": null,
  "diaPagamento (Integer)": null,
  "diaFechamentoFatura (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "idCliente (Integer)": null,
  "id_org (Integer)": null
}