NFeEnviaECONF

A função NFeEnviaECONF é usada para enviar o evento de Conciliação Financeira - ECONF.

Tipo de Retorno

Boolean

Pacote

A função NFeEnviaECONF está definida dentro do pacote NF-eEnviaECONF.pkg.

Sintaxe

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

Onde:

  • &{vParams} é uma variável do tipo tNFeEnviaECONF. 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, para o modelo 55 (NF-e), o "SVRS" atende a todas as UFs. Já para o modelo 65 (NFC-e), deverá ser utilizada a sigla da UF;
    • 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 a qual será registrado o evento;
    • sDhEvento: é a data e hora do evento no formato AAAA-MM-DDThh:mm:ss. Caso não seja informado, será pega da máquina que está executando a aplicação (no caso de aplicação Web, será a data/hora do servidor), e não será retorna após a execução;
    • inSeqECONF: é 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;
    • 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);
    • sindPag: parâmetro opcional, indica o tipo de pagamento:
      • 0-pagamento à vista;
      • 1-pagamento à prazo.
    • itPag: meio de Pagamento - Utilizar a Tabela de códigos dos meios de pagamentos publicada no Portal Nacional;
    • sxPag: é a descrição do meio de pagamento. Preencher quando for informado 99-outros no parâmetro itPag;
    • nvPag: é o valor do pagamento;
    • sdPag: é a data do pagamento que deve ser preenchida no caso de pagamento agendado com a data da efetivação do pagamento;
    • sCNPJPag: é o CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido quando a emissão do documento fiscal ocorrer em estabelecimento distinto;
    • sUFPag: é a UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido;
    • sCNPJIF: é o CNPJ da instituição financeira, de pagamento, adquirente ou subadquirente;
    • stBand: é o código da bandeira do cartão de crédito e/ou débito sendo, 01-Visa, 02-Mastercard, 03-American Express, 04-Sorocred ou 99-Outros;
    • scAut: é o número da autorização da transação da operação;
    • sCNPJReceb: é o CNPJ do estabelecimento beneficiário do pagamento;
    • sUFReceb: é a UF do CNPJ do estabelecimento beneficiário do pagamento;
    • sRetXML: retorna o XML gerado pelo WS. É o mesmo XML que será salvo no caminho indicado no parâmetro sPathArqXMLRetorno;
    • sRetMsgDados: retorna o XML usado para realizar o envio para o WS;
    • sRetMsgRetWS: retorna o XML devolvido pelo WS quando o envio for realizado;
    • sRetMsgResultado: retorna o texto contendo a mensagem de retorno de acordo com iRetCdRetorno;
    • iRetCdRetorno: retorna o código numérico que representa o retorno do envio realizado, podendo ser o código de retorno da DLL ou o código de retorno da SEFAZ;
    • sRetMsgRetGravacao: é o texto contendo a mensagem retornoda na tentativa de salvar o arquivo;
    • iRetCdGravacao: é o código referente ao resultado da tentativa de salvar o arquivo XML:
      • -1-ocorreu um erro ou tentar salvar;
      • 1-arquivo salvo com sucesso;
    • sRetdProtocolo: retorna a data e hora do protocolo no formato AAAA-MM-DDThh:mm:ss, quando o evento é registrado com sucesso;
    • sRetnProtocolo: retorna número do protocolo, quando o evento é registrado com sucesso; 
  • {bRet} é uma variável do tipo boolean que recebe o retorno da função, sendo que TRUE, indica que o Web Service foi consumido com sucesso e FALSE, indica que algum 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

  • Esta função está disponível a partir da versão 2024/02 da NFeLibrary.
  • Para informar um novo evento de “ECONF” para a mesma NF-e, o evento anterior deverá ser cancelado utilizando a função NFeCancelaECONF.

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