NFeDistribuicaoDFe

A função NFeDistribuicaoDFe serve para recuperar a lista de documentos fiscais relacionados a um CPF/CNPJ ou um documento específico através do NSU - Número Sequencial Único.

Tipo de Retorno

Integer

Pacote

A função NFeDistribuicaoDFe está definida dentro do pacote NF-eDistribuicaoDFe.pkg.

Sintaxe

Move (NFeDistribuicaoDFe(&{vParams})) to {iRet}

Onde:

  • &{vParams} é uma variável do tipo tNFeDistribuicaoDFe e é passada por referência contendo os parâmetros para execução da função e possui também algumas propriedades de retorno, conforme abaixo:
    • sSiglaWS é a sigla do Web Service para o qual será enviada a solicitação. Atualmente o "AN" atende a todas as UFs.
    • iAmbiente: indica o ambiente onde a consulta será feita, sendo 1-Produção e 2-Homologação;
    • sVersao: versão da consulta a ser feita. Informe "1.00" nas versões anteriores à versão 2018/01 ou, a partir da versão 2018/01, informe "1.01" se o servidor estiver operando com SSL 3.0 ou "4.00" se o servidor estiver operando com TLS 1.2;
    • 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;
    • sMsgDados: receberá o XML usado para realizar a consulta no WS;
    • sMsgRetWS: receberá o XML recebido quando a consulta for realizada;
    • icStat: código numérico que representa o retorno da consulta realizada, podendo ser o código de retorno da DLL ou o código de retorno da consulta feita na SEFAZ;
    • sMsgResultado: texto contendo a mensagem de retorno de acordo com icStat;
    • bConsultarNSU: indica se deve ser consultado um NSU específico (TRUE) ou (FALSE) se deve ser feita a consulta para recuperar a lista de documentos relacionados;
    • sCNPJ: CNPJ que será consultado para recuperar os documentos fiscais relacionados;
    • sUF: código numérico da UF do emitente onde a consulta será feita;
    • sNSU: indica a NSU específica a ser consultada ou a NSU de referência quando a lista de documentos será recuperada;
    • sVerAplic: retorna a versão da aplicação que processou a consulta na SEFAZ;
    • sDhResp: retorna a data e hora em que a consulta foi realizada;
    • sUltNSU: retorna o código do último NSU contido na consulta realizada;
    • sMaxNSU: retorna o código do maior NSU existente na base de dados da SEFAZ;
    • sNSUXML: retorna o código NSU do XML contido na resposta, quando apenas um NSU é consultado;
    • iQtdeDocto: retorna a quantidade de documentos contidos na resposta;
    • sSchemaXML: retorna o SCHEMA relacionado ao XML da resposta;
    • sProxyServidor: endereço do servidor proxy que deve ser usado para realizar a consulta;
    • sProxyUsuario: usuário que será autenticado no servidor proxy para realizar a consulta;
    • sProxySenha: senha do usuário que será autenticado no servidor proxy para realizar a consulta;
    • sLicenca: chave da DLL que será verificada para permitir a consulta em ambiente de produção;
    • sRetorno: resultado da consulta relacionada contendo os documentos recuperados na consulta;
    • vRetorno: matriz do tipo tNFeDFeDocumentoFiscal contendo cada documento recuperado na consulta (clique aqui para mais detalhes sobre a estrutura);
    • bExibeErro: indica se as mensagens de erro do processo devem ser mostradas (TRUE) ou não (FALSE);
  • {iRet} é uma  variável do tipo Integer que recebe o retorno da função, sendo 0 (zero) o retorno positivo, ou outro valor caso ocorra algum erro.

Exemplo

Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo na view Manifestacao.vw.

Observações

  • Esta função tem por objetivo substituir a função NFeConsultaNFDest, conforme consta na Nota Técnica 2014/02;
  • A função está disponível a partir da versão 2015/01 da NFeLibrary.

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