Home 5 NFBLibrary 5 NFB_Documentação 5 NFB_Função 5 NFBDistribuicaoDFe

NFBDistribuicaoDFe

A função NFBDistribuicaoDFe é usada para recuperar a lista de documentos fiscais relacionados a um CPF/CNPJ.

Tipo de Retorno

Boolean

Pacote

A função NFBDistribuicaoDFe está definida dentro do pacote NFBDistribuicaoDFe.pkg.

Sintaxe

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

Onde:

  • &{vParams} é uma variável do tipo tNFBDistribuicaoDFeParam. Deve ser passada por referência. Contém os parâmetros para execução da função e retornos, conforme abaixo:
    • sNSU: indica a NSU de referência quando a lista de documentos será recuperada;
    • iTpAmb indica o ambiente para qual será enviada a solicitação, sedo 1-produção ou 2-produção-retrita (antigo ambiente de homologação);
    • 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;
    • sCNPJ: CNPJ que será consultado para recuperar os documentos fiscais relacionados;
    • sProxy: é usado para informar o endereço do servidor proxy, se necessário. Por exemplo ’https://proxyserver:port’. Verificar 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 ’https://192.168.15.1:443’;
    • sUsuarioProxy: é usado para informar o usuário para autenticação no proxy, se necessário;
    • sSenhaProxy: é usado informar a senha de autenticação no proxy, se necessário;
    • bExibeErro: indica se as mensagens de erro devem ser mostradas (TRUE) ou não (FALSE);
    • vtNFBResultadoDFe é uma variável do tipo tNFBResultadoDFe contendo os documentos recuperado na consulta, além de eventuais mensagens de erros e alertas, status do processamento entre outras informações. Mais detalhes sobre a definição desta variável, pode ser obtidas no NFBStruct.pkg;
    • sRetRetornoXmlWs: retorna o xml gerado pelo Web service;
    • sRetMsgResultado: retorna a mensagem literal com o resultado da consulta;
    • iRetCdRetorno: retorna o código referente ao resultado da consulta, sendo que 200 a consulta foi realizada com sucesso/
  • {bRet} é uma variável do tipo boolean que recebe o retorno da função, sendo que TRUE indica Web Service foi consumido com sucesso e FALSE indica que ocorreu algum erro.

Exemplo

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