Web service Com.senior.g5.co.int.varejo.definicaometa
O serviço tem por finalidade tratar a exportação das metas que estejam devidamente cadastradas no sistema.
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_int_varejo_definicaometa?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_varejo_definicaometa?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_varejo_definicaometa?wsdl
Porta
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Integrações - Varejo - Metas - Exportar Definições de Metas
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<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> <competencia>String</competencia> <codRep>String</codRep> </consulta> <codFil>Integer</codFil> <tipoIntegracao>String</tipoIntegracao> <quantidadeRegistros>Integer</quantidadeRegistros> <identificacaoSistema>String</identificacaoSistema> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
codEmp | Integer | (Obrigatório) - Number(004) - Código da Empresa |
consulta | Set | (Obrigatório) - (String (007) - (MM/AAAA)- Utilizar para informar quais registros devem ser retornados. Utilizar apenas quando o tipo de integração for específico ("E") |
consulta.competencia | String | Competência da Meta (MM/YYYY): (Obrigatório se tipo de consulta = "E")
Competência da Meta - (MM/AAAA)- Utilizar para informar quais registros devem ser retornados. Utilizar apenas quando o tipo de integração for específico ("E") |
consulta.codRep | String | (Opcional) - CodRep - Number(004) - Código do representante. |
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. Quando o tipo de integração for "E", este valor não é utilizado. |
identificacaoSistema | String | (Obrigatório) - String(15) - - Identificação do sistema integrado |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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> <periodo> <codPme>Integer</codPme> <cptPme>String</cptPme> <proSer>String</proSer> <desPme>String</desPme> <tipApu>Integer</tipApu> <sitPme>String</sitPme> <seqDme>Integer</seqDme> <desDme>String</desDme> <mgcGer>Double</mgcGer> <perFre>Double</perFre> <sitDme>String</sitDme> <obsDme>String</obsDme> <seqInt>String</seqInt> <datCns>String</datCns> <filial> <codFil>Integer</codFil> <perHfi>Double</perHfi> <vlrHfi>Double</vlrHfi> <perRea>Double</perRea> <vlrRea>Double</vlrRea> <mgcHfi>Double</mgcHfi> <forApu>Integer</forApu> <codAgp>String</codAgp> <varSer>String</varSer> <perQtd>Double</perQtd> <vendedores> <codRep>Integer</codRep> <codFil>Integer</codFil> <codAgp>String</codAgp> <varSer>String</varSer> <perQtd>Double</perQtd> <perRep>Double</perRep> <vlrRep>Double</vlrRep> <perRea>Double</perRea> <vlrRea>Double</vlrRea> <mgcRep>Double</mgcRep> <forApu>Integer</forApu> <metFil>Integer</metFil> </vendedores> </filial> <pmt> <datIni>String</datIni> <datFin>String</datFin> <varSer>String</varSer> <perPmt>Double</perPmt> <qtdDtr>Integer</qtdDtr> </pmt> </periodo> <gridErros> <msgErr>String</msgErr> </gridErros> <finalizaramRegistros>String</finalizaramRegistros> <tipoRetorno>Integer</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <numeroLote>Integer</numeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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" |
periodo | Set | |
periodo.codPme | Integer | (Obrigatório) - CodPme - Number(004) - Código período meta |
periodo.cptPme | String | (Obrigatório) - CptPme - Date(MM/YYYY) - Mês e ano base da meta |
periodo.proSer | String | (Obrigatório) - ProSer - String(001) - Solicitação de produto ou serviço - Lista: P = Produto, S = Serviço |
periodo.desPme | String | (Opcional) - DesPme - String(100) - Descrição da meta |
periodo.tipApu | Integer | (Obrigatório) - TipApu - Number(001) - Tipo de apuração da meta - Lista: 0 = Apuração por Valor, 1 = Apuração por Quantidade, 2 = Apu(Obrigatório) - ração Mista |
periodo.sitPme | String | (Obrigatório) - SitPme - String(001) - Situação do período da meta - Lista: 1 = Digitado, 2 = Fechado, 3 = Finalizado, 4 = Faturado, 5 = Cancelado |
periodo.seqDme | Integer | (Obrigatório) - SeqDme - Number(004) - Sequência da definição da meta |
periodo.desDme | String | (Opcional) - DesDme - String(100) - Descrição da meta |
periodo.mgcGer | Double | (Opcional) - MgcGer - Number(014,5) - Percentual de margem de contribuição geral para a rede |
periodo.perFre | Double | (Opcional) - PerFre - Number(014,5) - Percentual geral para a meta de frete |
periodo.sitDme | String | (Obrigatório) - SitDme - String(001) - Situação da definição da meta - Lista: 1 = Digitado, 2 = Fechado, 3 = Finalizado, 4 = Faturado, 5 = Cancelado |
periodo.obsDme | String | (Opcional) - ObsDme - String(250) - Observação da definição |
periodo.seqInt | String | (Inteiro) - Número seqüencial do registro de exportação |
periodo.datCns | String | (Obrigatório) - DatCns - Date(DD/MM/YYYY) - Data da consulta |
periodo.filial | Set | |
periodo.filial.codFil | Integer | (Obrigatório) - CodFil - Number(005) - Código da filial |
periodo.filial.perHfi | Double | (Opcional) - PerHfi - Number(014,5) - Percentual de vendas sobre a filial |
periodo.filial.vlrHfi | Double | (Opcional) - VlrHfi - Number(015,5) - Valor base para a filial |
periodo.filial.perRea | Double | (Opcional) - PerRea - Number(014,5) - Valor realizado pela filial |
periodo.filial.vlrRea | Double | (Opcional) - VlrRea - Number(015,5) - Valor realizado pela filial |
periodo.filial.mgcHfi | Double | (Opcional) - MgcHfi - Number(014,5) - Percentual de margem de contribuição da filial |
periodo.filial.forApu | Integer | (Opcional) - ForApu - Number(001) - Forma de apuração - Lista: 0 = Por Valor, 1 = Por Quantidade |
periodo.filial.codAgp | String | (Opcional) - CodAgp - Number(004) - Código do agrupamento comercial dos produtos |
periodo.filial.varSer | String | (Opcional) - VarSer - String(001) - Indica o tipo de serviço para o Varejo |
periodo.filial.perQtd | Double | (Opcional) - PerQtd - Number(014,5) - Percentual de vendas sobre a categoria do representante por quantidade |
periodo.filial.vendedores | Set | |
periodo.filial.vendedores.codRep | Integer | (Obrigatório) - CodRep - Number(009) - Código do representante |
periodo.filial.vendedores.codFil | Integer | (Opcional) - CodFil - Number(005) - Código da filial |
periodo.filial.vendedores.codAgp | String | (Opcional) - CodAgp - Number(004) - Código do agrupamento comercial dos produtos |
periodo.filial.vendedores.varSer | String | (Opcional) - VarSer - String(001) - Indica o tipo de serviço para o Varejo |
periodo.filial.vendedores.perQtd | Double | (Opcional) - PerQtd - Number(014,5) - Percentual de vendas sobre a categoria do representante por quantidade |
periodo.filial.vendedores.perRep | Double | (Opcional) - PerHfi - Number(014,5) - Percentual de vendas sobre a filial |
periodo.filial.vendedores.vlrRep | Double | (Opcional) - VlrRep - Number(015,5) - Valor base para o representante |
periodo.filial.vendedores.perRea | Double | (Opcional) - PerRea - Number(014,5) - Valor realizado pelo representante |
periodo.filial.vendedores.vlrRea | Double | (Opcional) - VlrRea - Number(015,5) - Valor realizado pelo representante |
periodo.filial.vendedores.mgcRep | Double | (Opcional) - MgcHfi - Number(014,5) - Percentual de margem de contribuição do representante |
periodo.filial.vendedores.forApu | Integer | (Opcional) - ForApu - Number(001) - Forma de apuração - Lista: 0 = Por Valor, 1 = Por Quantidade |
periodo.filial.vendedores.metFil | Integer | (Opcional) - MetFil - String(001) - Indicativo se a meta do vendedor é a meta da filial. Lista: 1 - Sim; 0 - Não. |
periodo.pmt | Set | |
periodo.pmt.datIni | DateTime | (Obrigatório) - DatIni - Date(DD/MM/YYYY) - Data inicial |
periodo.pmt.datFin | DateTime | (Obrigatório) - DatFin - Date(DD/MM/YYYY) - Data final |
periodo.pmt.varSer | String | (Opcional) - VarSer - String(001) - Indica o tipo de serviço para o Varejo |
periodo.pmt.perPmt | Double | (Opcional) - PerPmt - Number(014,5) - Percentual de PMT para o período |
periodo.pmt.qtdDtr | Integer | (Opcional) - Number(005) - Quantidade de dias trabalhados/úteis do período. |
gridErros | Set | (Opcional) - Lista dos erro |
gridErros.msgErr | String | Erros |
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 |
numeroLote | Integer | (Obrigatório) - Inteiro - Identificação do Lote de Exportação |