NFeInutilizar

A função NFeInutilizar é usada para inutilizar uma faixa de numeração de NF-e.

Tipo de Retorno

Integer

Pacote

A função NFeInutilizar está definida dentro do pacote NF-eInutilizar.pkg.

Sintaxe

Move (NFeInutilizar({sSiglaWS}, {iTpAmbiente}, {sCertificado}, ;
                    &{sMsgCabec}, &{sMsgDados}, &{sMsgRetWS}, ;
                    &{sMsgResultado}, {iCdUFEmitente}, {sAno}, ;
                    {sCNPJEmitente}, {sModeloNFe}, {sSerieNFe}, ;
                    {iNotaInicial}, {iNotaFinal}, {sJustificativa}, ;
                    {sProxy}, {sUsuario}, {sSenha} , {sLicencaNFeUtil}, ;
                    &{snProt}, &{sdhRecbto}, &{sMotivo}, ;
                    &{scStat}, {bExibeErro} [,{sDiretorioXML}])) to {iRet}

Onde:

  • {sSiglaWS} é a sigla do Web Service para o qual será enviada a solicitação. Veja mais detalhes aqui.
  • {iTpAmbiente} ambiente de trabalho, podendo ser 1-Produção ou 2-Homologação;
  • {sCertificado} é 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;
  • &{sMsgCabec} é uma variável do tipo String que precisa ser passada por referência, porém uma string nula pode ser informada visto que este parâmetro é legado e não é mais usado. Ele perdeu sua utilizada na versão 2.0 da Library, mas não foi removido para que o processo de atualização fosse simplificado para os desenvolvedores;
  • &{sMsgDados} é uma variável do tipo String que precisa ser passada por referência e que após a execução da função receberá o XML completo do pedido de inutilização que foi enviado ao Web Service. Normalmente esta informação é útil somente para o propósito de depuração é não é usada na prática pelo emitente;
  • &{sMsgRetWS} é uma variável do tipo String que precisa ser passada por referência e que após a execução da função receberá a mensagem XML de resposta do Web Service. Normalmente esta informação é útil somente para o propósito de depuração é não é usada na prática pelo emitente;
  • &(sMsgResultado} é uma variável do tipo String que precisa ser passada por referência e que após a execução da função receberá a mensagem literal do resultado da chamada do Web Service. Por exemplo, se você tentar inutilizar uma faixa de numeração que já contém notas inutilizadas, receberá o seguinte retorno: "Rejeição: Uma NF-e da faixa já está inutilizada na Base de dados da SEFAZ";
  • {iCdUFEmitente} é o código do IBGE para a UF do emitente que está solicitando a inutilização. Atenção: esta informação não é a sigla mas sim o código da UF. Se a versão em uso da NFeLibrary for a versão Plus então é possível fazer uso da função NFePegaCodigoEstadoIBGE para obter o código da UF a partir da sigla;
  • {sAno} é o ano da inutilização da NF. Atenção: deve ser passado o ano apenas com 2 dígitos e com zero à esquerda. Por exemplo, para 2009, passar "09";
  • {sCNPJEmitente} é o CNPJ do emitente da NF que será inutilizada, não sendo necessário se preocupar em remover traços, separadores ou espaços, pois a função se encarregará de removê-los;
  • {sModeloNFe} é o modelo da NF que será inutilizada;
  • {sSerieNFe} é a série da NF que será inutilizada;
  • {iNotaInicial} é o número da primeira NF que será inutilizada;
  • {iNotaFinal} é o número da última NF que será inutilizada;
  • {sJustificativa} é a justificativa da inutilização, que deve ter no mínimo 15 caracteres;
  • {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;
  • {sLicencaNFeUtil} é usado para informar a chave da licença de uso ou registro quando a função é utilizada em ambiente de produção;
  • &{snProt} é uma variável do tipo String que precisa ser passada por referência e que após a execução da função receberá o número do protocolo de inutilização, se a inutilização for autorizada;
  • &{sdhRecbto} é uma variável do tipo String que precisa ser passada por referência e que após a execução da função receberá receberá a data e hora de inutilização no formato devolvido pela SEFAZ (yyyy-MM-ddThh:mm:ss), se a inutilização for autorizada;
  • &{sMotivo} é uma variável do tipo String que precisa ser passada por referência. Este parâmetro é legado e não é mais usado. Era um parâmetro usado na versão 1.0, mas perdeu sua função e foi mantido apenas para evitar que os desenvolvedores tivessem que alterar a chamada da função ao migrar da versão 1.0 para a versão 2.0;
  • &{scStat} é uma variável do tipo String que precisa ser passada por referência e que após a execução da função receberá o código cStat do Web Service. Consulte o manual de orientação do contribuinte para a lista completa de códigos cStat que podem ser devolvidos pelo Web Service;
  • {bExibeErro} é usado para indicar se a função deve exibir ou não os erros que ocorrerem na execução;
  • {sDiretorioXML} é um parâmetro opcional. Se for informado um caminho válido, o arquivo XML de retorno da inutilização será salvo neste local. Este parâmetro está disponível a partir da versão 2017/01 da NFeLibrary.
  • {iRet} é o código do retorno da chamada da função. 0 (zero) indica que a inutilização foi autorizada. Qualquer valor diferente de 0 (zero) indica que houve erro na solicitação de inutilização.

Exemplo

No momento a Workspace de Exemplo não contém uma demonstração de uso desta função.

Observações

  • Esta funcionalidade pode ser utilizada sem qualquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento ou registro. Entre em contato para mais informações;
  • A inutilização de numeração só é usada se o sistema, por alguma falha operacional ou de programação, permitir o salto de numeração;
  • Note que o envio da NF-e para o SEFAZ não precisa ser feito na ordem da numeração, ou seja, desde que não "vire o dia", é possível utilizar um número "pulado";
  • É extremamente importante que sejam feitas as devidas travas no sistema para impedir o salto de numeração, de forma que esta função seja utiliza somente em casos extremos.

 

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