PORTAL DE DOCUMENTAÇÃO
Gestão Empresarial | ERP - versão 5.10.3 (XTended)
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.cad.parametrosintegracao

Web service Com.senior.g5.co.cad.parametrosintegracao

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.

ClosedCampos 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
ClosedExemplo:

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.

ClosedCampos 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
ClosedExemplo:
  • 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

Portas

ClosedConsultarGeral_2

ConsultarGeral_2

Através dessa porta é possível obter uma coleção de dados através dos filtros disponíveis.

A opção de agrupamento por UF não retorna mais de um registro por UF. Se em um estado existirem filiais com informações diferentes ocasionando uma quebra no agrupamento, o web service retornará uma mensagem de erro.

Necessita autenticação: Sim.

Situação da versão: 2.

Versão: 2.

ClosedRequisição: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:ConsultarGeral>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <codEmp>Integer</codEmp>
        <CptGru>
          <cptGru>String</cptGru>
        </CptGru>
        <codFil>Integer</codFil>
        <CptSub>
          <cptSub>String</cptSub>
        </CptSub>
        <identificadorSistema>String</identificadorSistema>
        <CptChv>
          <cptChv>String</cptChv>
        </CptChv>
        <indicePagina>Integer</indicePagina>
        <CodFilFiltro>
          <codFil>Integer</codFil>
          <cNPJFilial>String</cNPJFilial>
        </CodFilFiltro>
        <limitePagina>Integer</limitePagina>
        <SigUfs>
          <sigUfs>String</sigUfs>
        </SigUfs>
        <cNPJFilial>String</cNPJFilial>
        <agruparUF>String</agruparUF>
      </parameters>
    </ser:ConsultarGeral>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:
