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

Web service Com.senior.g5.co.ger.cad.fornecedores

Importante

Para mais informações sobre atualização cadastral de clientes, fornecedores e transportadoras através de uma consulta ao cadastro centralizado da SEFAZ, realizada por meio de uma integração do Gestão Empresarial | ERP com o eDocs, verifique a documentação do processo.

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

ClosedExcluirFornecedores

Permite a exclusão de fornecedores.

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:ExcluirFornecedores>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <sigInt>String</sigInt>
        <dadosGeraisFornecedor>
          <codFor>Integer</codFor>
        </dadosGeraisFornecedor>
      </parameters>
    </ser:ExcluirFornecedores>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:
Nome Tipo Preenchimento Descrição
sigInt String Opcional Sigla do sistema integrador
dadosGeraisFornecedor Set Opcional Dados gerais do fornecedor
dadosGeraisFornecedor.codFor Integer Obrigatório Código do fornecedor
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:ExcluirFornecedoresResponse>
      <result>
        <retornosFornecedores>
          <codFor>Integer</codFor>
          <tipoRetorno>Integer</tipoRetorno>
          <retorno>String</retorno>
        </retornosFornecedores>
        <tipoRetorno>Integer</tipoRetorno>
        <mensagemRetorno>String</mensagemRetorno>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:ExcluirFornecedoresResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos da resposta:
Nome Tipo Preenchimento Descrição
retornosFornecedores Set Opcional Retorno da execução do serviço
retornosFornecedores.codFor Integer Opcional Código do fornecedor
retornosFornecedores.tipoRetorno Integer Opcional Tipo do retorno da execução do serviço
retornosFornecedores.retorno String Opcional Retorno da execução do serviço
tipoRetorno Integer Opcional Tipo do retorno da execução do serviço
mensagemRetorno String Opcional Mensagem do retorno da execução do serviço
erroExecucao String Opcional Indicativo de erro de execução
ClosedGravarContatos

Cadastros - Clientes e Fornecedores - Fornecedores - Gravar Contatos.

Necessita autenticação: sim.

Situação de versão: atual.

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:GravarContatos>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <eCodFor>String</eCodFor>
        <eNomCto>String</eNomCto>
        <eSeqCto>String</eSeqCto>
        <eDatNas>String</eDatNas>
        <cadastroUsuario>
          <nOMCMP>String</nOMCMP>
          <vALCMP>String</vALCMP>
        </cadastroUsuario>
        <eCodNiv>Integer</eCodNiv>
        <eSetCto>String</eSetCto>
        <eCarCto>String</eCarCto>
        <eFonCto>String</eFonCto>
        <eRamCto>String</eRamCto>
        <eFaxCto>String</eFaxCto>
        <eIntNet>String</eIntNet>
        <eHobCon>String</eHobCon>
        <eTimCon>String</eTimCon>
        <eSitCto>String</eSitCto>
        <eCpfCto>String</eCpfCto>
      </parameters>
    </ser:GravarContatos>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:
Nome Tipo Descrição
eCodFor String  
eNomCto String  
eSeqCto String  
eDatNas DateTime  
cadastroUsuario Set  
cadastroUsuario.nOMCMP String  
cadastroUsuario.vALCMP String  
eCodNiv Integer  
eSetCto String  
eCarCto String  
eFonCto String  
eRamCto String  
eFaxCto String  
eIntNet String  
eHobCon String  
eTimCon String  
eSitCto String  
eCpfCto String Número do CPF do contato
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:GravarContatosResponse>
      <result>
        <resultado>String</resultado>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:GravarContatosResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos 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 Resultado da Execução do Serviço - String(250) - Caso o título seja gravado com sucesso conforme foi enviado retorna a o texto fixo "OK" (Sem Aspas), Caso ocorra algum problema é retornada a mensagem de erro.
ClosedGravarFornecedores

Cadastros - Clientes e Fornecedores - Fornecedores - Gravar Fornecedores.

Importante

O parâmetro global AltFisCad define se os campos referente a tributação do cadastro de cliente serão atualizados no cadastro do fornecedor caso o vínculo Cliente X Fornecedor estiver ativo. O valor padrão é "S - Sim" para atualizar os campos fiscais. Para mais informações, acesse a documentação do parâmetro global.

O parâmetro global UtiViaCep pode ser habilitado para utilizar o web service ViaCep para buscar dados de CEPs não cadastrados na tela F008CEP.

Observação

A validação de Inscrição Estadual ocorre também durante uma alteração de dados do Fornecedor de Tipo de Mercado = I - interno, mesmo que a alteração realizada neste momento não tenha sido na Inscrição Estadual.

Por se tratar de uma operação sem interação do usuário, não há como fazer uma escolha da mesma forma que é feito em tela, onde permite manter a Inscrição Estadual incorreta ou corrigir. No web service foi definido que se a Inscrição Estadual está incorreta não permitirá realizar a inclusão, pois isto poderia gerar várias inclusões inconsistentes sem que o usuário tivesse conhecimento.

Para o caso onde não se deseja informar uma Inscrição Estadual, basta deixá-la em branco em vez de manter uma informação inválida no campo.

No caso de uma alteração onde há uma inscrição incorreta informada, ao enviar um valor em branco o web service entende que não houve modificação de valor, mantém o valor antigo e apresenta a mensagem de erro A Inscrição Estadual está incorreta para o Estado informado. Dessa forma, é necessário informar ISENTO no campo de inscrição estadual no web service. Ou ainda, através da tela F095CAD, excluir o valor incorreto da inscrição estadual que está gravado para o fornecedor em questão.

Quando houver um cliente ligado ao fornecedor e este não tiver uma inscrição estadual válida, estiver como ISENTO, for fornecedor do exterior e tiver o parâmetro global USAENTORI igual a "N - Não", automaticamente o campo Cliente Contribuinte ICMS será alterado para "N - Não".

Caso queira controlar a geração de pendências no cadastro do fornecedor, é possível habilitar este recurso na tela Parâmetros de Integração (F191CPT) por meio do campo Gerar pendência na importação do fornecedor, disponível no grupo Fornecedor e subgrupo Gerais.

Necessita autenticação: sim.

Situação de versão: atual.

Versão: 8

