Web service com.senior.g5.co.mfi.cpa.gerarcomissao
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_mfi_cpa_gerarcomissao?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mfi_cpa_gerarcomissao?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_mfi_cpa_gerarcomissao?wsdl
Porta
Gravar_2
Finanças - Gestão de Contas a Pagar - Comissões - Geração de Comissão
Necessita autenticação: Sim
Situação de versão: Atual
Versão atual: 2
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Gravar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <codRep>Integer</codRep> <datBas>DateTime</datBas> <datLib>DateTime</datLib> <vlrCom>Double</vlrCom> <vlrBco>Double</vlrBco> <perCom>Double</perCom> <codTns>String</codTns> <obsCap>String</obsCap> </parameters> </ser:Gravar> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Descrição |
---|---|---|
codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
codRep | Integer | (Obrigatório) - Number(004) - Código do Representante |
datBas | DateTime | (Obrigatório) - Data - Data Base |
datLib | DateTime | (Obrigatório) - Data - Data de Liberação |
vlrCom | Double | (Obrigatório) - Number(015) - Valor da Comissão. Se não informar o valor da comissão, o valor base e o percentual da comissão deverão ser informados. |
vlrBco | Double | (Obrigatório) - Number(015) - Valor Base de Comissão. Se informar o valor da comissão, o valor base da comissão pode ser opcional. |
perCom | Double | (Obrigatório) - Number(007) - Percentual de Comissão. Se informar o valor da comissão, o percentual da comissão pode ser opcional. |
codTns | String | (Obrigatório) - String(005) - Código de Transação |
obsCap | String | (Opcional) - String(250) - Observação da Comissão |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:GravarResponse> <result> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:GravarResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Descrição |
---|---|---|
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
resultado | String | O campo resultado irá retornar as seguintes mensagens:
Execução do serviço sem erros: Inclusão: "OK - conta cadastrada[sequência]" Execução do serviço com erros: "'OK - conta já existente[sequência]" ou a "mensagem do erro". |