A função NFeEnviaCanCEe é usada para enviar ao SEFAZ o cancelamento de um comprovante de entrega vinculado anteriormente a uma NF-e.
Tipo de Retorno
Boolean
Pacote
A função NFeEnviaCanCEe está definida dentro do pacote NF-eEnviaCanCEe.pkg.
Sintaxe
Move (NFeEnviaCanCEe(&vParam)) to bRet
Onde:
- &{vParams} é uma variável do tipo tNFeEnviaCanCENFE e é passada por referência contendo os parâmetros para execução da função e possui também algumas propriedades de retorno, conforme abaixo:
- sSiglaWS é a sigla do Web Service para o qual será enviada a solicitação. Atualmente o "AN" atende a todas as UFs.
- iAmbiente: indica o ambiente onde a consulta será feita, sendo 1-Produção e 2-Homologação;
- sVersao: versão do layout enviado. Caso não seja informado, será atribui automaticamente "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: chave de acesso da NF-e que o evento será vinculado;
- sDhEvento: data e hora do evento no formato "AAAA-MM-DD HH:MM:SS". Caso não seja informado a função irá pegar a data e hora atual;
- nroCancCE: número sequencial do evento, iniciando em 1 e no máximo 20;
- sVerAplic: Versão do aplicativo do Autor do Evento;
- snProtEvento: número do Protocolo de Autorização do Evento da NF-e a que se refere este cancelamento;
- sProxy: endereço do servidor proxy que deve ser usado para realizar a consulta;
- sUsuario: usuário que será autenticado no servidor proxy para realizar a consulta;
- sSenha: senha do usuário que será autenticado no servidor proxy para realizar a consulta;
- sLicenca: chave da DLL que será verificada para permitir a consulta em ambiente de produção;
- sPathArqXMLRetorno: caminho completo onde será salvo o arquivo XML no caso do comprovante ser vinculado a NF-e;
- bExibeErro: indica se as mensagens de erro do processo devem ser mostradas (TRUE) ou não (FALSE);
- sMsgDados: retorna o XML do lote da GNRE enviado;
- sMsgRetWS: retorna a mensagem em formato XML com a resposta do Webservice;
- sMsgResultado: retorna a literal do resultado da chamada ao Webservice;
- icStat: retorna o código referente ao retorno do Webservice;
- sNroProtocolo: retorna o número do protocolo de registro do Evento.
- sDhProtocolo: retorna a data e hora de registro do Evento, a data passou a ser UTC com a indicação do fuso horário.
- {bRet} variável do tipo boolean, retorna True se o Webservice for consumido com sucesso, caso contrário retorna False.
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 2022/01 da NFeLibrary.
Não encontrou o que precisava, entre em contato conosco.