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

NFBRecepcionarDPS

A função NFBRecepcionarDPS é usada para enviar uma DPS (Declaração de Prestação de Serviço), para o Web Service da Sefin para a geração da NFS-e.

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

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

Onde:

  • &{vParams} é uma variável do tipo tNFBRecepcaoDPSParam. Deve ser passada por referência. Contém os parâmetros para execução da função e retornos, conforme abaixo:
    • sArquivoEnvio: é o caminho completo, terminado em “.XML”, do arquivo que deseja enviar ao Web Service;
    • sDiretorioGravacao: é o diretório onde o XML da NFS-e será salvo quando gerado pela Sefin. O nome do arquivo gerado, será formado pela chave da NFS-e acrescido do sufixo “-nfb.xml”. Se no local indicado existir um arquivo com o mesmo nome, ele será sobrescrito;
    • 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;
    • 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);
    • sRetMsgDados: retorna o XML usado para realizar o envio para o WS;
    • sRetMsgRetWS: retorna o XML recebido do WS;
    • iRetCdRetorno: retorna o código numérico da operação realizada, podendo ser o código de retorno da DLL ou o código de retorno da Sefin;
    • sRetMsgResultado: retorna o texto contendo a mensagem de retorno de acordo com iRetCdRetorno;
    • bRetSalvou: retorna true se o XML gerado foi salvo com sucesso. Caso contrário retorna false;
    • vtRetorno: é uma variável do tipo tNFBRecepcaoDPSRetorno que retorna os dados do Web Service, conforme abaixo:
      • iTipoAmbiente: retorna ambiente que processou o XML, sedo 1-produção ou 2-produção-retrita (antigo ambiente de homologação);
      • sDataHoraProcessamento: retorna a data, hora, minutos e segundo em que a solicitação foi processada, independentemente se foi processado com sucesso;
      • sIdDPS: retorna a chave do DPS;
      • sChaveAcesso: retorna a chave de acesso da NFS-e;
      • tErrosAlertas: é um array do tipo tNFBRecepcaoDPSErrosAlestas que retorna as mensagens do Web Service, podendo ser alertas, no caso de o processo ter sido executado com sucesso, ou mensagens de erros. É composta pelos campos:
        • sMensagem: retorna a mensagem do Web Service;
        • sCodigo: retorna o código do erro/alerta;
        • sDescricao: retorna à descrição do erro ou alerta;
        • sComplemento: retorna informações complementares para compreender o erro/alerta.
  • {bRet}é uma variável do tipo boolean que recebe o retorno da função, sendo que TRUE indica que o Web Service foi consumido com sucesso e FALSE indica que algum erro ocorreu ao consumir o Web Service..

Exemplo

Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo na função NFBEnviaDFSExemplo no pacote cDPSDataDictionary.dd.