A função NFeEnviarAtorInter é usada para enviar o evento Ator Interessado na NF-e.
Tipo de Retorno
Boolean
Pacote
A função NFeEnviarAtorInter está definida dentro do pacote NF-eEnviarAtorInter.pkg.
Sintaxe
Move (NFeEnviarAtorInter(&{vParams})) to {bRet}
Onde:
- &{vParams} é uma variável do tipo tNFeEnviaAtorInter. Deve 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 "AN" atende a todas as UFs;
- 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 braco, 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á dado acesso ao ator interessado;
- sCNPJCPFAutor: é o CNPJ ou CPF do autor do Evento;
- sDhEvento: é a data e hora do evento no formato AAAA-MM-DDThh:mm:ss. Caso não sejá informada, será pega da máquina que está executando a aplicação (no caso de aplicação Web, será a data/hora do servidor);
- sOrgaoAutor: é código da UF do emitente do Evento;
- iTpAutor: 1-Geração do Evento pelo Emitente, 2-Geração do Evento pelo Destinatário ou 3-Geração do Evento pelo Transportador;
- sVerAplic: é a versão do aplicativo do Autor do Evento;
- sCNPJCPFAutorizado: é o CNPJ/CPF autorizado a acessar a NF-e;
- iTpAutorizacao: 0Não permite ou 1Permite o transportador autorizado pelo emitente ou destinatário autorizar outros transportadores para ter acesso ao download da NF-e;
- iNroSeqEvento: é o número sequencial do evento (relativo a este mesmo tipo de evento). Deve iniciar com 1 e vai até o máximo de 20. A sequência deve ser controlada pelo desenvolvedor e não deve duplicar;
- sPathArquivoXML: é o caminho completo, finalizado com .XML, onde será salvo o XML com o protocolo caso a operação tenha ocorrido com sucesso;
- sProxy: é usado para informar 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: é 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: é 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);
- sRetNroProtocolo: retorna o número do protocolo, quando o envio é realizado com sucesso;
- sRetDhProtocolo: retorna a data e hora do protocolo no formato AAAA-MM-DDThh:mm:ss, quando o envio é realizado com sucesso;
- iRetCdGravaArq: 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.
- sRetMsgResultGravaArq: é o resultado literal da tentativa de salvar o arquivo;
- sRetMsgDados: retorna o XML enviado para o WS;
- sRetMsgWS: 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 contendo a mensagem de retorno de acordo com icStat;
- {bRet} é uma variável do tipo boolean que recebe o retorno da função, sendo que TRUE indicando que o webservice foi consumido consumido com sucesso (o que não significa que o evento foi autorizado) ou FALSE indicando que ocorreu erro ao consumir o Web Service.
Exemplo
Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo na view NFeEnviarAtorInter.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.