NFeCancelaInsucessoEntrega

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

Tipo de Retorno

Boolean

Pacote

A função NFeCancelaInsucessoEntrega está definida dentro do pacote NF-eEnviaCancInsucessoEntrega.pkg.

Sintaxe

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

Onde:

  • &{vParams} é uma variável do tipo tNFeEnviaCancInsucessoEntrega. Deve ser passada por referência. Contém os parâmetros para execução da função e também retorno, conforme abaixo:
    • SiglaWS: é a sigla do Web Service para o qual será enviado o evento. Atualmente o "SVRS" atende a todas as UFs;
    • iTipoAmbiente: indica o ambiente para onde o evento será enviado:
      • 1-Produção;
      • 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 qual será enviado o evento;
    • 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 que está executando a aplicação (no caso de aplicação Web, será a data/hora do servidor);
    • inSeqCancIENFe: é 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;
    • sPathArqXMLRetorno: é o caminho completo, finalizado com .XML, onde será salvo o XML quando o envio for realizado com sucesso;
    • sNrProtocoloEventoIE: é o número do protocolo do evento Insucesso na entrega que será cancelado.
    • sProxy: é 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: é o usuário para autenticação no proxy, se necessário;
    • sSenha: é a senha de autenticação no proxy, se necessário;
    • sLicenca: é a chave da licença de uso, necessária para uso em ambiente de produção;
    • bExibeErro: indica se as mensagens de erro ocorridas devem ser mostradas (TRUE) ou não (FALSE);
    • sRetMsgDados: retorna o XML enviado para o WS;
    • sRetMsgRetWS: retorna o XML recebido de volta quando o envio foi realizado;
    • iRetCdRetorno: retorna o código numérico que representa o retorno do envio, podendo ser o código de retorno da DLL ou o código de retorno da SEFAZ;
    • sRetMsgResultado: retorna texto literal relativo ao iRetCdRetorno;
    • sRetNroProtocolo: retorna o número do protocolo, quando o evento é autorizado;
    • sRetDhProtocolo: retorna a data e hora do protocolo, quando o evento é autorizado; 
    • sRetXMLProtocoloCancelamento: retorna o XML do evento;
    • iRetCdGravacao: retorna o código relativo ao resultado da tentativa de salvar o arquivo XML:
      • -1-ocorreu um erro ou tentar salvar;
      • 1-arquivo salvo com sucesso.
    • sRetMsgGravacao: é o resultado literal da tentiva 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 consumido sucesso e FALSE indica que alguns erro ocorreu ao consumir o Web Service.

Exemplo

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

Observação

  • A função está disponível a partir da versão 2024/02 da NFeLibrary.

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