ClosedRequisição: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:GravarFornecedores>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <dadosGeraisFornecedor>
          <codFor>Integer</codFor>
          <nomFor>String</nomFor>
          <apeFor>String</apeFor>
          <tipFor>String</tipFor>
          <tipEmp>Integer</tipEmp>
          <tipMer>String</tipMer>
          <insEst>String</insEst>
          <insMun>String</insMun>
          <cgcCpf>String</cgcCpf>
          <codSuf>String</codSuf>
          <endFor>String</endFor>
          <cplEnd>String</cplEnd>
          <baiFor>String</baiFor>
          <zipCod>String</zipCod>
          <cepFor>Integer</cepFor>
          <cepIni>Integer</cepIni>
          <cidFor>String</cidFor>
          <sigUfs>String</sigUfs>
          <fonFor>String</fonFor>
          <fonFo2>String</fonFo2>
          <fonFo3>String</fonFo3>
          <faxFor>String</faxFor>
          <cxaPst>Integer</cxaPst>
          <intNet>String</intNet>
          <nomVen>String</nomVen>
          <fonVen>String</fonVen>
          <rmlVen>Integer</rmlVen>
          <faxVen>String</faxVen>
          <codIac>Integer</codIac>
          <abrIac>String</abrIac>
          <indBsp>String</indBsp>
          <sitFor>String</sitFor>
          <codPai>String</codPai>
          <gerDir>String</gerDir>
          <ideFor>String</ideFor>
          <qtdDep>Integer</qtdDep>
          <recPis>String</recPis>
          <perPid>String</perPid>
          <triIss>String</triIss>
          <recCof>String</recCof>
          <perCod>String</perCod>
          <retCof>String</retCof>
          <retCsl>String</retCsl>
          <retPis>String</retPis>
          <retOur>String</retOur>
          <recIpi>String</recIpi>
          <recIcm>String</recIcm>
          <triIcm>String</triIcm>
          <triIpi>String</triIpi>
          <retPro>String</retPro>
          <retIrf>String</retIrf>
          <indFor>String</indFor>
          <limRet>String</limRet>
          <numRge>String</numRge>
          <perRir>String</perRir>
          <perRin>String</perRin>
          <nenFor>String</nenFor>
          <definicoesFornecedor>
            <codEmp>Integer</codEmp>
            <codFil>Integer</codFil>
            <codTpr>String</codTpr>
            <codCpg>String</codCpg>
            <codFpg>Integer</codFpg>
            <codTra>Integer</codTra>
            <codPor>String</codPor>
            <codCrt>String</codCrt>
            <pagJmm>String</pagJmm>
            <pagDtj>Integer</pagDtj>
            <pagMul>String</pagMul>
            <pagDtm>Integer</pagDtm>
            <perDsc>String</perDsc>
            <tolDsc>Integer</tolDsc>
            <antDsc>String</antDsc>
            <perDs1>String</perDs1>
            <perDs2>String</perDs2>
            <perDs3>String</perDs3>
            <perDs4>String</perDs4>
            <perDs5>String</perDs5>
            <perFun>String</perFun>
            <perIns>String</perIns>
            <indInd>String</indInd>
            <perFre>String</perFre>
            <perSeg>String</perSeg>
            <perEmb>String</perEmb>
            <perEnc>String</perEnc>
            <perOut>String</perOut>
            <perIss>String</perIss>
            <perIrf>String</perIrf>
            <cifFob>String</cifFob>
            <perIne>String</perIne>
            <ctaRed>Integer</ctaRed>
            <ctaAux>Integer</ctaAux>
            <ctaAad>Integer</ctaAad>
            <przEnt>Integer</przEnt>
            <qtdDcv>Integer</qtdDcv>
            <criEdv>String</criEdv>
            <codBan>String</codBan>
            <tipTcc>Integer</tipTcc>
            <codAge>String</codAge>
            <ccbFor>String</ccbFor>
            <codCrp>String</codCrp>
            <pagTir>String</pagTir>
            <ctaRcr>Integer</ctaRcr>
            <ctaFdv>Integer</ctaFdv>
            <ctaFcr>Integer</ctaFcr>
            <seqOrm>Integer</seqOrm>
            <codFav>Double</codFav>
            <rvlCfr>String</rvlCfr>
            <rvlFre>String</rvlFre>
            <rvlSeg>String</rvlSeg>
            <rvlEmb>String</rvlEmb>
            <rvlEnc>String</rvlEnc>
            <rvlOut>String</rvlOut>
            <rvlDar>String</rvlDar>
            <rvlFei>String</rvlFei>
            <rvlSei>String</rvlSei>
            <rvlOui>String</rvlOui>
            <codDep>String</codDep>
            <forMon>String</forMon>
            <pgtMon>String</pgtMon>
            <pgtFre>String</pgtFre>
            <tnsPro>String</tnsPro>
            <tnsSer>String</tnsSer>
            <codEdc>String</codEdc>
            <cqdCvn>String</cqdCvn>
            <perSen>String</perSen>
            <perGil>String</perGil>
            <ecoIid>String</ecoIid>
            <defCamposUsuario>
              <campo>String</campo>
              <valor>String</valor>
            </defCamposUsuario>
          </definicoesFornecedor>
          <codCli>Integer</codCli>
          <marFor>String</marFor>
          <codRam>String</codRam>
          <codGre>Integer</codGre>
          <forRep>Integer</forRep>
          <forTra>Integer</forTra>
          <notSis>Integer</notSis>
          <notFor>Integer</notFor>
          <codTri>String</codTri>
          <cliFor>String</cliFor>
          <codRoe>String</codRoe>
          <seqRoe>Integer</seqRoe>
          <codSro>String</codSro>
          <eenFor>String</eenFor>
          <forWms>String</forWms>
          <emaNfe>String</emaNfe>
          <codMot>Integer</codMot>
          <obsMot>String</obsMot>
          <temOrm>String</temOrm>
          <notAfo>Integer</notAfo>
          <insAnp>Integer</insAnp>
          <indCoo>String</indCoo>
          <codRtr>Integer</codRtr>
          <regEst>Integer</regEst>
          <tipPgt>String</tipPgt>
          <perIcm>Integer</perIcm>
          <numIdf>String</numIdf>
          <tipEmc>String</tipEmc>
          <entPaa>String</entPaa>
          <orgEmi>String</orgEmi>
          <datExd>DateTime</datExd>
          <datNas>DateTime</datNas>
          <numCbo>Integer</numCbo>
          <dESCBO>String</dESCBO>
          <catFor>Integer</catFor>
          <tipAce>Integer</tipAce>
          <numNis>String</numNis>
          <ideExt>String</ideExt>
          <forApo>String</forApo>
          <cpfMei>Double</cpfMei>
          <indFtr>Integer</indFtr>
          <codCae>Double</codCae>
          <cadastroCEP>
            <cepIni>String</cepIni>
            <cepFim>String</cepFim>
            <codRai>Integer</codRai>
            <nomCid>String</nomCid>
            <baiCid>String</baiCid>
            <endCid>String</endCid>
            <cepPol>String</cepPol>
          </cadastroCEP>
          <indFti>Integer</indFti>
          <isiFor>Integer</isiFor>
          <renAse>String</renAse>
          <cadastroPIX>
            <codEmp>Integer</codEmp>
            <codFil>Integer</codFil>
            <seqChv>String</seqChv>
            <tpcPix>Integer</tpcPix>
            <chvPix>String</chvPix>
            <chvPdr>String</chvPdr>
          </cadastroPIX>
          <parametrosDinamicos>
            <chave>String</chave>
            <valor>String</valor>
          </parametrosDinamicos>
          <datICP>DateTime</datICP>
          <datFCP>DateTime</datFCP>
          <dadosGeraisCamposUsuario>
            <campo>String</campo>
            <valor>String</valor>
          </dadosGeraisCamposUsuario>
          <codHas>String</codHas>
          <catEst>String</catEst>
          <finCib>String</finCib>
          <calCib>String</calCib>
        </dadosGeraisFornecedor>
        <sistemaIntegracao>String</sistemaIntegracao>
        <dataBuild>String</dataBuild>
      </parameters>
    </ser:GravarFornecedores>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:

