English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.int.varejo.convenios
Web service Com.senior.g5.co.int.varejo.convenios
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_int_varejo_convenios?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_convenios?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_convenios?wsdl
Portas
Exportar
Integrações - Varejo - Cadastros - Exportar Convênios
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:Exportar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codEmp>Integer</codEmp>
<consulta>
<codCnv>Integer</codCnv>
</consulta>
<codFil>Integer</codFil>
<tipoIntegracao>String</tipoIntegracao>
<quantidadeRegistros>Integer</quantidadeRegistros>
<sigInt>String</sigInt>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| consulta | Set | (Obrigatório) - Utilizar apenas quando o tipo de integração for específico ("E") |
| consulta.codCnv | Integer | (Opcional) - Number(004) - Código do convênio |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
| quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Obrigatório quando o tipo de integração for "T" ou "A". Quando o tipo de integração for "E", este valor não é utilizado |
| sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integraçã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:ExportarResponse>
<result>
<convenio>
<codCnv>Integer</codCnv>
<desCnv>String</desCnv>
<diaFat>Integer</diaFat>
<tipCnv>Integer</tipCnv>
<sitCnv>String</sitCnv>
<aplSbc>Integer</aplSbc>
<codTpr>String</codTpr>
<seqInt>Integer</seqInt>
<grupo>
<codGps>String</codGps>
<perLpv>Double</perLpv>
<vlrLpv>Double</vlrLpv>
<sitLpv>String</sitLpv>
</grupo>
<formapagamento>
<codfpg>Integer</codfpg>
</formapagamento>
<indSen>String</indSen>
</convenio>
<resultado>
<codCnv>Integer</codCnv>
<observacao>String</observacao>
</resultado>
<finalizaramRegistros>String</finalizaramRegistros>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<numLot>Integer</numLot>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</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" |
| convenio | Set | |
| convenio.codCnv | Integer | (Obrigatório) - Number(004) - Código do convênio |
| convenio.desCnv | String | (Obrigatório) - String(050) - Descrição do convênio |
| convenio.diaFat | Integer | (Obrigatório) - Number(002) - Dia do fechamento em que encerram as vendas |
| convenio.tipCnv | Integer | (Obrigatório) - Number(002) - Tipo de Convênio - Lista: 01 = Farmácia Popular, 02 = e-Pharma, 97 = Convêno Cliente, 98 = Convênio Empresa, 99 = Outros |
| convenio.sitCnv | String | (Obrigatório) - String(001) - Situação do convênio - Lista: A = Ativo, I = Inativo |
| convenio.aplSbc | Integer | Tipo de aplicação de subsídio quando o item estiver em vários grupos |
| convenio.codTpr | String | (Obrigatório) - Código da tabela de preço |
| convenio.seqInt | Integer | Number(007) - Sequência do registro |
| convenio.grupo | Set | |
| convenio.grupo.codGps | String | Código do Grupo de Produto/Serviço |
| convenio.grupo.perLpv | Double | Percentual de participação |
| convenio.grupo.vlrLpv | Double | Valor de participação |
| convenio.grupo.sitLpv | String | Situação da ligação (Ativo ou Inativo) |
| convenio.formapagamento | Set | |
| convenio.formapagamento.codfpg | Integer | |
| convenio.indSen | String | Indicativo se exige senha para cartão do conveniado no Varejo |
| resultado | Set | (Opcional) - Este elemento poderá ser enviado apenas quando o tipo de integração for "E" (registro específico). Neste tipo de integração, quando os dados enviados no elemento "consulta" não puderem ser consultados, o serviço retornará no elemento "resultado" os dados enviados no elemento "consulta" e o motivo pelo qual não foi possível exportá-lo. |
| resultado.codCnv | Integer | (Obrigatório) - Number(004) - Código do convênio |
| resultado.observacao | String | (Obrigatório) - String(100) - Motivo do registro não ter sido exportado |
| finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| 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 |
| numLot | Integer | (Obrigatório) - Number(7) - Número do lote |
Exportar_2
Integrações - Varejo - Cadastros - Exportar Convênios
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 2
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:Exportar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codEmp>Integer</codEmp>
<consulta>
<codCnv>Integer</codCnv>
</consulta>
<codFil>Integer</codFil>
<tipoIntegracao>String</tipoIntegracao>
<quantidadeRegistros>Integer</quantidadeRegistros>
<sigInt>String</sigInt>
</parameters>
</ser:Exportar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| consulta | Set | (Obrigatório) - Utilizar apenas quando o tipo de integração for específico ("E") |
| consulta.codCnv | Integer | (Opcional) - Number(004) - Código do convênio |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
| quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Obrigatório quando o tipo de integração for "T" ou "A". Quando o tipo de integração for "E", este valor não é utilizado |
| sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integraçã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:ExportarResponse>
<result>
<convenio>
<codCnv>Integer</codCnv>
<desCnv>String</desCnv>
<diaFat>Integer</diaFat>
<diaVen>Integer</diaVen>
<tipCnv>Integer</tipCnv>
<sitCnv>String</sitCnv>
<aplSbc>Integer</aplSbc>
<codTpr>String</codTpr>
<seqInt>Integer</seqInt>
<grupo>
<codGps>String</codGps>
<perLpv>Double</perLpv>
<vlrLpv>Double</vlrLpv>
<sitLpv>String</sitLpv>
</grupo>
<formapagamento>
<codfpg>Integer</codfpg>
</formapagamento>
<indSen>String</indSen>
<condicaopagamento>
<codcpg>String</codcpg>
<indPad>String</indPad>
</condicaopagamento>
<filiais>
<codFil>Integer</codFil>
<sitReg>String</sitReg>
</filiais>
</convenio>
<resultado>
<codCnv>Integer</codCnv>
<observacao>String</observacao>
</resultado>
<finalizaramRegistros>String</finalizaramRegistros>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<numLot>Integer</numLot>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| convenio.codCnv | Integer | Number(004) - Código do convênio |
| convenio.desCnv | String | String(050) - Descrição do convênio |
| convenio.diaFat | Integer | Number(002) - Dia do fechamento em que encerram as vendas |
| convenio.diaVen | Integer | Dia do mês em que vencem as parcelas geradas em convênio |
| convenio.tipCnv | Integer | Number(002) - Tipo de Convênio - Lista: 01 = Farmácia Popular, 02 = e-Pharma, 97 = Convêno Cliente, 98 = Convênio Empresa, 99 = Outros |
| convenio.sitCnv | String | String(001) - Situação do convênio - Lista: A = Ativo, I = Inativo |
| convenio.aplSbc | Integer | Tipo de aplicação de subsídio quando o item estiver em vários grupos |
| convenio.codTpr | String | Código da tabela de preço |
| convenio.seqInt | Integer | Number(007) - Sequência do registro |
| grupo.codGps | String | Código do Grupo de Produto/Serviço |
| grupo.perLpv | Double | Percentual de participação |
| grupo.vlrLpv | Double | Valor de participação |
| grupo.sitLpv | String | Situação da ligação (Ativo ou Inativo) |
| formapagamento | Set | |
| formapagamento.codfpg | Integer | Código da forma de pagamento |
| convenio.indSen | String | Indicativo se exige senha para cartão do conveniado no Varejo |
| condicaopagamento | Set | |
| condicaopagamento.codcpg | String | Código da forma de pagamento |
| condicaopagamento.indPad | String | Indicativo de que esta forma de pagamento é padrão para o convênio |
| filiais | Set | |
| filiais.codFil | Integer | Código da filial |
| filiais.sitReg | String | Situação do registro |
| resultado | Set | Este elemento poderá ser enviado apenas quando o tipo de integração for "E" (registro específico). Neste tipo de integração, quando os dados enviados no elemento "consulta" não puderem ser consultados, o serviço retornará no elemento "resultado" os dados enviados no elemento "consulta" e o motivo pelo qual não foi possível exportá-lo. |
| resultado.codCnv | Integer | Number(004) - Código do convênio |
| resultado.observacao | String | String(100) - Motivo do registro não ter sido exportado |
| finalizaramRegistros | String | String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| tipoRetorno | Integer | Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | String | String(1000) - Mensagem de Retorno de Processamento |
| numLot | Integer | Number(7) - Número do lote |
| 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 sucesso; - A mensagem do erro ocorrido no servidor. |
ExportarItens
Integrações - Varejo - Cadastros - Exportar Convênios X Produtos
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:ExportarItens>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codEmp>Integer</codEmp>
<consulta>
<codCnv>Integer</codCnv>
<codPro>String</codPro>
<codDer>String</codDer>
</consulta>
<codFil>Integer</codFil>
<tipoIntegracao>String</tipoIntegracao>
<quantidadeRegistros>Integer</quantidadeRegistros>
<sigInt>String</sigInt>
</parameters>
</ser:ExportarItens>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
| consulta | Set | (Obrigatório) - Utilizar apenas quando o tipo de integração for específico ("E"). Deverá ser informado codCnv ou codPro. Ao informar codDer, informar também codPro. |
| consulta.codCnv | Integer | (Opcional) - Number(004) - Código do convênio |
| consulta.codPro | String | (Opcional) - String(014) - Código do produto |
| consulta.codDer | String | (Opcional) - String(007) - Código da derivação do produto. |
| codFil | Integer | (Obrigatório) - Number(005) - Código da Filial |
| tipoIntegracao | String | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
| quantidadeRegistros | Integer | (Opcional) - Number(005) - Quantidade de registros limite para retorno da solicitação. Obrigatório quando o tipo de integração for "T" ou "A". Quando o tipo de integração for "E", este valor não é utilizado |
| sigInt | String | (Obrigatório) - String(15) - Sigla do Sistema de Integraçã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:ExportarItensResponse>
<result>
<convenio>
<codCnv>Integer</codCnv>
<aplSbc>Integer</aplSbc>
<codTpr>String</codTpr>
<seqInt>Integer</seqInt>
<item>
<codPro>String</codPro>
<codDer>String</codDer>
<codPdv>String</codPdv>
<perLpv>Double</perLpv>
<vlrLpv>Double</vlrLpv>
<sitLpv>String</sitLpv>
<seqInt>Integer</seqInt>
</item>
<indSen>String</indSen>
</convenio>
<resultado>
<codCnv>Integer</codCnv>
<codPro>String</codPro>
<codDer>String</codDer>
<observacao>String</observacao>
</resultado>
<finalizaramRegistros>String</finalizaramRegistros>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<numLot>Integer</numLot>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarItensResponse>
</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" |
| convenio | Set | |
| convenio.codCnv | Integer | (Obrigatório) - Number(004) - Código do convênio |
| convenio.aplSbc | Integer | Tipo de aplicação de subsídio quando o item estiver em vários grupos |
| convenio.codTpr | String | Código da tabela de preço |
| convenio.seqInt | Integer | (Obrigatório) - Number(007) - Sequência do registro |
| convenio.item | Set | (Obrigatório) - Relação de produtos ligados ao convênio |
| convenio.item.codPro | String | (Obrigatório) - String(014) - Código do produto |
| convenio.item.codDer | String | (Obrigatório) - String(007) - Código da derivação do produto |
| convenio.item.codPdv | String | (Obrigatório) - Number(010) - Código interno no PDV |
| convenio.item.perLpv | Double | (Obrigatório) - Number(3,2) - % Participação |
| convenio.item.vlrLpv | Double | (Obrigatório) - Number(9,2) - Valor de Participação |
| convenio.item.sitLpv | String | (Obrigatório) - String(001) - Situação da ligação - Lista: A = Ativo, I = Inativo |
| convenio.item.seqInt | Integer | (Obrigatório) - Number(007) - Sequência do registro |
| convenio.indSen | String | Indicativo se exige senha para cartão do conveniado no Varejo |
| resultado | Set | (Opcional) - Este elemento poderá ser enviado apenas quando o tipo de integração for "E" (registro específico). Neste tipo de integração, quando os dados enviados no elemento "consulta" não puderem ser consultados, o serviço retornará no elemento "resultado" os dados enviados no elemento "consulta" e o motivo pelo qual não foi possível exportá-lo. |
| resultado.codCnv | Integer | (Opcional) - Number(004) - Código do convênio |
| resultado.codPro | String | (Opcional) - String(014) - Código do produto |
| resultado.codDer | String | (Opcional) - String(007) - Código da derivação |
| resultado.observacao | String | (Obrigatório) - String(100) - Motivo do registro não ter sido exportado |
| finalizaramRegistros | String | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| 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 |
| numLot | Integer | (Obrigatório) - Number(7) - Número do lote |
Consultar
Integrações - Varejo - Cadastros - Consultar Saldo 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:Consultar>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<codCli>String</codCli>
<codCnv>String</codCnv>
</parameters>
</ser:Consultar>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| codCli | String | (Obrigatório) - Number(009) - Código do cliente. |
| codCnv | String | (Obrigatório) - Number(004) - Código do convênio. |
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:ConsultarResponse>
<result>
<retornosConsulta>
<codCli>Integer</codCli>
<codCnv>String</codCnv>
<salCli>String</salCli>
<salCnv>String</salCnv>
</retornosConsulta>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ConsultarResponse>
</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" |
| retornosConsulta | Set | |
| retornosConsulta.codCli | Integer | (Obrigatório) - Number(009) - Código do cliente. |
| retornosConsulta.codCnv | String | (Obrigatório) - Number(004) - Código do convênio. |
| retornosConsulta.salCli | String | (Obrigatório) - Number(15,2) - Valor de saldo do cliente no convênio. |
| retornosConsulta.salCnv | String | (Obrigatório) - Number(15,2) - Valor de saldo do convênio. |
| 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
