English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.ger.convenio
Web service Com.senior.g5.co.ger.convenio
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.
Campos que representam valores monetários, quantidade e percentual e estão declarados como String
- 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
Exemplo:
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.
Campos que representam valores monetários, quantidade e percentual e não estão declarados como String
- 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
Exemplo:
- 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_ger_convenio?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_convenio?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_ger_convenio?wsdl
Portas
Consumir
ConsumirRequisição: Parâmetros da requisição:
Resposta:Atributos da resposta:
Cadastros - Convênio - Consumir Convênio
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Consumir>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<entrada>
<codCnv>Integer</codCnv>
<codCli>Integer</codCli>
<vlrUti>Double</vlrUti>
<datUti>String</datUti>
</entrada>
</parameters>
</ser:Consumir>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Descrição |
|---|---|---|
| entrada | Set | |
| entrada.codCnv | Integer | (Obrigatório) - Number(004) - Código do Convênio |
| entrada.codCli | Integer | (Obrigatório) - Number(009) - Código do Cliente |
| entrada.vlrUti | Double | (Obrigatório) - Number(011) - Valor utilizado |
| entrada.datUti | DateTime | (Obrigatório) - Date(000) - Data Utilizaçã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:ConsumirResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<retorno>
<codCnv>Integer</codCnv>
<codCli>Integer</codCli>
<vlrUti>String</vlrUti>
<datUti>String</datUti>
<salCnv>String</salCnv>
<salCli>String</salCli>
<retorno>String</retorno>
</retorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsumirResponse>
</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" |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| retorno | Set | |
| retorno.codCnv | Integer | (Obrigatório) - Number(004) - Código do Convênio |
| retorno.codCli | Integer | (Obrigatório) - Number(009) - Código do Cliente |
| retorno.vlrUti | String | (Obrigatório) - Number(9,2) - Valor a ser consumido do convênio |
| retorno.datUti | DateTime | (Obrigatório) - Date - Data da Utilização |
| retorno.salCnv | String | (Obrigatório) - Number(13,2) - Saldo disponível no convênio após utilização.
Caso ocorrer erro de excedido o limite o saldo disponível será o valor disponível para o convênio. Se convênio não possuir limite o saldo disponível será 9.999.999.999.999,99. |
| retorno.salCli | String | (Obrigatório) - Number(13,2) - Saldo disponível do cliente no convênio após utilização
Caso ocorrer erro de excedido o limite o saldo disponível será o valor disponível do cliente no convênio. |
| retorno.retorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno do Consumo do Convênio: OK = Processo Executado com Sucesso, Mensagem = Mensagem do problema ocorrido |
Estornar
EstornarRequisição: Parâmetros da requisição:
Resposta:Atributos da resposta:
Cadastros - Convênio - Extornar Convênio
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:Estornar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<entrada>
<codCnv>Integer</codCnv>
<codCli>Integer</codCli>
<vlrUti>Double</vlrUti>
<datUti>String</datUti>
</entrada>
</parameters>
</ser:Estornar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Descrição |
|---|---|---|
| entrada | Set | |
| entrada.codCnv | Integer | (Obrigatório) - Number(004) - Código do Convênio |
| entrada.codCli | Integer | (Obrigatório) - Number(009) - Código do Cliente |
| entrada.vlrUti | Double | (Obrigatório) - Number(9,2) - Valor a ser estornado do convênio |
| entrada.datUti | DateTime | (Obrigatório) - Date - Data do extorno |
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:EstornarResponse>
<result>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<retorno>
<codCnv>Integer</codCnv>
<codCli>Integer</codCli>
<vlrUti>String</vlrUti>
<datUti>String</datUti>
<salCnv>String</salCnv>
<salCli>String</salCli>
<retorno>String</retorno>
</retorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:EstornarResponse>
</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" |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
| retorno | Set | |
| retorno.codCnv | Integer | (Obrigatório) - Number(004) - Código do Convênio |
| retorno.codCli | Integer | (Obrigatório) - Number(009) - Código do Cliente |
| retorno.vlrUti | String | (Obrigatório) - Number(9,2) - Valor a ser estornado do convênio |
| retorno.datUti | DateTime | (Obrigatório) - Date - Data do extorno |
| retorno.salCnv | String | (Obrigatório) - Number(13,2) - Saldo disponível no convênio após extorno.
Se convênio não possuir limite o saldo disponível será 9.999.999.999.999,99. |
| retorno.salCli | String | (Obrigatório) - Number(13,2) - Saldo disponível do cliente no convênio após utilização
Caso ocorrer erro de excedido o limite o saldo disponível será o valor disponível do cliente no convênio. Number(13,2) - Saldo disponível do cliente no convênio após extorno |
| retorno.retorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno do extorno do Convênio: OK = Processo Executado com Sucesso, Mensagem = Mensagem do problema ocorrido |
ConsumirNoCupom
ConsumirNoCupomRequisição: Parâmetros da requisição:
Resposta:Atributos da resposta:
Cadastros - Convênio - Consumir Convênio No Cupom
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:ConsumirNoCupom>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<entrada>
<ideExt>String</ideExt>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codEqu>Integer</codEqu>
<croEcf>Integer</croEcf>
<numCfi>Integer</numCfi>
<codCnv>Integer</codCnv>
<codCli>Integer</codCli>
<vlrUti>Double</vlrUti>
<datEmi>String</datEmi>
</entrada>
</parameters>
</ser:ConsumirNoCupom>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Descrição |
|---|---|---|
| entrada | Set | |
| entrada.ideExt | String | (Obrigatório) - String(030) - Identificador da requisição. Enviar uma identificação única para cada ocorrência do elemento |
| entrada.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| entrada.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| entrada.codEqu | Integer | (Opcional) - Number(003) - Código do equipamento fiscal. |
| entrada.croEcf | Integer | (Opcional) - Number(003) - Contador de Reinício de Operação. |
| entrada.numCfi | Integer | (Obrigatório) - Number(006) - Número do cupom fiscal. |
| entrada.codCnv | Integer | (Obrigatório) - Number(004) - Código do convênio. |
| entrada.codCli | Integer | (Obrigatório) - Number(009) - Código do cliente. |
| entrada.vlrUti | Double | (Obrigatório) - Number(011,2) - Valor utilizado do convênio. |
| entrada.datEmi | DateTime | (Obrigatório) - Date(000) - Data Utilização (DD/MM/AAAA) |
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:ConsumirNoCupomResponse>
<result>
<retorno>
<ideExt>String</ideExt>
<salCnv>Double</salCnv>
<salCli>Double</salCli>
<retorno>String</retorno>
</retorno>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsumirNoCupomResponse>
</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" |
| retorno | Set | |
| retorno.ideExt | String | (Obrigatório) - String(030) - Irá conter o identificador enviado na requisição através do elemento <entrada>.<ideExt /></entrada> |
| retorno.salCnv | Double | (Obrigatório) - Number(13,2) - Saldo disponível no convênio após utilização.
Caso ocorrer erro de excedido o limite o saldo disponível será o valor disponível para o convênio. Se convênio não possuir limite o saldo disponível será 9.999.999.999.999,99. |
| retorno.salCli | Double | (Obrigatório) - Number(13,2) - Saldo disponível do cliente no convênio após utilização
Caso ocorrer erro de excedido o limite o saldo disponível será o valor disponível do cliente no convênio. |
| retorno.retorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno do Consumo do Convênio: OK = Processo Executado com Sucesso, Mensagem = Mensagem do problema ocorrido |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
EstornarConvenioCupom
EstornarConvenioCupomRequisição: Parâmetros da requisição:
Resposta:Atributos da resposta:
Cadastros - Convênio - Estornar Convênio No Cupom
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
<soapenv:Body>
<ser:EstornarConvenioCupom>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<entrada>
<ideExt>String</ideExt>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<codEqu>Integer</codEqu>
<croEcf>Integer</croEcf>
<numCfi>Integer</numCfi>
<codCnv>Integer</codCnv>
<codCli>Integer</codCli>
<datEmi>String</datEmi>
</entrada>
</parameters>
</ser:EstornarConvenioCupom>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Descrição |
|---|---|---|
| entrada | Set | |
| entrada.ideExt | String | (Obrigatório) - String(030) - Identificador da requisição. Enviar uma identificação única para cada ocorrência do elemento |
| entrada.codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| entrada.codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| entrada.codEqu | Integer | (Opcional) - Number(003) - Código do equipamento fiscal. |
| entrada.croEcf | Integer | (Opcional) - Number(003) - Contador de Reinício de Operação. |
| entrada.numCfi | Integer | (Obrigatório) - Number(006) - Número do cupom fiscal. |
| entrada.codCnv | Integer | (Opcional) - Number(004) - Código do convênio. |
| entrada.codCli | Integer | (Opcional) - Number(009) - Código do cliente. Condição: Obrigatório se CodCnv for informado. |
| entrada.datEmi | DateTime | (Obrigatório) - Date(000) - Data Utilização (DD/MM/AAAA) |
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:EstornarConvenioCupomResponse>
<result>
<retorno>
<ideExt>String</ideExt>
<retorno>String</retorno>
</retorno>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:EstornarConvenioCupomResponse>
</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" |
| retorno | Set | |
| retorno.ideExt | String | (Obrigatório) - String(030) - Irá conter o identificador enviado na requisição através do elemento <entrada>.<ideExt /></entrada> |
| retorno.retorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno do Consumo do Convênio: OK = Processo Executado com Sucesso, Mensagem = Mensagem do problema ocorrido |
| tipoRetorno | Integer | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
English
Español
