NFBCancelar

A função NFBCancelar é usada para cancelar uma NFS-e autorizada.

Tipo de Retorno

Boolean

Pacote

A função NFBCancelar está definida dentro do pacote NFBCancelar.pkg.

Sintaxe

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

Onde:

• &{vParams} é uma variável do tipo tNFBCancelarParam. Deve ser passada por referência. Contém os parâmetros para execução da função e retornos, conforme abaixo:
  • iTpAmb: indica o ambiente que será consultado, sedo 1-produção ou 2-produção-retrita (antigo ambiente de homologação);
  • Certificado: é 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;
  • sChaveNFSe: é a chaver da NFS-em, com 50 dígitos, a qual deseja cancelar;
  • sVersaoAplic: é a versão da aplicação que está realizando a solicitação de cancelamento;
  • sDhEvento: é a data e hora do evento no formato AAAA-MM-DDThh:mm:ssTZD. Caso não seja informada, a NFBLibrary irá obter a data e hora da máquina que está processando a solicitação no momento do processamento;
  • sCNPJCPFAutor: é o CNPJ ou o CPF do autor da solicitação;
  • sVersaoXML: é a versão do XML enviado. Caso não informado será enviado como “1.01”;
  • sMotivoCancelamento: é a motivo que causou o cancelamento, com no mínimo 15 dígitos;
  • iCodMotivo: é o código do motivo do cancelamento;
  • sDirGravaXML: é o diretório onde o XML do evento será salvo caso processado com sucesso;
  • sProxy: é usado para informar o endereço do servidor proxy, se necessário. Por exemplo ’https://proxyserver:port’. Verificar 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 ’https://192.168.15.1:443’;
  • sUsuarioProxy: é usado para informar o usuário para autenticação no proxy, se necessário;
  • sSenhaProxy: é usado informar a senha de autenticação no proxy, se necessário;
  • bExibeErro: indica se as mensagens de erro devem ser mostradas (TRUE) ou não (FALSE);
  • sRetMsgDados: retorna o XML que foi enviado para o Web Service;
  • sRetMsgResultado: mensagem literar com o resultado da solicitação;
  • iCdRetorno: retorna o código informando se o Web Service foi consumido com sucesso. Nos casos em que a solicitação tenha sido feita com sucesso, o retorno é 0 (zero), caso contrário o Web Service não foi consumido. Mesmos que a função tenha consumido o Web Service com sucesso, é necessário consultar a estrutura vtErros para ver se não ocorreram erros;
  • vtRetorno é uma variável do tipo tNFBCancelarRetorno que contém a resposta do Web Service, conforma segue:
    • iTipoAmbiente: indica o ambiente que será consultado, sedo 1-produção ou 2-produção-retrita (antigo ambiente de homologação);
    • sDataHoraProcessamento: é a data e hora em que o processamento foi relizado pelo Web Service;
    • vtErros é uma array do tipo tNFBCancelarErros, que contém as informações referentes a erros ocorridos no processamento da solicitação conforme abaixo:
      • sCodigo: é o código do erro;
      • sDescricao: é a descrição do erro;
      • sComplemento: informação complementar, com orientação para resolver o erro.
• {bRet} é uma variável do tipo boolean que recebe o retorno da função, sendo que TRUE indica Web Service foi consumido com sucesso e FALSE indica que ocorreu algum erro.

Exemplo

Um exemplo de uso desta função pode ser encontrado dentro da Workspace de Exemplo na view DPS.vw.