Nome Tipo Preenchimento Ajuda
codEmp Integer Opcional (Opcional) - Number(004) - Código da Empresa
cptGru Set Opcional (Opcional) - Lista de abrangência dos grupos
cptGru.cptGru String Opcional (Opcional) - String(100) - Nome do grupo do parâmetro de configuração
codFil Integer Opcional (Opcional) - Number(005) - Código da Filial
cptSub Set Opcional (Opcional) - Lista de abrangência dos subgrupos
cptSub.cptSub String Opcional (Opcional) - String(100) - Nome do subgrupo do parâmetro de configuração
identificadorSistema String Opcional (Obrigatório) - String(15) - Sigla do Sistema de Integração
cptChv Set Opcional (Opcional) - Lista de chaves
cptChv.cptChv String Opcional (Opcional - String(100) - Nome da chave do parâmetro de configuração
indicePagina Integer Opcional (Opcional) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais.
codFilFiltro Set Opcional (Opcional) - Lista de abrangência
codFilFiltro.codFil Integer Opcional (Opcional) - Number(005) - Código da filial
codFilFiltro.cNPJFilial String Opcional (Opcional) - String(014) - CNPJ da filial. Quando informado o CNPJ, o sistema considera somente as filiais que não são consolidadoras de movimentos de impostos.
limitePagina Integer Opcional (Opcional) - Number - Para informações em relação a esse campo, consulte o item Limite de página e índice de página na documentação Configurações especiais.
sigUfs Set Opcional (Opcional) - Lista de unidades federativas
sigUfs.sigUfs String Opcional (Opcional) - String(002) - Sigla da unidade federativa
cNPJFilial String Opcional (Opcional) - String(014) - CNPJ da Filial. Quando informado o CNPJ, o sistema considera somente as filiais que não são consolidadoras de movimentos de impostos.
agruparUF String Opcional (Opcional) - String(001) - Indicativo se o resultado da consulta deve ser agrupado por estado (S = Sim; N = Não)
ClosedResposta:

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:ConsultarGeralResponse>
      <result>
        <Erros>
          <mensagemErro>String</mensagemErro>
        </Erros>
        <mensagemRetorno>String</mensagemRetorno>
        <parametroIntegracao>
          <cptChv>String</cptChv>
          <cptGru>String</cptGru>
          <desGru>String</desGru>
          <cptSub>String</cptSub>
          <desSub>String</desSub>
          <desCur>String</desCur>
          <desLon>String</desLon>
          <ideUni>Integer</ideUni>
          <ideCpt>Integer</ideCpt>
          <codEmp>Integer</codEmp>
          <codFil>Integer</codFil>
          <cpvVal>String</cpvVal>
          <cNPJFilial>String</cNPJFilial>
          <sigUfs>String</sigUfs>
        </parametroIntegracao>
        <tipoRetorno>Integer</tipoRetorno>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ConsultarGeralResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos da resposta:
Nome Tipo Preenchimento Ajuda
erros Set Opcional (Opcional) - Lista dos erros
erros.mensagemErro String Opcional (Opcional) - Itens da lista de erros
mensagemRetorno String Obrigatório (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento
parametroIntegracao Set Opcional Lista de parâmetros de integração
parametroIntegracao.cptChv String Opcional String(100) - Identificador chave interno
parametroIntegracao.cptGru String Opcional String(100) - Nome do grupo do parâmetro de configuração
parametroIntegracao.desGru String Opcional String(100) - Descrição do grupo do parâmetro de configuração
parametroIntegracao.cptSub String Opcional String(100) - Nome do subgrupo do parâmetro de configuração
parametroIntegracao.desSub String Opcional String(100) - Descrição do subgrupo do parâmetro de configuração
parametroIntegracao.desCur String Opcional String(100) - Descrição curta do parâmetro de configuração
parametroIntegracao.desLon String Opcional String(250) - Descrição longa do parâmetro de configuração
parametroIntegracao.ideUni Integer Opcional Number(009) - Identificador de registro
parametroIntegracao.ideCpt Integer Opcional Number(009) - Identificador das configurações dos parâmetros de tipos
parametroIntegracao.codEmp Integer Opcional Number(004) - Código da empresa
parametroIntegracao.codFil Integer Opcional Number(005) - Código da filial
parametroIntegracao.cpvVal String Opcional String(250) - Valor do parâmetro de configuração
parametroIntegracao.cNPJFilial String Opcional
parametroIntegracao.sigUfs String Opcional String(002) - Sigla do estado da filial da empresa
tipoRetorno Integer Obrigatório (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação
erroExecucao String Opcional 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.
ClosedExportar

Exportar

Após executar o web service será retornado um número de lote, esse número deve ser usado com o código da integração "166" para retornar ao ERP a confirmação de recebimento dos registros, executando o web service com.senior.g5.co.int.geral.exportacao, porta Confirmar.

Necessita autenticação: Sim.

Situação da versão: 1.

Versão: 1.

ClosedRequisiçã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>
        <ideUni>String</ideUni>
        <codFil>Integer</codFil>
        <identificadorSistema>String</identificadorSistema>
        <quantidadeRegistros>Integer</quantidadeRegistros>
        <tipoIntegracao>String</tipoIntegracao>
      </parameters>
    </ser:Exportar>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:
Nome Tipo Descrição
codEmp Integer (Obrigatório) - Number(004) - Código da Empresa
ideUni String (Opcional) - Number(011) - Identificador das configurações dos parâmetros de valores
codFil Integer (Obrigatório) - Number(005) - Código da Filial
identificadorSistema String (Obrigatório) - String(15) - Sigla do Sistema de Integração
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.
tipoIntegracao String (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico
ClosedResposta:

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>
        <Erros>
          <mensagemErro>String</mensagemErro>
        </Erros>
        <tipoRetorno>Integer</tipoRetorno>
        <parametroIntegracao>
          <seqInt>Integer</seqInt>
          <cptChv>String</cptChv>
          <cptGru>String</cptGru>
          <desGru>String</desGru>
          <cptSub>String</cptSub>
          <desSub>String</desSub>
          <desCur>String</desCur>
          <desLon>String</desLon>
          <ideUni>Integer</ideUni>
          <ideCpt>Integer</ideCpt>
          <codEmp>Integer</codEmp>
          <codFil>Integer</codFil>
          <cpvVal>String</cpvVal>
        </parametroIntegracao>
        <mensagemRetorno>String</mensagemRetorno>
        <finalizaramRegistros>String</finalizaramRegistros>
        <numeroLote>Integer</numeroLote>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ExportarResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos da resposta:
Nome Tipo Descrição
erros Set (Opcional) - Lista dos erro
erros.mensagemErro String (Opcional) - Itens da lista de erros
tipoRetorno Integer (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação
parametroIntegracao Set Lista de parâmetros de integração
parametroIntegracao.seqInt Integer (Opcional) Number(008) - Número seqüencial do registro de exportação
parametroIntegracao.cptChv String String(100) - Identificador chave interno
parametroIntegracao.cptGru String String(100) - Nome do grupo do parâmetro de configuração
parametroIntegracao.desGru String String(100) - Descrição do grupo do parâmetro de configuração
parametroIntegracao.cptSub String String(100) - Nome do subgrupo do parâmetro de configuração
parametroIntegracao.desSub String String(100) - Descrição do subgrupo do parâmetro de configuração
parametroIntegracao.desCur String String(100) - Descrição curta do parâmetro de configuração
parametroIntegracao.desLon String String(250) - Descrição longa do parâmetro de configuração
parametroIntegracao.ideUni Integer Number(009) - Identificador de registro
parametroIntegracao.ideCpt Integer Number(009) - Identificador das configurações dos parâmetros de tipos
parametroIntegracao.codEmp Integer Number(004) - Código da empresa
parametroIntegracao.codFil Integer Number(005) - Código da filial
parametroIntegracao.cpvVal String String(250) - Valor do parâmetro de configuração
mensagemRetorno String (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento
finalizaramRegistros String (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não
numeroLote Integer Obrigatório - Inteiro - Identificação do Lote de Exportaçã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 sucesso; - A mensagem do erro ocorrido no servidor.
ClosedGravar

Gravar

Observação

Consulte aqui as chaves para integração ERP XT e CRM.

Necessita autenticação: Sim.

Situação da versão: Atual.

Versão: 1.

Versão atual: 1.

ClosedRequisiçã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>
        <grupo>String</grupo>
        <parametrosIntegracao>
          <chave>String</chave>
          <valor>String</valor>
        </parametrosIntegracao>
        <codEmp>Integer</codEmp>
        <codFil>Integer</codFil>
      </parameters>
    </ser:Gravar>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:
Nome Tipo Descrição
grupo String (Obrigatório) - String(100) - Descrição do grupo
parametrosIntegracao Set  
parametrosIntegracao.chave String (Obrigatório) - String(100) - Chave do parâmetro de configuração
parametrosIntegracao.valor String (Obrigatório) - String(250) - Valor do parâmetro de configuração
codEmp Integer (Obrigatório) - Number(004) - Código da Empresa
codFil Integer (Obrigatório) - Number(005) - Código da Filial
ClosedResposta: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:GravarResponse>
      <result>
        <tipoRetorno>Integer</tipoRetorno>
        <erros>
          <mensagemErro>String</mensagemErro>
        </erros>
        <mensagemRetorno>String</mensagemRetorno>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:GravarResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos da resposta:
Nome Tipo Descrição
tipoRetorno Integer (Obrigatório) - Number(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas)
erros Set (Opcional) - Lista dos erro
erros.mensagemErro String (Opcional) - Itens da lista de erros
mensagemRetorno String (Obrigatório) - String(255) - Mensagem de retorno da situação da execução do serviç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 sucesso
    • A mensagem do erro ocorrido no servidor
  • Só impede a gravação quando o retorno.tipRet for igual a "2"

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).

Ver site completo