Documentação referente ao serviço de integração com o módulo financeiro do sistema Mentor Web. Esse serviço está disponível para receber informações de parcelas e débitos financeiros a gerar no módulo financeiro do Mentor. Portanto trata-se de um recurso importante para integrações entre sistemas como, por exemplo, softwares de biblioteca que poderão enviar as multas dos alunos na biblioteca para que esses valores sejam cobrados e gerenciados pelo módulo financeiro do Mentor.
O webservice vai obedecer as regras abaixo para geração da parcela/débito financeiro:
1. | Quando for enviada pelo software de biblioteca a data de vencimento, a parcela utilizará a mesma, caso contrário, o vencimento da parcela será calculado de acordo com o número de dias para o vencimento definido nas configurações acrescentado na data de geração desta parcela; |
2. | O tipo de debito será o que está definido nas configurações; |
3. | Se configurado que usuário decide na entrega do livro como deseja fazer o pagamento (débito ou parcela), então o que foi configurado no MentorWeb será desconsiderado, prevalecendo o que foi enviado pelo software da biblioteca; |
4. | O número da parcela será o próximo disponível dentre as parcelas do contrato financeiro e tipo de débito; |
5. | A parcela será vinculada ao último contrato do aluno, desconsiderando os contratos de renegociação; |
6. | O responsável da parcela será aquele configurado no contrato financeiro para pagamento de taxa, obedecendo o percentual de responsabilidade configurado, ou seja, gerando uma parcela proporcional para cada responsável. Se o percentual de taxa do responsável for igual a zero, o sistema atribuirá o próprio aluno como responsável da parcela. Se a pessoa não possuir contrato, a parcela/débito será gerada para a própria pessoa. |
Para verificar o “WSDL” pode-se acessar conforme abaixo:
http://<<domínio>>/<<aplicação_ICoruja>>/services/IntegracaoFinanceiraICorujaWS?wsdl
Método do Web Service:
geraValorAPagar: Este método irá gerar uma parcela ou um débito financeiro para a pessoa informada ou para os responsáveis pelo contrato.
Parâmetros:
Nome
|
Descrição
|
Tipo
|
Obrigatório
|
Formato
|
Observação
|
valorPagarIDStr
|
Identificador do valor a ser pago. Utilizado depois na baixa do débito
|
Inteiro
|
S
|
|
Exemplo: ID da multa, ID do débito financeiro, etc.
|
pessoaCodTel
|
Código da pessoa cadastrada no Mentor Web
|
Alfanumérico
|
S
|
|
|
dataGeracaoStr
|
Data de geração
|
Data
|
S
|
DD/MM/YYYY
|
|
dataVencimentoStr
|
Data de vencimento
|
Data
|
N
|
DD/MM/YYYY
|
Caso não informado:
- Quando for sistema de biblioteca será assumida a data de geração somando o número de dias para o vencimento que é configurado nos parâmetros da biblioteca no MentorWeb.
- Quando não for sistema de biblioteca, assume a data atual.
|
valorStr
|
Valor a pagar
|
Decimal
|
S
|
999999999,99
|
Deverá ser maior que zero.
|
identificadorAcao
|
Forma como será cobrado o valor
|
Inteiro
|
N
|
|
Obrigatório apenas quando não for sistema biblioteca. Valores possíveis:
1=Gera parcela a receber
2=Gera débito financeiro
|
tipoIntegracao
|
Sistema terceiro chamador
|
Alfanumérico
|
S
|
|
Passar fixo: BIBLIOTECA
|
codUnidade
|
Código da unidade
|
Alfanumérico
|
N
|
|
Informar o ID da unidade no sistema.
|
Retorno: Valor alfanumérico conforme códigos abaixo:
Código
|
Descrição
|
000
|
Sucesso
|
001
|
Tipo de sistema diferente de BIBLIOTECA.
|
002
|
Pessoa não não informada.
|
003
|
Tipo de sistema inválido (Ex.: Biblioteca, ERP, Outro).
|
004
|
Valor a pagar inválido.
|
005
|
O tipo de sistema informado está configurado para não realizar integração financeira nos parâmetros da biblioteca no MentorWeb. Entre em contato com a secretaria.
|
006
|
O tipo de débito não está configurado nos parâmetros gerais do MentorWeb. Entre em contato com a secretaria.
|
007
|
Data de vencimento inválida.
|
008
|
Identificador do valor à pagar inválido.
|
009
|
Data de geração inválida.
|
010
|
Já existe parcela com o ID de multa recebido.
|
011
|
Data de geração inválida.
|
Anexo I
Exemplo de integração em php:
<?php
$client = new SoapClient(
'http://localhost:8080/ICoruja/services/IntegracaoFinanceiraICorujaWS?wsdl',
array(
// Stuff for development.
'trace' => 1,
'exceptions' => true,
'cache_wsdl' => WSDL_CACHE_NONE,
'features' => SOAP_SINGLE_ELEMENT_ARRAYS,
// Auth credentials for the SOAP request.
'login' => 'usuario',
'password' => 'senha',
// Proxy url.
'proxy_host' => 'localhost', // não utilizar "http" na frente
'proxy_port' => 8080,
// Auth credentials for the proxy.
'proxy_login' => NULL,
'proxy_password' => NULL,
)
);
$function = 'geraValorAPagar';
$arguments= array(
'valorPagarIDStr' => '3737',
'pessoaCodTel' => '1006198',
'dataGeracaoStr' => '06/11/2016',
'dataVencimento' => '01/12/2016',
'valorStr' => '11,00',
'identificadorAcao' => '2',
'tipoIntegracao' => 'BIBLIOTECA',
'codUnidade' => '1'
);
$options = array('location' => 'http://localhost:8080/ICoruja/services/IntegracaoFinanceiraICorujaWS?wsdl');
$result = $client->__soapCall($function, $arguments, $options);
echo 'Response: ';
print_r($result);
?>
Observação: Segue abaixo o usuário e senha para realizar a integração:
Usuário: userIF
Senha: IntegracaoFinanceira26102012
|