NFeEnviaInsucessoEntrega

A função NFeEnviaInsucessoEntrega é usada para enviar o evento Insucesso na Entrega da NF-e.

Tipo de Retorno

Boolean

Pacote

A função NFeEnviaInsucessoEntrega está definida dentro do pacote NF-eEnviaInsucessoEntrega.pkg.

Sintaxe

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

Onde:

  • &{vParams} é uma variável do tipo tNFeEnviaInsucessoEntrega. Devee ser passada por referência. Contém os parâmetros para execução da função e também retornos, conforme abaixo:
    • SiglaWS: é a sigla do Web Service para o qual será enviado o evento. Atualmente o "SVRS" atende a todas as UFs para este evento;
    • iTipoAmbiente: indica o ambiente para onde o evento será enviado, sendo 1-Produção e 2-Homologação;
    • sVersao: versão do evento. Se for deixado em branco, será usado o valor "4.00";
    • 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;
    • sChaveNFe: é a chave da NF-e para a qual será registrado o insucesso;
    • sCNPJCPFAutor: é o CNPJ/CPF do autor do Evento;
    • sDhEvento: é a data e hora do evento no formato AAAA-MM-DDThh:mm:ss. Caso não seja informada, será pega da máquina local (no caso de aplicação Web, é pega do servidor);
    • inSeqIENFe: é o número sequencial do evento (relativo a este mesmo tipo de evento). Deve iniciar com 1 e vai até o máximo de 99. A sequência deve ser controlada pelo desenvolvedor e não deve duplicar;;
    • sVerAplic: é a versão do aplicativo do autor do evento;
    • iTentativa: é o número da tentativa de entrega. Deve ser iniciada com 1 e o valor máximo é 99;
    • iTpMotivo: informar um dos motivos do insucesso:
      • 1-Recebedor não encontrado;
      • 2-Recusa do recebedor;
      • 3-Endereço inexistente;
      • 4-Outros (exige informar justificativa).
    • sxJustMotivo: justificativa do motivo do insucesso. Informar apenas para iTpMotivo=4;
    • nLatGPS: (opcional) informar latitude do ponto de entrega;
    • nLongGPS: (opcional) informar longitude do ponto de entrega;
    • sPathArqXMLRetorno: é o caminho completo, finalizado com .XML, onde será salvo o XML quando o evento for autorizado;
    • sArqTentativaEntregaHash: é o caminho completo da imagem capturada na tentativa da entrega;
    • sProxy: é o endereço do servidor proxy que deve ser usado para realizar a consulta;
    • sUsuario: é o usuário que será autenticado no servidor proxy para realizar a consulta;
    • sSenha: é a senha do usuário que será autenticado no servidor proxy para realizar a consulta;
    • sLicenca: é a chave da DLL que será verificada para permitir a consulta em ambiente de produção;
    • bExibeErro:  indica se as mensagens de erro do processo devem ser mostradas (TRUE) ou não (FALSE);
    • sRetMsgDados: retorna o XML usado para realizar a consulta no WS;
    • sRetMsgRetWS: retorna o XML recebido quando a consulta for realizada;
    • iRetCdRetorno: retorna o 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;
    • sRetMsgResultado: retorna texto contendo a mensagem de retorno de acordo com iRetCdRetorno;
    • sRetNroProtocolo: retorna o número do protocolo, quando o processo é realizado com sucesso;
    • sRetDhProtocolo: retorna a data e hora do protocolo, quando o processo é realizado com sucesso; 
    • sRetXMLProtocoloAutorizado: retorna o XML composto pelo insucesso na entrega e o respectivo protocolo;
    • iRetCdGravacao: retorna o código relativo ao resultado da tentativa de salvar o arquivo XML, sendo: -1-ocorreu um erro ao tentar salvar e 1-arquivo salvo com sucesso.
    • sRetMsgRetGravacao: texto contendo a mensagem retornoda na tentativa de salvar o arquivo;
  • {bRet} é uma variável do tipo boolean que recebe o retorno da função, sendo que TRUE indica que o webservice foi consumido com sucesso e FALSE indica que algum erro ocorreu ao consumir o webservice.

Exemplo

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

Observações

  • A função está disponível a partir da versão 2024/02 da NFeLibrary.
  • Para informar um novo evento de "Insucesso na Entrega da NF-e” para a mesma NF-e, o evento anterior deverá ser cancelado utilizando a função NFeCancelaInsucessoEntraga.

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