NFSeCancelarNFSeSigissWeb

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

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

Move (NFSeCancelarNFSeSigissWeb(&{vParam})) to {bRet}

Onde:

  • &{vParams} é uma variável do tipo tNFSeCancelarNFSeSigissWeb. Deve ser passada por referência. Contém os parâmetros para execução da função e também retornos, conforme abaixo:
    • iTpAmbiente: indica o ambiente para onde o XML será enviado, sendo 1-Produção e 2-Homologação;
    • sCNPJ: é o número do CNPJ do prestador, que deverá ser informado sem espaços e caracteres separadores;
    • icMunicipio: é o código do IBGE do município do prestador do serviço que está cancelando a NFS-e;
    • iNotaFiscal: é o número da NFS-e que se deseja cancelar;
    • sSerie: é o número de série da NFS-e que se deseja cancelar;
    • sMotivo: é o motivo do cancelamento da NFS-e. Deve ter no mínimo 15 dígitos;
    • sSenha: é a senha, fornecida pela prefeitura, para acessar o Web Service;
    • sUsuario: é o usuário que será autenticado no servidor proxy para realizar a consulta;
    • sSenhaProxy: é a senha do usuário que será autenticado no servidor proxy para realizar o cancelamento;
    • sProxy: é o endereço do servidor proxy que deve ser usado para realizar o cancelamento;
    • sChLicenca: é usado para informar a chave da licença de uso quando a função é utilizada em ambiente de produção;
    • bExibeErro: indica se as mensagens de erro devem ser mostradas (TRUE) ou não (FALSE);
    • sRetMensagem: retorna texto contendo a mensagem de retorno de acordo com iRetCdRetorno;
    • iRetCdRetorno: retorna o código numérico que representa o retorno da consulta realizada.
  • {bRet} é o retorno da execução da função, sendo que True indica que o cancelamento foi bem-sucedida e False se houve um erro, e neste caso analise os retornos de sRetMensagem.

Observação

  • A função está disponível a partir da versão 2025/01 da NFSeLibrary.
  • Função criada para atender os municípios que utilizam o provedor SigissWeb. Os municípios podem alterar o provedor a qualquer momento, assim como o layout do arquivo pode ser alterado pelo provedor.

 

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