NFSeConsultarNFeRecebidasSP

A função NFSeConsultarNFeRecebidasSP é utilizada para buscar o XML da NFS-e emitidas para o CNPJ/CPF consultado.

Esta função é de uso exclusivo para o município de São Paulo.

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

Move (NFSeConsultarNFeRecebidasSP(&{vParams})) to {bOk}

Onde:

  • &{vParams} é uma variável do tipo tNFSeConsultarNFeRecebidasSPParam e é passada por referência contendo os parâmetros para execução da função e possui também algumas propriedades de retorno, conforme abaixo:
    • sVersaoXml: versão do XML utilizado no envio. Caso não informado será utilizado a versão "1";
    • sCnpjCpfRemetente: CPF ou CNPJ do remetente autorizado a realizar a consulta;
    • sCnpjCpfTomadorEmissor: CPF ou CNPJ do do tomador do serviço;
    • sInscrMunicTomadorPrestador: (opcional) inscrição municipal do tomador. Este parâmetro só deverá ser preenchido com a inscrição de contribuintes estabelecidos no município de São Paulo (CCM);
    • sDtInicio: data de início da consulta. O intervalo máximo permitido entre a data de início e de final, é de 31 dias;
    • sDtFim: data de final da consulta. O intervalo máximo permitido entre a data de início e final, é de 31 dias;
    • iPagina: número da página que deseja consultar. A cada consulta o webservice retorna até 50 XML’s. Caso o webservice retorne 50 XML’s é necessário realizar uma nova consulta, alterando o parâmetro iPagina para iPagina + 1 até que a quantidade retornada seja inferior a 50. Para saber a quantidade de XML’s retornados, verifique o tamanho do parâmetro sRetNFes;
    • sLicenca: chave da DLL que será verificada para permitir a consulta em ambiente de produção;
    • icStat: código numérico que representa o retorno da consulta realizada, podendo ser o código de retorno da DLL ou o código de retorno da consulta feita na SEFAZ;
    • sRetMsgResultado: texto contendo a mensagem de retorno de acordo com icStat;
    • sRetNFes: (String[]), retorna os XML’s das NF-e’s disponibilizadas pela SEFAZ;
    • vRetAlertas: (tNFSeConsultarNFeRecebidasSPRetorno[]), retorna alertas referentes a NF-e e/ou RPS.
    • vRetErros: (tNFSeConsultarNFeRecebidasSPRetorno[]), retorna erros referentes a NF-e e/ou RPS.
    • bExibeErro: indica se as mensagens de erro do processo devem ser mostradas (TRUE) ou não (FALSE);
  • {bRet} é uma variável do tipo Boolean onde True indica que a comunicação com o Web Service foi feita com sucesso. Para saber o resultado do processamento é necessário analisar os demais valores devolvidos nos parâmetros passados por referência.

Exemplo

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

Observação

A função está disponível a partir da versão 2022/01 da NFSeLibrary.