CTeEnviarCancIE

A função CTeEnviarCancIE é usada para cancelar o evento de Insucesso na Entrega do CT-e.

Tipo de Retorno

Boolean

Pacote

A função CTeEnviarCancIE está definida no pacote CTeEnviarCancIE.pkg.

Sintaxe

Move (CTeEnviarCancIE({vParams})) to {bRetorno}

Onde:

  • {vParams} é uma variável do tipo tCTeEnviarCancIE, onde cada campo contém um parâmetro a ser passado ou um retorno que será recebido;
    • sSiglaWS: sigla do WS para onde será feito o envio.
    • iAmbiente: ambiente do CT-e para o qual será enviado o evento: 1 - Produção / 2 - Homologação.
    • sVersao: versão do arquivo XML a ser enviado. Se for passado em branco a função irá considerar "4.00".
    • sArquivoDestino: nome e caminho completo onde será salvo o XML quando vinculado com sucesso.
    • sChaveCTe: chave do CT-e que contém a(s) nota(s) fiscal(is) que não tiveram sucesso na entrega.
    • sProtocoloCTe: número do protocolo de autorização do CT-e.
    • sProtocoloIE: número do protocolo do evento Insucesso na Entrega.
    • sDhEvento: (parâmetro opcional) Data e hora do evento de cancelamento do Insucesso na Entrega no formato "AAAA-MM-DD HH:MM:SS". Caso não seja informado, a library ir informar a cada correndo do computador.
    • sChavesNFeEntrega: é um array do tipo String, utilizado para informar as chaves das NF-e’s com insucesso na entrega.
    • iNroSeqIECTe: número sequencial do evento controlado pelo usuário/desenvolvedor. Este deve ser incrementado a cada evento registrado com sucesso, iniciando de 1 até no máximo 99.
    • 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. 
    • sProxy: informar o endereço do servidor proxy, se necessário. Por exemplo ’http://proxyserver:port’. Verificar com o cliente qual é o endereço do servidor proxy e a porta https. 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 da CTeLibrary.dll. Esta função pode ser utilizada sem qualquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento. Entre em contato conosco para obter a chave de licença.
    • bExibeErro: indica se a função deve exibir os erros que ocorrerem (True) ou não (False).
    • sRetNroProtocolo: retorna o número do protocolo do registro do evento.
    • sRetdhProtocolo: retorna a data e hora do registro do evento.
    • sRetornoXML: retorna o XML com o protocolo do registro do evento que é anexado no CT-e.
    • sRetMsgDados: retorna a mensagem XML enviada ao WS pela função.
    • sRetMsgRetWS: retorna a mensagem XML com a resposta do WS.
    • iRetcStat: retorna o código referente ao retorno da função, sendo que 135 significa que o evento foi processado e registrado com sucesso. Códigos diferentes de 135, significa que algum erro ou rejeição ocorreu durante o processamento e será necessário consultar o parâmetro sRetMsgResultado.
    • sRetMsgResultado: retorna a mensagem literal com o significado do código retornado no iRetcStat.
    • iRetcStatSalvaArq: retorna o código do resultado da tentativa de salvar o arquivo XML de retorno com o protocolo anexado. Caso não ocorram erros retorna 0, caso contrário retorna -999.
    • sRetMsgResultadoSalvaArq: retorna a mensagem literal com o significado do código retornado no iRetcStatSalvaArq.
  • {bRetorno} é o retorno da chamada da função. True indica que webservice foi consumido, caso contrário retorna False. Para obter detalhes sobre o resultado do envio do evento, consulte os parâmetros iRetcStat, que retorna o código 135 quando registrado com êxito e o parâmetro sRetMsgResultado, que retorna a descrição literal do resultado.

Exemplo

  • Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo na view Cte.vw, na aba infNFe que está dentro das abas infCTeNorm e infDoc.

Observação

  • A função CTeEnviarCancIE está disponível a partir da versão 2023/01 da CTeLibrary.

 

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