A função NFeConsultaCadastro é usada para fazer uma consulta ao cadastro de contribuintes do ICMS da unidade federada.
Esta consulta é equivalente à consulta do SINTEGRA.
Tipo de Retorno
Integer
Pacote
A função NFeConsultaCadastro está definida dentro do pacote NF-eConsultaCadastro.pkg.
Sintaxe
Move (NFeConsultaCadastro({sSiglaUF},{iTipoAmbiente}, ;
{iTipoDocumento},{sDocumento}, ;
{sCertificado},&{vtNFeRetConsultaCadastro}, ;
{sProxy},{sUsuario},{sSenha}, ;
{bExibeErro}[,{sVersao}])) to {iRetorno}
Onde:
- {sSiglaUF} é a sigla da UF para a qual será enviada a consulta. O serviço de consulta cadastro só está disponível para Unidades Federativas que possuem servidor próprio e algumas que utilizam o SVRS para esta funcionalidade.
- {iTipoAmbiente} ambiente de trabalho, podendo ser 1-Produção ou 2-Homologação;
-
{iTipoDocumento} é um código que identifica o tipo de documento que será enviado para a consulta, podendo ser 0-Inscrição Estadual, 1-CNPJ ou 2-CPF
-
{sDocumento} é o número do documento do tipo informado no parâmetro {iTipoDocumento} que será usado para a consulta;
-
{sCertificado} é a string que representa o certificado digital que será usado na transmissão dos dados. Se não for informado, uma tela será exibida para o usuário escolher um dos certificados instalados para o usuário corrente. Veja mais detalhes sobre como informar este parâmetro clicando
aqui;
-
&{vtNFeRetConsultaCadastro} é uma variável estrutura do tipo tNFeRetConsultaCadastro que precisa ser passada por referência e que após a execução da função receberá os dados do contribuinte consultado. No caso da consulta não ser bem sucedida a mensagem de erro será devolvida no campo sMsgResultado desta variável;
-
{sProxy} é usado para informar o endereço do servidor proxy, se necesário. Por exemplo http://proxyserver:port. Verificar com o cliente qual é o endereço do servidor proxy e a porta https, pois a porta padrão do https é 443 e, sendo assim, teríamos algo como http://192.168.15.1:443;
-
{sUsuario} é usado para informar o usuário para autenticação no proxy, se necessário;
-
{sSenha} é usado informar a senha de autenticação no proxy, se necessário;
-
{bExibeErro} é usado para indicar se a função deve exibir ou não os erros que ocorrerem na execução;
-
{sVersao} é um parâmetro opcional para informar a versão do XML de requisição que deverá ser usada. Se não for informado, será usado "3.10" (a partir da versão 2018/01, a versão padrão será "4.00", se o desenvolvedor não informar). Algumas SEFAZ ainda estão operando com a versão 2.00. Este parâmetro está disponível a partir da versão
2015/02.
- {iRet} é o código do retorno da chamada da função. 0 (zero) indica que a consulta foi bem sucedida. Qualquer código diferente de 0 (zero) indica que não foi possível fazer a consulta. Neste caso, será necessário analisar a mensagem devolvida no campo sMsgResutlado em {vtNFeRetConsultaCadastro}.
Exemplo
- Exemplos de utilização desta função podem ser encontrados na view Destinatario.vw e Transportadora.vw (a partir da versão 2015/02) da workspace de exemplo.
Observações
- Importante: a consulta retorna informações de empresas não habilitadas também. Se a empresa não está mais habilitada, os dados devolvidos podem estar desatualizados e não são confiáveis para, por exemplo, emissão de NF-e. A empresa está habilitada, se o conteúdo do campo vtConsultaCadastro.infCons.infCad[0].icSit for 1. Se for 0 (zero), a empresa não está habilitada.
- Apenas as SEFAZ que possuem servidor próprio possuem o Web Service de consulta de cadastro. Portanto não é possível consultar o cadastro de nenhuma empresa atendida pelo SVAN ou SVRS;
- Os servidores de contingência não possuem o Web Service de consulta de cadastro;
- A consulta deve ser enviada à UF da empresa cujos dados se quer consultar. Por exemplo, se a empresa que faz a consulta é de SP e quer consultar os dados de uma empresa de GO, a consulta deve ser enviada à SEFAZ de GO;
- A consulta só retornará dados de empresas que estejam cadastradas como contribuintes de ICMS.
- Algumas Secretarias só permitem consultas feitas por empresas da mesma UF. É o caso, por exemplo, de PE.
- O Web Service de consulta de cadastro ainda está instável em algumas Unidades e apresenta limitações de dados em outras. Consulte a tabela que mostra a situação em cada UF (por favor, nos informe caso tenha obtido uma situação diferente em algum deles para atualizarmos a documentação) clicando aqui.
- Embora exista previsão para retornar todos os dados cadastrais, nem todas as UFs retornam todas as informações. Os seguintes dados são devolvidos por todas as UFs (os demais serão devolvidos a critério de cada UF): CNPJ/CPF, Inscrição Estadual, Razão Social e situação cadastral: 0 - não habilitado ou 1 - habilitado.
Não encontrou o que precisava, entre em contato conosco.