NFeConsChNFe

A função NFeConsChNFe é usada para buscar o arquivo XML utilizando uma chave específica.

O XML da nota fiscal estará disponível ao destinatário somente após realizada a manifestação, e será salvo no diretório informado no parâmetro {sDiretorio}. Já o nome do arquivo XML, será formado pela chave da NF-e e o complemento "-nfeProc.xml". Para os demais atores o XML estará diponível, mesmo sem a manisfestação do destinatário.

Para o destinatário, no caso da NF-e não ter sido manifestada, será retornado o resumo da NF-e, que será armazenado no campo {vtresNFe} do parâmetro passado.

Tipo de Retorno

Boolean

Pacote

A função NFeConsChNFe está definida dentro do pacote NF-eConsChNFe.pkg.

Sintaxe

Move (NFeConsChNFe(&{vParams})) to {bRet}

Onde:

  • {vParams} é uma variável do tipo tNFeConsChNFe_Params que deve ser passada por referência. Este tipo é uma estrutura, que contém os seguintes campos:
    • sSiglaWS (string): é a sigla do Web Service para o qual será enviada a solicitação. Informar "AN" pois o WS do Ambiente Nacional atende destinatário de qualquer UF, atualmente;
    • iTipoAmbiente (integer): ambiente de trabalho, podendo ser 1-Produção ou 2-Homologação;
    • sNomeCertificado (string): é 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;
    • sDiretorio (string): informe o caminho do diretório onde deve ser gerado o arquivo XML no caso de retornar o procNFe;
    • sVersao (string): versão da consulta a ser feita - 1.01 (SSL 3.0) ou 4.00 (TLS 1.2);
    • sCNPJ_CPF (string): informar o CNPJ ou CPF do ator que deseja consultar os documentos fiscais;
    • sChaveNFe (string): informar a chave da NF-e que deseja consultar;
    • sProxy (string): é 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 (string): é usado para informar o usuário para autenticação no proxy, se necessário;
    • sSenha (string): é usado para informar a senha de autenticação no proxy, se necessário;
    • sLicenca (string): chave da DLL que será verificada para permitir a consulta em ambiente de produção;
    • bExibeErro (boolean): indica se a função deve exibir (true) ou não (false) os erros que ocorrerem na execução da função. O valor padrão é False;
    • sMsgDados (string): retorna a mensagem XML enviada para o WS;
    • sMsgRetWS (string): retorna a mensagem XML de resposta do WS;
    • icStat (integer): retorna o código do resultado da chamada do WS;
    • sMsgResultado (string): após a execução da função, será devolvido nesta variável o resultado literal da execução, que pode ser uma mensagem de sucesso, ou a descrição do erro ocorrido durante a geração.
    • sVerAplic (string): retorna a versão da aplicação do Web Service;
    • sNSUXML (string): retorna o NSU do documento consultado;
    • sSchemaXML (string): retorna o Identificação do Schema XML;
    • sRetornoXML (string): retorna o XML gerado obtido na consulta ou vazio se a consulta não for bem sucedida;
    • vtresNFe (tNFeDFeresNFe); retorna as informações do XML caso seja um resumo da NF-e.
  • {bRet} é uma variável do tipo boolean que retorna true se a consulta foi bem sucedida, caso contrário retona false.

Exemplo

Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo na view Consulta NF-e pela chave.

Observações

  • Esta função está disponível a partir da versão 2020/01 da NFeLibrary.
  • Esta função utiliza o Web Service NFeDistribuicaoDFe e consequentemente, respeita as mesmas regras.
  • Ressaltamos que esta função deve ser utilizada com cautela em tarefas específicas pois além de ser lenta, se utilizada várias vezes em um período curto de tempo, pode causar o bloqueio do CNPJ em todos os Web Services do projeto da NF-e, devido ao erro "consumo indevido".
     

Não encontrou o que precisava, entre em contato conosco.