NFeConsultaDPEC (obsoleta)

Função obsoleta: A DPEC foi descontinuada em 01/12/2014 pelo projeto da NF-e.

A função NFeConsultaDPEC serve para realizar a consulta de um DPEC através do protocolo de recebimento ou da chave da NF-e.

Tipo de Retorno

Integer

Pacote

A função NFeConsultaDPEC está definida dentro do pacote NF-eConsultaDPEC.pkg.

Sintaxe

Move (NFeConsultaDPEC(&{vParams}, {bExibeErro})) to {iRet}

Onde:

  • &{vParams} é uma variável do tipo tNFeConsultaDPEC passada por referência que deve ser carregada com as informações necessárias para executar a consulta, sendo que os possíveis campos são:
    • iTpAmbiente: ambiente onde realizar a consulta, podendo ser 1-Produção ou 2-Homologação;
    • sChaveNF: chave da NF-e a ser consultada, que pode ser em branco se o protocolo de recebimento for informado;
    • sNroReciboDPEC: número do protocolo de recebimento do DPEC, que pode ser em branco se a chave da NF-e for informada;
    • sNomeCertificado: é 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: não é informado, pois retornará o XML usado para realizar a consulta;
    • sMsgRetWS: não é informado, pois retornará o XML de resposta do consumo do WS;
    • sMsgResultado: não é informado, pois retornará com a mensagem de resposta do processamento;
    • sArquivoXml: parâmetro opcional contendo o nome do arquivo onde será salvo o XML de retorno da consulta;
    • 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;
    • sLicenca: é usado para informar a chave da licença de uso ou registro quando a função é utilizada em ambiente de produção.
  • {bExibeErro} é usado para indicar se a função deve exibir ou não os erros que ocorrerem na execução.
  • {iRet} é uma  variável do tipo Integer que recebe o retorno da função, sendo 0 (zero) o retorno positivo, ou -1 caso ocorra algum erro.

Exemplo

Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo na função NFeConsultaDPEC no arquivo cNotaDataDictionary.dd. Abaixo a função citada e a chamada da função da Library na linha 29.

NFeConsultaDPEC

Observações

  • Deve ser observado atentamente as propriedades da estrutura tNFeConsultaDPEC, pois alguns são parâmetros da função e outras são retornos.
  • A função realiza a consulta mas não retorna nenhuma informação sobre o DPEC gravado, como o protocolo de recebimento ou a data do recebimento.
  • Caso o desenvolvedor queira verificar alguma informação sobre o DPEC consultado, o mesmo deverá salvar o arquivo XML de retorno e ler esse arquivo procurando as informações que desejar;
  • Esta função está disponível a partir da versão 2013/02;
  • Esta funcionalidade pode ser utilizada sem qualquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento ou registro. Entre em contato para mais informações.

 

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