Observação

A busca de um fornecedor na requisição é feita conforme a sequência abaixo:

  • Código do fornecedor (CodFor)
  • CNPJ/CPF do fornecedor (CgcCpf)
  • Identificação do fornecedor (IdeFor)
  • Número de identificação fiscal do fornecedor (NumIdf)

Nome Preenchimento Tipo Ajuda
dadosGeraisFornecedor Opcional Set Fornecedor
dadosGeraisFornecedor.codFor Obrigatório Integer Number(009) - Código do Fornecedor
dadosGeraisFornecedor.nomFor Obrigatório String String(100) - Nome do fornecedor
dadosGeraisFornecedor.apeFor Obrigatório String String(050) - Nome fantasia do fornecedor
dadosGeraisFornecedor.tipFor Obrigatório String String(001) - Tipo de Fornecedor - [ J=Pessoa Jurídica;F=Pessoa Física ]
dadosGeraisFornecedor.tipEmp Opcional Integer Number(002) - Tipo de empresa - [ 1=Indústria;2=Comércio;3=Distribuidor;4=TRR - Transp./Rev./Retalhista;5=Extração Mineral/Outros;6=Indústria/Transporte;7=Produtor Rural;8=Prestador de Serviço;9=Atividade Financeira;10=Atividade Imobiliária;11=Cooperativa;12=Sociedades Seguradoras, de Capitalização ou Entidade Aberta de Previdência Complementar;13=Distribuidor de Energia Elétrica;14=Prestador de Serviço de Comunicação;99=Outros ]
dadosGeraisFornecedor.tipMer Obrigatório String String(001) - Tipo de Mercado do fornecedor - [ I=Interno (Nacional);E=Externo (Exterior);P=Prospect. ]
dadosGeraisFornecedor.insEst Opcional String String(025) - Inscrição estadual do fornecedor
dadosGeraisFornecedor.insMun Opcional String String(016) - Inscrição municipal do fornecedor
dadosGeraisFornecedor.cgcCpf Opcional String Number(014) - Número do CNPJ ou CPF do fornecedor
dadosGeraisFornecedor.codSuf Opcional String String(010) - Código na Suframa
dadosGeraisFornecedor.endFor Opcional String String(100) - Endereço do fornecedor
dadosGeraisFornecedor.cplEnd Opcional String String(200) - Complemento do endereço do fornecedor (sala, andar, etc.)
dadosGeraisFornecedor.baiFor Opcional String String(075) - Bairro do fornecedor
dadosGeraisFornecedor.zipCod Opcional String String(014) - Código da cidade do fornecedor externo - ZIP CODE
dadosGeraisFornecedor.cepFor Opcional Integer Number(008) - CEP do fornecedor
dadosGeraisFornecedor.cepIni Opcional Integer Number(008) - Faixa inicial do CEP da cidade do fornecedor
dadosGeraisFornecedor.cidFor Opcional String String(060) - Cidade do fornecedor
dadosGeraisFornecedor.sigUfs Opcional String String(002) - Estado do fornecedor
dadosGeraisFornecedor.fonFor Opcional String String(020) - Número do telefone - 1
dadosGeraisFornecedor.fonFo2 Opcional String String(020) - Número do telefone - 2
dadosGeraisFornecedor.fonFo3 Opcional String String(020) - Número do telefone - 3
dadosGeraisFornecedor.faxFor Opcional String String(020) - Número do FAX do fornecedor
dadosGeraisFornecedor.cxaPst Opcional Integer Number(006) - Número da caixa postal do fornecedor
dadosGeraisFornecedor.intNet Opcional String String(100) - Endereço eletrônico (E-Mail)
dadosGeraisFornecedor.nomVen Opcional String String(030) - Nome do vendedor ou representante autorizado do fornecedor
dadosGeraisFornecedor.fonVen Opcional String String(020) - Número do telefone do vendedor ou representante do fornecedor
dadosGeraisFornecedor.rmlVen Opcional Integer Number(004) - Número do ramal do vendedor ou representante do fornecedor
dadosGeraisFornecedor.faxVen Opcional String String(020) - Número do FAX do vendedor ou representante do fornecedor
dadosGeraisFornecedor.codIac Opcional Integer Number(004) - Código IATA da cia. aérea
dadosGeraisFornecedor.abrIac Opcional String String(004) - Abreviação IATA da cia. aérea
dadosGeraisFornecedor.indBsp Opcional String String(001) - Indicativo se a cia. aérea pertence ao BSP - [ S=Sim;N=Não ]
dadosGeraisFornecedor.sitFor Obrigatório String String(001) - Situação do fornecedor - [ A=Ativo;I=Inativo ]
dadosGeraisFornecedor.codPai Opcional String String(004) - Código do país do fornecedor
dadosGeraisFornecedor.gerDir Opcional String String(001) - Indicativo se devem ser exportados os dados do fornecedor para DIRF/Reinf - [ S=Sim;N=Não ]
dadosGeraisFornecedor.ideFor Opcional String String(020) - Código para identificação do fornecedor
dadosGeraisFornecedor.qtdDep Opcional Integer Number(004) - Quantidade de dependentes do Fornecedor
dadosGeraisFornecedor.recPis Opcional String String(001) - Indicativo se as notas fiscais do fornecedor poderão ter recuperação de PIS - [ S=Sim;N=Não ]
dadosGeraisFornecedor.perPid Opcional String Number(008,4) - Percentual de recuperação de PIS diferenciado para o fornecedor
dadosGeraisFornecedor.triIss Opcional String String(001) - Indicativo se o fornecedor tributa ISS - [ S=Sim;N=Não ]
dadosGeraisFornecedor.recCof Opcional String String(001) - Indicativo se as notas fiscais poderão ter recuperação de Cofins - [ S=Sim;N=Não ]
dadosGeraisFornecedor.perCod Opcional String Number(008,4) - Percentual de recuperação de Cofins diferenciado
dadosGeraisFornecedor.retCof Opcional String String(001) - Indicativo se as notas fiscais poderão ter retenção de Cofins - [ S=Sim;N=Não ]
dadosGeraisFornecedor.retCsl Opcional String String(001) - Indicativo se as notas fiscais poderão ter retenção de CSLL - [ S=Sim;N=Não ]
dadosGeraisFornecedor.retPis Opcional String String(001) - Indicativo se as notas fiscais poderão ter retenção de PIS - [ S=Sim;N=Não ]
dadosGeraisFornecedor.retOur Opcional String String(001) - Indicativo se as notas fiscais poderão ter Outras Retenções - [ S=Sim;N=Não ]
dadosGeraisFornecedor.recIpi Opcional String String(001) - Indicativo se as notas fiscais poderão ter recuperação de IPI - [ S=Sim;N=Não ]
dadosGeraisFornecedor.recIcm Opcional String String(001) - Indicativo se as notas fiscais poderão ter recuperação de ICMS - [ S=Sim;N=Não ]
dadosGeraisFornecedor.triIcm Opcional String String(001) - Indicativo se o fornecedor tem tributação de ICMS ou não - [ S=Sim;N=Não ]
dadosGeraisFornecedor.triIpi Opcional String String(001) - Indicativo se o fornecedor tem tributação de IPI ou não - [ S=Sim;N=Não ]
dadosGeraisFornecedor.retPro Opcional String String(001) - Indicativo se o fornecedor controla retenções de PIS, Cofins, CSLL, IRRF, e Outras Retenções por produto - [ S=Sim;N=Não ]
dadosGeraisFornecedor.retIrf Opcional String String(001) - Indicativo se as notas fiscais poderão ter retenção de IRRF - [ S=Sim;N=Nenhum;I=Isenta;M=Imune ]
dadosGeraisFornecedor.indFor Opcional String String(001) - Indicativo do tipo do fornecedor - [ M=Matéria Prima;P=Prestador de Serviços;A=Ambos ]
dadosGeraisFornecedor.limRet Opcional String String(001) - Indicativo de como é utilizado o valor limite para cálculos de retenção para o fornecedor nas notas fiscais de entrada - [ P=Produto;E=Serviço;S=Ambos;N=Não Utiliza ]
dadosGeraisFornecedor.numRge Opcional String String(013) - Número do documento de identidade (RG) do fornecedor
dadosGeraisFornecedor.perRir Opcional String Number(005,2) - Percentual de redução do valor base IRRF na baixa dos títulos
dadosGeraisFornecedor.perRin Opcional String Number(005,2) - Percentual de redução do valor base INSS na baixa dos títulos
dadosGeraisFornecedor.nenFor Opcional String String(060) - Número do endereço do fornecedor
definicoesFornecedor Opcional Set Fornecedor - Histórico
definicoesFornecedor.codEmp Obrigatório Integer Number(004) - Código da empresa
definicoesFornecedor.codFil Obrigatório Integer Number(005) - Código da filial
definicoesFornecedor.codTpr Opcional String String(004) - Código da tabela de preço padrão
definicoesFornecedor.codCpg Opcional String String(006) - Código da condição de pagamento padrão
definicoesFornecedor.codFpg Opcional Integer Number(002) - Código da forma de pagamento
definicoesFornecedor.codTra Opcional Integer Number(009) - Código da transportadora padrão
definicoesFornecedor.codPor Opcional String String(004) - Código do portador padrão
definicoesFornecedor.codCrt Opcional String String(002) - Código da carteira padrão
definicoesFornecedor.pagJmm Opcional String Number(005,2) - Percentual de juros de mora mês para o contas a pagar
definicoesFornecedor.pagDtj Opcional Integer Number(004) - Dias de tolerância para cálculo de juros de mora do contas a pagar
definicoesFornecedor.pagMul Opcional String Number(005,2) - Percentual de multa para atraso do contas a pagar
definicoesFornecedor.pagDtm Opcional Integer Number(004) - Dias de tolerância para multa do conta a pagar
definicoesFornecedor.perDsc Opcional String Number(004,2) - Percentual padrão de desconto para os títulos gerados no financeiro
definicoesFornecedor.tolDsc Opcional Integer Number(004) - Quantidade padrão de dias de tolerância para desconto
definicoesFornecedor.antDsc Opcional String String(001) - Indicativo se calcula desconto por antecipação de pagamento - [ S=Sim;N=Não ]
definicoesFornecedor.ecoIid Opcional String String(001) - Emitir Contra Nota em Operação com ICMS Integral Diferido - [ S=Sim;N=Não ]
definicoesFornecedor.perDs1 Opcional String Number(005,2) - Percentual de desconto - 1 para fornecedor
definicoesFornecedor.perDs2 Opcional String Number(005,2) - Percentual de desconto - 2 para fornecedor
definicoesFornecedor.perDs3 Opcional String Number(005,2) - Percentual de desconto 3 para fornecedor
definicoesFornecedor.perDs4 Opcional String Number(005,2) - Percentual de desconto 4 para fornecedor
definicoesFornecedor.perDs5 Opcional String Number(005,2) - Percentual de desconto 5 para fornecedor
definicoesFornecedor.perFun Opcional String Number(004,2) - Percentual do Funrural ou INSS do Produto para Notas Fiscas de Entrada
definicoesFornecedor.perIns Opcional String Number(004,2) - Percentual do INSS para o Serviço
definicoesFornecedor.indInd Obrigatório String String(001) - Indicativo se o fornecedor é indústria ou equiparado a industrial para IPI presumido - [ S=Sim;N=Não ]
definicoesFornecedor.perFre Opcional String Number(005,2) - Percentual de Frete
definicoesFornecedor.perSeg Opcional String Number(005,2) - Percentual de Seguro
definicoesFornecedor.perEmb Opcional String Number(005,2) - Percentual de Embalagens
definicoesFornecedor.perEnc Opcional String Number(005,2) - Percentual de Encargos
definicoesFornecedor.perOut Opcional String Number(005,2) - Percentual de Outras Despesas
definicoesFornecedor.perIss Opcional String Number(006,4) - Percentual do ISS para os serviços do fornecedor
definicoesFornecedor.perIrf Opcional String Number(004,2) - Percentual do IRRF para os serviços do fornecedor
definicoesFornecedor.cifFob Opcional String String(001) - Indicativo se o frete para o fornecedor é CIF ou FOB - [ C=Por conta do emitente (PAGO);F=Por conta do destinatário (A PAGAR);T=Por conta de terceiros;X=Sem frete ]
definicoesFornecedor.perIne Opcional String Number(004,2) - Percentual do INSS da parte da empresa
definicoesFornecedor.ctaRed Opcional Integer Number(007) - Conta contábil reduzida - 1
definicoesFornecedor.ctaAux Opcional Integer Number(009) - Número reduzido da conta de composição auxiliar - 1
definicoesFornecedor.ctaAad Opcional Integer Number(009) - Número reduzido da conta de composição auxiliar - 2
definicoesFornecedor.przEnt Opcional Integer Number(003) - Quantidade de dias de prazo de entrega do fornecedor
definicoesFornecedor.qtdDcv Opcional Integer Number(003) - Quantidade de dias para cálculo de vencimento
definicoesFornecedor.criEdv Opcional String String(001) - Critério para escolha do dia de vencimento - [ A=Dias Corridos - Antecipa;S=Dias Corridos - Mantém;N=Dias Corridos - Posterga;U=Só Dias Úteis ]
definicoesFornecedor.codBan Opcional String String(003) - Código do banco da conta corrente do fornecedor
definicoesFornecedor.tipTcc Opcional Integer Number(002) - Tipo de conta - [ 01=Conta Corrente;02=Conta Poupança;03=Conta Investimento;04=Conta Aplicação Financeira;05=Conta Empréstimo;06=Cota Capital;07=Conta de Retenção;08=Conta da Loja;09=Conta Salário;10=Outros ]
definicoesFornecedor.codAge Opcional String String(007) - Código da agência do banco da conta corrente do fornecedor
definicoesFornecedor.ccbFor Opcional String String(014) - Número da conta corrente do fornecedor no banco
definicoesFornecedor.codCrp Opcional String String(003) - Código do grupo de contas a pagar
definicoesFornecedor.pagTir Opcional String String(001) - Tipo de juros para o contas a pagar - [ S=Juros Simples;C=Juros Compostos ]
definicoesFornecedor.ctaRcr Opcional Integer Number(007) - Conta contábil reduzida - 2
definicoesFornecedor.ctaFdv Opcional Integer Number(007) - Conta contábil reduzida - 3
definicoesFornecedor.ctaFcr Opcional Integer Number(007) - Conta contábil reduzida - 4
definicoesFornecedor.seqOrm Opcional Integer Number(005) - Sequência do endereço de origem da mercadoria
definicoesFornecedor.codFav Opcional Double Number(014) - Número do CNPJ ou CPF do favorecido
definicoesFornecedor.rvlCfr Opcional String String(001) - Tipo de rateio do valor do conhecimento de frete para efetuar movimento de estoque(acerto) - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlFre Opcional String String(001) - Tipo de rateio do valor de frete para os itens de produto. - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlSeg Opcional String String(001) - Tipo de rateio do valor de seguro para os itens de produto. - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlEmb Opcional String String(001) - Tipo de rateio do valor de embalagens para os itens de produto. - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlEnc Opcional String String(001) - Tipo de rateio do valor de encargos para os itens de produto e serviço. - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlOut Opcional String String(001) - Tipo de rateio do valor de outros para os itens de produto e serviço. - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlDar Opcional String String(001) - Tipo de rateio do valor de arredondamento para os itens de produto e serviço. - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlFei Opcional String String(001) - Tipo de rateio do valor de frete de importação para os itens de produtos - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlSei Opcional String String(001) - Tipo de rateio do valor de seguro de importação para os itens de produtos - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.rvlOui Opcional String String(001) - Tipo de rateio do valor de outras despesas de importação para os itens de produto e serviço - [ V=Valor Líquido;B=Valor Bruto;P=Peso;Q=Quantidade ]
definicoesFornecedor.codDep Opcional String String(010) - Código do depósito padrão para armazenagem no sistema de WMS
definicoesFornecedor.forMon Opcional String String(001) - Indicativo para informar ao sistema se fornecedor realiza montagem de produtos - [ S=Sim;N=Não ]
definicoesFornecedor.pgtMon Opcional String String(002) - Tipo de pagamento a ser feito para os montadores - [ OC=Ordem de Compra de Serviço;CP=Título a Pagar ]
definicoesFornecedor.pgtFre Opcional String String(002) - Tipo de pagamento a ser feito para os motoristas - [ OC=Ordem de Compra de Serviço;CP=Título a Pagar ]
definicoesFornecedor.tnsPro Opcional String String(005) - Transação de sugestão da nota fiscal de entrada para produtos
definicoesFornecedor.tnsSer Opcional String String(005) - Transação de sugestão da nota fiscal de entrada para serviços
definicoesFornecedor.codEdc Opcional String String(003) - Espécie de documento para fins fiscais
definicoesFornecedor.cqdCvn Opcional String String(001) - Considerar quantidades devolvidas no cálculo de valorização nas NFE do tipo 8 - [ S=Sim;N=Não ]
definicoesFornecedor.perSen Opcional String Number(004,2) - Percentual do imposto SENAR/SENAT para notas fiscais de entrada
definicoesFornecedor.perGil Opcional String Number(004,2) - Percentual de GILRAT - Grau Incid. Incapac. Laborat. Decor. Riscos Amb. de Trab.
defCamposUsuario Opcional Set  
defCamposUsuario.campo Opcional String Nome do campo de usuário oriundo de uma personalização presente na tabela de cadastro de fornecedores no ERP. Exemplo: USU_CampoCustom.
defCamposUsuario.valor Opcional String Valor a ser inserido para o campo de usuário
dadosGeraisFornecedor.codCli Opcional Integer Number(009) - Código do fornecedor como cliente
dadosGeraisFornecedor.marFor Opcional String String(020) - Marca do fornecedor
dadosGeraisFornecedor.codRam Opcional String String(005) - Código do ramo de atividade
dadosGeraisFornecedor.codGre Opcional Integer Number(009) - Código do grupo de empresas
dadosGeraisFornecedor.forRep Opcional Integer Number(009) - Código do fornecedor como representante
dadosGeraisFornecedor.forTra Opcional Integer Number(009) - Código do fornecedor como transportadora
dadosGeraisFornecedor.notSis Opcional Integer Number(005,2) - Nota para o sistema da qualidade do Fornecedor
dadosGeraisFornecedor.notFor Opcional Integer Number(005,2) - Nota dos fornecimentos deste fornecedor
dadosGeraisFornecedor.codTri Opcional String String(005) - Código de tributação para emissão de DARF/DIRF
dadosGeraisFornecedor.cliFor Opcional String String(001) - Indicativo se o registro representa um cliente ou um fornecedor ou ambos - [ C=Cliente;F=Fornecedor;A=Cliente/Fornecedor ]
dadosGeraisFornecedor.codRoe Opcional String String(003) - Código da Rota ou Localidade do Fornecedor
dadosGeraisFornecedor.seqRoe Opcional Integer Number(004) - Sequência da rota ou localidade
dadosGeraisFornecedor.codSro Opcional String String(003) - Código da Sub Rota
dadosGeraisFornecedor.eenFor Opcional String String(018) - Código do endereço do fornecedor
dadosGeraisFornecedor.forWms Opcional String String(015) - Código do fornecedor no sistema de WMS
dadosGeraisFornecedor.emaNfe Opcional String String(100) - Endereço eletrônico (E-Mail) para envio de arquivos de documentos eletrônicos
dadosGeraisFornecedor.codMot Opcional Integer Number(006) - Código do motivo da situação do fornecedor
dadosGeraisFornecedor.obsMot Opcional String String(250) - Observação do motivo da situação do fornecedor
dadosGeraisFornecedor.temOrm Opcional String String(001) - Indicativo se o fornecedor tem endereços de origem da mercadoria - [ S=Sim;N=Não ]
dadosGeraisFornecedor.notAfo Opcional Integer Number(005,2) - Nota da Avaliação do fornecedor
dadosGeraisFornecedor.insAnp Opcional Integer Number(007) - Código da instalação conforme cadastro da ANP
dadosGeraisFornecedor.indCoo Opcional String String(001) - Indicativo se cliente/fornecedor é cooperado. - [ S=Sim;N=Não ]
dadosGeraisFornecedor.codRtr Opcional Integer Number(001) - Código do Regime Tributário - [ 0=Todos;1=Simples Nacional;2=Simples Nacional - excesso de sublimite de receita bruta;3=Regime Normal;4=Simples Nacional - Microempreendedor Individual - MEI ]
dadosGeraisFornecedor.regEst Opcional Integer Number(002) - Regime Especial de Tributação (Meramente Informativo para NF-e) - [ 1=Microempresa municipal;2=Estimativa;3=Sociedade de profissionais;4=Cooperativa;5=Microempresário Individual (MEI);6=Microempresário e Empresa de Pequeno Porte (ME EPP);7=Tributação por Faturamento (Variável);8=Fixo;9=Isenção;10=Imune;11=Exigibilidade suspensa por decisão judicial;12=Exigibilidade suspensa por procedimento administrativo ]
dadosGeraisFornecedor.tipPgt Opcional String String(002) - Tipo de pagamento do título - [ CA=Cheque administrativo;CC=Crédito em Conta Corrente;CH=Cheque;CP=Crédito em Conta Poupança;CS=Crédito em Conta Salário;DB=Débito em Conta Corrente;DC=Documento de Crédito - Mesmo Titular;DF=DARF;DS=DARF Simples;DJ=DARJ;DO=Documento de Crédito - Outro Titular;DP=Débito em Conta Poupança;DV=DPVAT;EC=Extrato de Conta Corrente;FG=FGTS;GS=GARE-SP (ICMS/DR/ITCMD);IP=IPVA;LC=LICENCIAMENTO;OP=Ordem de Pagamento;PA=Pagamento com Autenticação;PC=Pagamento p/ Cartão;PO=Pagamento Concessionária;PS=Guia da Previdência Social;PT=Pagamento Tributos;TE=TED - Mesmo Titular;TN=Títulos não registrados;TO=TED - Outro Titular;TR=Títulos registrados;OU=Outros Pagamentos;PX=PIX Transferência;PQ=PIX QR Code ]
dadosGeraisFornecedor.perIcm Opcional Integer Number(007,4) - Percentual do ICMS nas NFE dos forn. com regime tributário simples nacional
dadosGeraisFornecedor.numIdf Opcional String String(040) - Número de identificação fiscal
dadosGeraisFornecedor.tipEmc Opcional String Number(001) - Tipo do direito de propriedade da empresa - [ 1=Privada;2=Pública ]
dadosGeraisFornecedor.entPaa Opcional String String(001) - Entidade inscrita no Programa de Aquisição de Alimentos (PAA) - [ S=Sim;N=Não ]
dadosGeraisFornecedor.orgEmi Opcional String String(020) - Órgão Emissor do RG
dadosGeraisFornecedor.datExd Opcional DateTime Date(DD/MM/YYYY) - Data de Expedição do RG
dadosGeraisFornecedor.datNas Opcional DateTime Date(DD/MM/YYYY) - Data de Nascimento do Fornecedor
dadosGeraisFornecedor.numCbo Opcional Integer Number(006) - Número da classificação brasileira de ocupações
dadosGeraisFornecedor.dESCBO Opcional String  
dadosGeraisFornecedor.catFor Opcional Integer Number(003) - Categoria Recibo de Pagamento Autônomo - [ 701=Contrib. Indiv. - Autônomo em geral, exceto demais categorias.;711=Contrib. Indiv. - Transportador autônomo.;721=Contrib. Indiv. - Diretor não empregado, com FGTS.;722=Contrib. Indiv. - Diretor não empregado, sem FGTS.;723=Contrib. Indiv. - Empresários, sócios e membro conselho Adm. ou fiscal.;731=Contrib. Indiv. - Cooperado que presta serviço intermédio Cooperativa.;734=Contrib. Indiv. - Transp. Coop. presta serviços intermédio cooperativa.;738=Contrib. Indiv. - Cooperado filiado a Cooperativa de Produção.;741=Contrib. Indiv. - Micro Empreendedor Individual, contratado por PJ.;751=Contrib. Indiv. - Aposent., nomeado magistr. class. temp. J. Trabalho/Eleitoral.;761=Contrib. Indiv. - Associado eleito p/direção cooper.,assoc. ou entid. renum.;771=Contrib. Indiv. - Membro de cons. tutelar, conforme Lei nº 8.069, de 13/07/1990.;781=Ministro de confissão religiosa ou membro de vida consagrada. ]
dadosGeraisFornecedor.tipAce Opcional Integer Number(001) - Tipo de acerto (arredondamento) para impostos previdenciários (NFS-e) - [ 1=Arredonda;2=Trunca ]
dadosGeraisFornecedor.numNis Opcional String String(011) - Número de Inscrição do Segurado - NIS, NIT e PIS/PASEP
dadosGeraisFornecedor.ideExt Opcional String String(030) - Código de identificação do fornecedor no sistema externo. Este código é util quando este serviço é utilizado para incluir vários fornecedores numa única requisição. O código fornecido neste elemento é devolvido na mensagem de retorno. Com isso, é possível relacionar os dados enviados na requisição com a mensagem de retorno.
dadosGeraisFornecedor.forApo Opcional String String(001) - Indicativo se o fornecedor é aposentado - [ S=Sim;N=Não ]
dadosGeraisFornecedor.cpfMei Opcional Double Number(011) - CPF do Micro Empreendedor Individual
dadosGeraisFornecedor.indFtr Opcional Integer Number(001) - Indicativo da forma de tributação da contribuição previdenciária - [ 1=Sobre a comercialização da sua produção;2=Sobre a folha de pagamento ]
dadosGeraisFornecedor.codCae Opcional Double Number(015) - Código do Cadastro de Atividade Econômica da Pessoa Física
cadastroCEP Opcional Set Fornecedor - CEP
cadastroCEP.cepIni Opcional String Number(008) - Faixa inicial do Cep da cidade
cadastroCEP.cepFim Opcional String Number(008) - Faixa final do Cep da cidade
cadastroCEP.codRai Opcional Integer Number(007) - Código da cidade para a RAIS
cadastroCEP.nomCid Opcional String String(060) - Nome da cidade
cadastroCEP.baiCid Opcional String String(075) - Bairro referente ao cep informado
cadastroCEP.endCid Opcional String String(100) - Endereço referente ao cep informado
cadastroCEP.cepPol Opcional String Number(008) - CEP da cidade Polo
dadosGeraisFornecedor.indFti Opcional Integer Number(002) - Forma de Tributação Sobre os Rendimentos - [ 10=Retenção do IRRF - alíquota padrão;11=Retenção do IRRF - alíquota da tabela progressiva;12=Retenção do IRRF - alíquota diferenciada (países tributação favorecida);13=Retenção do IRRF - alíquota limitada conforme cláusula em convênio;30=Retenção do IRRF - outras hipóteses;40=Não retenção do IRRF - isenção estabelecida em convênio;41=Não retenção do IRRF - isenção prevista em lei interna;42=Não retenção do IRRF - alíquota Zero prevista em lei interna;43=Não retenção do IRRF - pagamento antecipado do imposto;44=Não retenção do IRRF - medida Judicial;50=Não retenção do IRRF - outras hipóteses ]
dadosGeraisFornecedor.isiFor Opcional Integer Number(002) - Informações sobre isenção e imunidade - [ 01=Não isenta/não imune;02=Instituição de educação e de assistência social sem fins lucrativos, a que se refere o art. 12 da Lei nº 9.532, de 10 de dezembro de 1997;03=Instituição de Carácter filantrópico, recreativo, cultural, científico e às associações civis, a que se refere o art. 15 da Lei nº 9.532, de 1997 ]
dadosGeraisFornecedor.renAse Opcional String String(030) - Inscrição RENASEM do Fornecedor
cadastroPIX Opcional Set Fornecedor - Chaves PIX
cadastroPIX.codEmp Opcional Integer Number(004) - Código da empresa
cadastroPIX.codFil Opcional Integer Number(005) - Código da filial
cadastroPIX.seqChv Obrigatório String Number(003) - Sequência de chave PIX
cadastroPIX.tpcPix Obrigatório Integer Number(001) - Tipo de Chave PIX. 1 - Telefone, 2 - E-mail, 3 - CPF/CNPJ e 4 - Chave Aleatória.
cadastroPIX.chvPix Obrigatório String String(100) - Chave PIX - Pagamento Instantâneo
cadastroPIX.chvPdr Obrigatório String String(001) - Chave Padrão. S - Sim, N - Não.
parametrosDinamicos Opcional Set  
parametrosDinamicos.chave Opcional String  
parametrosDinamicos.valor Opcional String  
dadosGeraisFornecedor.datICP Opcional DateTime Date(DD/MM/YYYY) - Data de Início de Vigência de Contribuição Previdenciária
dadosGeraisFornecedor.datFCP Opcional DateTime Date(DD/MM/YYYY) - Data Final de Vigência de Contribuição Previdenciária
dadosGeraisCamposUsuario Opcional Set  
dadosGeraisCamposUsuario.campo Opcional String  
dadosGeraisCamposUsuario.valor Opcional String  
dadosGeraisFornecedor.codHas Opcional String (Opcional) - String(50) - Código da hash da requisição
dadosGeraisFornecedor.catEst Opcional String

