1. API de Integração
  2. Métodos para integração com o Quero Bolsa
Quero Bolsa - Consultar recebimentos dos polos

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)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/quero-bolsa/recebimentos-por-polo

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
}
Quero Bolsa - 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
honrarDescontosPerdidos Sim java.lang.Integer [0,1] Manter os descontos mesmo após vencimento.

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/quero-bolsa/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
}
Quero Bolsa - 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)

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/quero-bolsa/contas-a-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
}
Quero Bolsa - Criar Acordo Financeiro

Cria um novo acordo financeiro tendo como base ids das transações a serem acordadas.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
transacoes Sim [Ljava.lang.Integer; Array com códigos das transações a serem acordadas.
valorEntrada Sim java.lang.Double Valor de valor de entrada
dataEntrada Sim java.sql.Date Data para o valor de entrada
dataPrimeiraParcela Sim java.sql.Date Data para a primeira parcela
parcelamentoProposto Sim java.lang.Integer Número de parcelas proposta. O número pode ser alterar caso o sistema detecte um número inválido.
motivo Sim java.lang.String Descrição do motivo da realização deste acordo
percentualJuros Não java.lang.Double Percentual(%) de juros
acrescimoEncargos Não java.lang.Double Valor de encargo
acrescimoDesconto Não java.lang.Double Valor de desconto
idTipoAcordoFinanceiro Não java.lang.Integer Código do Tipo de Acordo
idMetodoRecebimento Não java.lang.Integer Código do Metodo de Recebimento para geração dos boletos
isAcessoriaCobranca Não java.lang.Integer [0,1] Flag para demarcar acessoria de cobrança
format Não java.lang.String Formato do retorno (JSON/XML). Default JSON.

URIs de acesso

http://187.60.217.18:8080/academico/api/v1/quero-bolsa/criar-acordo-finaneiro

Formato do objeto de retorno

{
  "idAcordoFinanceiro (Integer)": null,
  "idPerfil (Integer)": null,
  "idPeriodoLetivo (Integer)": null,
  "idAlunoCursoIngresso (Integer)": null,
  "_nome (String)": null,
  "dataAcordo (Date)": null,
  "totalValorOriginal (Double)": null,
  "totalValorPagar (Double)": null,
  "totalValorPagarCalculado (Double)": null,
  "valorConvenios (Double)": null,
  "encargosCalculados (Double)": null,
  "descontosCalculados (Double)": null,
  "acrescimoDesconto (Double)": null,
  "acrescimoEncargos (Double)": null,
  "valorFinalAcordo (Double)": null,
  "subTotal (Double)": null,
  "total (Double)": null,
  "numeroParcelas (Integer)": null,
  "testemunhaUm (String)": null,
  "rgTestemunhaUm (String)": null,
  "testemunhaDois (String)": null,
  "rgTestemunhaDois (String)": null,
  "motivo (String)": null,
  "status (String)": null,
  "dataCancelamento (Date)": null,
  "idUsuarioCancelamento (Integer)": null,
  "valorEntrada (Double)": null,
  "dataEntrada (Date)": null,
  "acrescimoJurosMensal (Double)": null,
  "acessociaCobranca (boolean)": true,
  "valorTotalAcrescimoJurosMensal (Double)": null,
  "idUsuarioAcordo (Integer)": null,
  "_usuarioAcordo (String)": null,
  "_valorPagoTransacao (Double)": null,
  "_organizacao (String)": null,
  "consolidado (Integer)": null,
  "idTipoAcordoFinanceiro (Integer)": null,
  "_tipoAcordo (String)": null,
  "id_org (Integer)": null
}