Para realizar a consulta a um XML de uma NFS-e ou RPS podemos utilizar três métodos disponíveis na interface do Manager Client, são eles:

• ConsultarXmlNFSePorHandle
• ConsultarXmlNFSePorNumero
• ConsultarXmlNFSePorRPS

 

Todos utilizam a mesma interface de retorno. Seguem abaixo os detalhes dos métodos e de seus retornos.

 

 

Detalhes ConsultarXmlNFSePorHandle

 

Função:  Realiza a consulta do XML de uma NFS-e utilizando o identificador do registro no banco de dados do Manager SaaS/EDoc. 
Classe:  TspdNFSeClientX
Método:  ConsultarXmlNFSePorHandle
Tipo Retorno: spdRetConsultaXmlNFSe

Parâmetros aceitos:

 

Nome	Tipo	Obrigatório	Valor
aHandle	Texto	Sim	Número do identificador único da NFS-e no banco de dados do Manager SaaS/EDoc. Observação: o handle é informado no retorno do envio do RPS.

 

 

 

Detalhes ConsultarXmlNFSePorNumero

 

Função:  Realiza a consulta do XML de uma NFS-e através do número da NFS-e (fornecido após a prefeitura autorizar o RPS).
Classe:  TspdNFSeClientX
Método:  ConsultarXmlNFSePorNumero
Tipo Retorno: spdRetConsultaXmlNFSe

Parâmetros aceitos:

 

Nome	Tipo	Obrigatório	Valor
aNumNFSe	Texto	Sim	Número da NFS-e autorizada retornado pelo WebService da prefeitura.

 

 

 

Detalhes ConsultarXmlNFSePorRPS

 

Função:  Realiza a consulta do XML de uma NFS-e através dos dados do RPS.
Classe:  TspdNFSeClientX
Método:  ConsultarXmlNFSePorRPS
Tipo Retorno: spdRetConsultaXmlNFSe

Parâmetros aceitos:

 

Nome	Tipo	Obrigatório	Valor
aNumRPS	Texto	Sim	Número do RPS enviado ao WebService da prefeitura.
aSerieRPS	Texto	Sim	Série do RPS.
aTipoRPS	Texto	Sim	Tipo do RPS enviado. Exemplos: 1 - RPS (Padrão) 2 - Nota Fiscal Conjugada (Mista) 3 - Cupom

 

 

Delphi

 

procedure TfrmExemplo.btnConsultarXmlNFSePorHandleClick(Sender: TObject);
var
   _Retorno: spdRetConsultaXmlNFSe;
   _Handle: string;
begin
   if not InputQuery('Handle', 'Handle da Nota:', _Handle) then exit;
   //Esse método consulta o xml da nota através do Componente Manager Client
   _Retorno := NFSe.ConsultarXmlNFSePorHandle(_Handle);
  
   //Exibe o retorno no memo
   memoRetorno.Clear;
   if _Retorno.Status = Sucesso then
     memoRetorno.Lines.Add('XML: ' + _Retorno.Xml)
   else
     memoRetorno.Lines.Add('Erro: ' + _Retorno.NomeExcecao + ', ' + _Retorno.Mensagem);
end;

 

No exemplo acima utilizamos o método ConsultarXmlNFSePorHandle, mas o processo e o tipo de retorno é exatamente o mesmo para os demais métodos, bastando trocar a linha do exemplo onde o _Retorno recebe seu valor.

 

Para o método ConsultarXmlNFSePorNumero:

    //Esse método consulta o xml da nota através do Componente Manager Client
   _Retorno := NFSe.ConsultarXmlNFSePorNumero(_NumeroNFSe); 

 

Para o método ConsultarXmlNFSePorRPS:

    //Esse método consulta o xml da nota através do Componente Manager Client
   _Retorno := NFSe.ConsultarXmlNFSePorRPS(_NumRPS,_SerieRPS,_TipoRPS); 

 

 

C#

 

private void ConsultarXmlNFSe_Click(object sender, EventArgs e)
{
  spdRetConsultaXmlNFSe Retorno = null; 
  string Handle= InputBox("Handle da Nota", "Handle da Nota:", "");
  if (Handle != "")
  {
     //Esse método consulta o xml da NFSe através do Componente Manager Client
     Retorno = NFSe.ConsultarXmlNFSePorHandle(Handle);

     //Exibe o retorno do memo
     if (Retorno.Status == spdManagerClientX.TStatus.Sucesso)
        memoRetorno.Text = "XML: " + Retorno.Xml + "\n";
     else
        memoRetorno.Text = "Erro: " + Retorno.NomeExcecao + ", " + Retorno.Mensagem;
  } 
}

 

Para o método ConsultarXmlNFSePorNumero:

   //Esse método consulta o xml da NFSe através do Componente Manager Client
   Retorno = NFSe.ConsultarXmlNFSePorNumero(NumeroNFSe); 

 

Para o método ConsultarXmlNFSePorRPS:

   //Esse método consulta o xml da NFSe através do Componente Manager Client
   Retorno = NFSe.ConsultarXmlNFSePorRPS(_NumRPS,_SerieRPS,_TipoRPS); 

 

 

Visual Basic 6

 

Private Sub btnConsultarXmlNFSe_Click()
  Dim Retorno As spdRetConsultaXmlNFSe
  Dim Handle As String

  Chave = InputBox("Handle da Nota:", "Handle da Nota", "")

  'Esse método consulta o xml da NFSe através do Componente Manager Client
   Set Retorno = NFSe.ConsultarXmlNFSePorHandle(Handle)

  'Exibe o retorno do memo
   If Retorno.Status = Sucesso Then
     memoRetorno.Text = "XML: " + Retorno.Xml + vbCrLf
   Else
     memoRetorno.Text = "Erro: " + Retorno.NomeExcecao + ", " + Retorno.Mensagem
   End If
End Sub

 

Para o método ConsultarXmlNFSPorNumero:

   'Esse método consulta o xml da NFSe através do Componente Manager Client
    Set Retorno = NFSe.ConsultarXmlNFSePorNumero(NumeroNFSe)

 

Para o método ConsultarXmlNFSPorRPS:

   'Esse método consulta o xml da NFSe através do Componente Manager Client
    Set Retorno = NFSe.ConsultarXmlNFSePorRPS(NumRPS,SerieRPS,TipoRPS)

 

 

Retorno

 

O tipo spdRetConsultaXmlNFSe possui os seguintes campos:

 

 

Campo	Tipo	Descrição
Status	Constante	Retorna o status da operação: Sucesso ou Erro.
NomeExcecao	Texto	Em caso de erro retorna a classe da Exception.
Mensagem	Texto	Retorna a descrição da resposta do servidor.
Xml	Texto	Retorna o XML completo da NFS-e.