String(003) - Categoria do estabelecimento

  • ARM=Armazenador;
  • CFC=Consumidor Final Contribuinte;
  • CNF=Consumidor Final Não Contribuinte;
  • CPQ=Central Petroquímica;
  • DIS=Distribuidor;
  • ECE=Empresa Comercializadora de Etanol;
  • FOR=Formulador;
  • IMP=Importador;
  • PRV=Posto Varejista;
  • REF=Refinaria;
  • TRR=Transportador e Revendedor Retalhista;
  • USI=Usina;
  • VGL=Varejista de GLP
dadosGeraisFornecedor.calCib Opcional String String(001) - Indicativo se o fornecedor calcula CBS/IBS - [ S=Sim;N=Não ]
sistemaIntegracao Opcional String (Opcional) - String(15) - Sigla do Sistema de Integração
dataBuild Opcional String  
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:GravarFornecedoresResponse>
      <result>
        <tipoRetorno>Integer</tipoRetorno>
        <retornosFornecedores>
          <codFor>String</codFor>
          <cgcCpf>String</cgcCpf>
          <codCli>String</codCli>
          <retorno>String</retorno>
          <ideExt>String</ideExt>
        </retornosFornecedores>
        <mensagemRetorno>String</mensagemRetorno>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:GravarFornecedoresResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos da resposta:
Nome Preenchimento Tipo Ajuda
tipoRetorno Opcional Integer (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação
retornosFornecedores Opcional Set  
retornosFornecedores.codFor Opcional String (Obrigatório) - Number(009) - Código do fornecedor
retornosFornecedores.cgcCpf Opcional String Number(014) - Número do CNPJ ou CPF do fornecedor.
retornosFornecedores.codCli Opcional String Number(009) - Código do cliente. Restrição: somente será retornado se estiver configurado como cliente igual a fornecedor
retornosFornecedores.retorno Opcional String String(100) - Retorno do processamento
retornosFornecedores.ideExt Opcional String String(030) - Retorna o código do fornecedor no sistema externo enviado na requisição
mensagemRetorno Opcional String (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento
erroExecucao Opcional 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"
ClosedGravarDependentes

Serviço para Inclusão/Alteração/Exclusão de dependentes dos fornecedores.

Necessita autenticação: sim.

Situação de versão: atual.

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:GravarDependentes>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <dependentes>
          <codFor>Integer</codFor>
          <cNPJCPFFornecedor>Double</cNPJCPFFornecedor>
          <codDpd>Integer</codDpd>
          <cpfDep>String</cpfDep>
          <nomDep>String</nomDep>
          <codIde>String</codIde>
          <datNas>DateTime</datNas>
          <estCiv>Integer</estCiv>
          <graPar>Integer</graPar>
          <desPar>String</desPar>
          <vlrPen>Double</vlrPen>
          <datIni>DateTime</datIni>
          <datFin>DateTime</datFin>
        </dependentes>
        <tipoProcessamento>Integer</tipoProcessamento>
      </parameters>
    </ser:GravarDependentes>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:

 

Nome Preenchimento Tipo Ajuda
dependentes Opcional Set Fornecedores - Dependentes
dependentes.codFor Opcional Integer Number(009) - Código do Fornecedor
dependentes.cNPJCPFFornecedor Opcional Double (Opcional) - Number(14) - Número do documento do fornecedor
dependentes.codDpd Opcional Integer Number(009) - Código do dependente
dependentes.cpfDep Opcional String Number(011) - Número do CPF do dependente
dependentes.nomDep Opcional String String(100) - Nome do dependente
dependentes.codIde Opcional String String(010) - Documento de identidade do dependente
dependentes.datNas Opcional DateTime Date(DD/MM/YYYY) - Data de nascimento do dependente
dependentes.estCiv Opcional Integer
ClosedNumber(001) - Estado civil do dependente
  • 1 = Solteiro;
  • 2 = Casado;
  • 3 = Desquitado;
  • 4 = Divorciado;
  • 5 = Viúvo;
  • 6 = Concubinado;
  • 7 = Separado Judicialmente;
  • 8 = Falecido;
  • 9 = Outros.
dependentes.graPar Opcional Integer
ClosedNumber(001) - Grau de parentesco do dependente
  • 1 = Pai;
  • 2 = Mãe;
  • 3 = Filho;
  • 4 = Filha;
  • 5 = Marido;
  • 6 = Esposa;
  • 7 = Irmão;
  • 8 = Irmã;
  • 9 = Outros;
  • 10 = Neto;
  • 11 = Bisneto;
  • 12 = Avós;
  • 13 = Bisavós;
  • 14 = Enteado;
  • 15 = Sogro;
  • 16 = Companheiro(a) com o(a) qual tenha filho ou viva há mais de 5 (cinco) anos ou possua declaração de união estável;
  • 17 = Menor pobre do qual detenha a guarda judicial;
  • 18 = A pessoa absolutamente incapaz, da qual seja tutor ou curador;
  • 19 = Ex-cônjugue.
dependentes.desPar Opcional String String(030) - Descrição do Parentesco
dependentes.vlrPen Opcional Double Number(015,2) - Valor da Pensão Judicial/Alimentícia
dependentes.datIni Opcional DateTime Date(DD/MM/YYYY) - Data da validade inicial
dependentes.datFin Opcional DateTime Date(DD/MM/YYYY) - Data da validade final
tipoProcessamento Opcional Integer Number(001) - Tipo de Processamento - Lista: 1 = Inclusão, 2 = Alteração, 3 = Cancelamento, 8 = Ignorar NumInt, 9 = Localizar pelo NumInt
ClosedResposta: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:GravarDependentesResponse>
      <result>
        <tipoRetorno>Integer</tipoRetorno>
        <retorno>
          <codFor>Integer</codFor>
          <cNPJFornecedor>String</cNPJFornecedor>
          <codDpd>Integer</codDpd>
          <cpfDep>String</cpfDep>
          <msgRet>String</msgRet>
        </retorno>
        <mensagemRetorno>String</mensagemRetorno>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:GravarDependentesResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedAtributos da Resposta:
Nome Preenchimento Tipo Ajuda
tipoRetorno Opcional Integer (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, 1 = Erro na Solicitação
retorno Opcional Set Retorno do processamento.
retorno.codFor Opcional Integer Number(9) - Código do Fornecedor
retorno.cNPJFornecedor Opcional String String(014) - CPF/CNPJ do Fornecedor
retorno.codDpd Opcional Integer Number(9) - Código do dependente
retorno.cpfDep Opcional String String(011) - CPF do Dependente
retorno.msgRet Opcional String  
mensagemRetorno Opcional String (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento
erroExecucao Opcional 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"
ClosedGravarReciboTerceiros
GravarReciboTerceiros

Nesta porta é possível gravar recibos de terceiros para o cálculo do INSS no RPA.

Necessita autenticação: sim.

Situação da versão: atual.

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:GravarReciboTerceiros>
      <user>String</user>
      <password>String</password>
      <encryption>Integer</encryption>
      <parameters>
        <recibo>
          <codFor>Integer</codFor>
          <cNPJFornecedor>DateTime</cNPJFornecedor>
          <numRpa>Integer</numRpa>
          <mesAno>DateTime</mesAno>
          <tipDoc>Integer</tipDoc>
          <cgcCpf>String</cgcCpf>
          <vlrRem>Double</vlrRem>
          <vlrBin>Double</vlrBin>
          <vlrIns>Double</vlrIns>
        </recibo>
        <tipoProcessamento>Integer</tipoProcessamento>
      </parameters>
    </ser:GravarReciboTerceiros>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da requisição:
NomeTipoPreenchimentoAjuda
reciboSet(Obrigatório)Relação de recibos de terceiros a serem processados.
recibo.codForInteger(Obrigatório)Number(9) - Código do Fornecedor
recibo.cNPJFornecedorString(Obrigatório)(Obrigatório quando não informado CodFor) - String(014) - CPF/CNPJ do Fornecedor
recibo.numRpaInteger(Obrigatório)Number(9) - Número do recibo
recibo.mesAnoDateTime(Obrigatório)Data(DD/MM/YYYY) - Data do recibo
recibo.tipDocInteger(Obrigatório)number(1) - Tipo do documento - Lista: 0 = CNPJ, 1 = CPF
recibo.cgcCpfString(Obrigatório)Number(9) - Número do documento do prestado do serviço
recibo.vlrRemDouble(Obrigatório) Numero(015) - Valor da Remuneração
recibo.vlrBinDouble(Obrigatório) Numero(015) - Valor base do INSS
recibo.vlrInsDouble(Obrigatório) Numero(015) - Valor do INSS
tipoProcessamentoIntegerOpcionalnumber(001) - Tipo de Processamento - Lista: 1 = Inclusão, 2 = Alteração, 3 = Cancelamento, 8 = Ignorar NumInt, 9 = Localizar pelo NumInt
ClosedResposta:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br">
  <soapenv:Body>
    <ser:GravarReciboTerceirosResponse>
      <result>
        <tipoRetorno>Integer</tipoRetorno>
        <retorno>
          <codFor>String</codFor>
          <cNPJFornecedor>String</cNPJFornecedor>
          <numRpa>String</numRpa>
          <msgRet>String</msgRet>
        </retorno>
        <mensagemRetorno>String</mensagemRetorno>
        <erroExecucao>String</erroExecucao>
      </result>
    </ser:GravarReciboTerceirosResponse>
  </soapenv:Body>
</soapenv:Envelope>
ClosedParâmetros da resposta:
NomeTipoPreenchimentoAjuda
tipoRetornoInteger(Obrigatório) Número(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação
mensagemRetornoString(Obrigatório) String(1000) - Mensagem de Retorno de Processamento
retornoSetOpcionalRetorno do processamento.
retorno.codForStringOpcionalNumber(9) - Código do Fornecedor
retorno.cNPJFornecedorStringOpcionalString(014) - CPF/CNPJ do Fornecedor
retorno.numRpaStringOpcionalNumber(9) - Número da nota fiscal de entrada
retorno.msgRetstring(Obrigatório) String(1000) - Mensagem de Retorno de Processamento

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Contrato de Licenciamento de Software e Prestação de Serviços

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