11. Web Services v2.0 [19-03-12]
11.6. ConsultaLoteRPS
11.5. SubstituirNFSe
« Anterior
11.7. ConsultarNFSeRPS
Próximo »

11.6. ConsultaLoteRPS

Consulta Lote de RPS da versão 2.0 da ABRASF, as chamadas devem ser utilizadas somente nas cidades que já oferecem a nova versão.

Implementação da versão 2.0 da recomendação ABRASF

Somente algumas cidades já adotaram a versão 2.0 da recomendação ABRASF, assim consulte a documentação da prefeitura ou do provedor de solução. Nem todas as funcionalidades são oferecidas pelas cidades.

Assinatura

string ConsultaLoteRPS_v2(string cMunicipio, string nomeCertificado, int tipoAmbiente, string versao, out string msgDados, out int cResultado, out string msgResultado, string CNPJPrestador, string IMPrestador, string protocolo, out string situacao, out string listaNFSe, out string listaMensagemAlertaRetorno, out string listaMensagemRetorno, out string listaMensagemRetornoLote, out string SoapMsgTx, out string SoapMsgRx, string proxy, string usuario, string senha, string licenca)

Descrição:

Esse serviço permite ao contribuinte obter as NFS-e que foram geradas a partir do Lote de RPS enviado, quando o processamento ocorrer sem problemas; ou obter a lista de erros e/ou inconsistências encontradas no Lote de RPS enviado.

Na validação do lote, são retornados todos os erros verificados. Excepcionalmente, havendo uma excessiva quantidade de erros, poderá ser definido um limitador para a quantidade de erros retornados.

Preenchimento do nomeCertificado

informar o Nome do titular (campo Assunto) do certificado digital a ser utlizado na conexão SSL. Ex.: "CN=NFe - Associacao NF-e:99999090910270, C=BR, L=PORTO ALEGRE, O=Teste Projeto NFe RS, OU=Teste Projeto NFe RS, S=RS"

Opções disponíveis:

1. uso de certificado digital existente no repositório MY do CSP do usuário corrente (currentuser)
É a forma de mais comum de uso, cabe resssltar que é a única forma de uso de certificado digital do tipo A3 que a DLL oferece.
O usuário deve passar como parâmetro o campo assunto do certificado no parâmetro NomeCertificado para que a DLL localize um certificado digital com mesmo assunto no repositório MY do currentuser do equipamento.
Esta forma de uso requer a prévia instalação do certificado digital na conta do usuário do Windows (logon) que irá utilizar o certificado digital.

2. uso de certificado digital em arquivo no formato pfx
Permite o de uso de certificado digital em arquivo formato pfx.
O caminho da localização (path) do arquivo pfx deve ser passado para a DLL no formato: ARQUIVO | [nome do arquivo pfx com caminho completo] | [senha do arquivo] no parâmetro NomeCertificado, ex.: "ARQUIVO|c:\certificado.pfx|senha".
Esta opção só funciona com certificado digital do tipo A1.

3. uso de certificado digital em string base64
Permite uso o arquivo do certificado digital em formato pfx convertido em uma string base64. O certificado digital em string base64 deve ser passado para a DLL no formato: CERTIFICADO | [string base64 do arquivo pfx] | [senha do arquivo] no parâmetro NomeCertificado, ex.: "CERTIFICADO|MIIGoDCCBYigAwIBAgIQep(arquivo pfx do certificado digital convertido em base64...)QQDExNBQy|senha".
Esta opção só funciona com certificado digital do tipo A1. É uma opção de uso que oferece maior versatilidade, pois permite o armazenamento do certificado digital em banco de dados na aplicação. É a forma mais indicada para uso em ASP.NET.


Parâmetros:

nome tipo fluxo descrição
cMunicipio string entrada informar o código do IBGE do Município para o qual será enviado o lote de RPS
NomeCertificado string entrada informar o certificado digital que será utilizado na conexão SSL:
1. informar o assunto do certificado digital que deve existir no repositório MY do current user, ex.: "CN=NFe - Associacao NF-e:99999090910270, C=BR, L=PORTO ALEGRE, O=Teste Projeto NFe RS, OU=Teste Projeto NFe RS, S=RS".
2. informar: ARQUIVO | [nome do arquivo pfx com caminho completo] | [senha do arquivo] para uso do certificado digital em arquivo pfx, ex.: "ARQUIVO|c:\certificado.pfx|senha".
3. informar: CERTIFICADO | [string base64 do arquivo pfx] | [senha do arquivo] no parâmetro NomeCertificado para passar uma string contendo um certificado digital em base64, ex.:"CERTIFICADO|MIIGoDCCBYigAwIBAgIQep(arquivo pfx do certificado digital convertido em base64...)QQDExNBQy|senha".
(novas opções)
tipoAmbiente inteiro entrada inrformar o ambiente de envio: 1 - produção e 2 - homologação
versao string entrada informar o versão do XML.
msgDados string saída retorna a mensagem XML do pedido de consulta lote por RPS enviada para o WS.
cResultado inteiro saída retorna o resultado da chamada do WS.
msgResultado string saída retorna a literal do resultado da chamada do WS
CNPJPrestador string entrada informar o CNPJ do prestador do serviço.
IMPrestador string entrada informar a Inscrição Municipal do prestador do serviço.
Obs: Informar o idEntidade para municípios com provedor Equiplano
protocolo string entrada informar o número do protocolo de recebimento do lote recebido no EnviaLoteRPS
informar o número do lote nas prefeituras que adotam o padrão DSF e na prefeitura de São Paulo, este número do lote é o numeroLote recebido no EnviaLoteRPS.
situacao string saída retorna a situacao do lote consultado: Código de situação de lote de RPS:
1 – Não Recebido
2 – Não Processado
3 – Processado com Erro
4 – Processado com Sucesso
listaNFSe string saída retorna a lista de NFSe convertidas
listaMensagemRetorno string saída retorna as mensagens de erro ocorridas na chamada do WS
listaMensagemAlertaRetorno string saída retorna as mensagens de Alerta da NFSe geradas
listaMensagemRetornoLote string saída retorna as mensagens de erro do ocorridadas no Lote de RPS
SoapMsgTx string saída retorna a mensagem SOAP transmitida ao WS
SoapMsgRx string saída retorna a mensagem SOAP recebida do WS
proxy string entrada informar 'http://proxyserver:port' quando existir uso de proxy no ambiente. verificar com o cliente qual é o endereço do servidor proxy e a porta utilizada proxy, assim teríamos algo do tipo 'http://192.168.15.1:443'
usuario string entrada informar o usuário para autenticação no proxy se necessário
senha string entrada informar a senha de autenticação no proxy se necessário
licenca string entrada informar a chave da licença de uso, esta funcionalidade pode ser utilizada sem quaquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento, para maiores detalhes veja as condições de uso

Tratamento das mensagens de retorno

O WS devolve as informações em uma mensagem XML no padrão ConsultarLoteRpsResposta, a DLL pega algumas informações que julga importante e devolve nos parâmetros de retorno para facilitar a vida do usuário. Todos os WS devolvem uma lista de mensagem de erro e alerta com o código de identificação da mensagem de erro, a descrição do erro e a correção sugerida, estas informações são extraída da resposta do WS pela DLL e devolvidas nos parâmetro listaMensagemRetorno, listaMensagemRetornoLote, *listaMensagemAlertaRetorno separada pelo caractere pipe (|).

Exemplo de mensagem XML de retorno do WS


<ConsultarLoteRpsResposta  xmlns="http://nfse.goiania.go.gov.br/xsd/nfse_gyn_v02.xsd">
   <ListaMensagemRetorno>
     <MensagemRetorno>
         <Codigo>E45</Codigo>
         <Mensagem>CNPJ não encontrado na base de dados</Mensagem>
         <Correcao>Confira o numero do CNPJ informado. Caso esteja correto, o prestador não está inscrito no município.</Correcao>
     </MensagemRetorno>
   </ListaMensagemRetorno>
</ConsultarLoteRpsResposta>

conteúdo do parâmetro listaMensagemRetorno do WS

E45|CNPJ não encontrado na base de dados|Confira o numero do CNPJ informado. Caso esteja correto, o prestador não está inscrito no município.

Retorno:

O resultado da chamada do ConsultaLoteRPS_v2 é o XML de resposta do WS.

O parâmetro cResultado retorna um código numérico com os seguintes significados:

código Mensagem origem regra
5000 Web Service consumido com sucesso, analise a mensagem de resposta do Web Service. DLL -
5001 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: o certificado cliente: 1.não é ICP-Brasil; 2.fora do prazo de validade; 3.revogado; 4.certificado cliente não confiável para o Web Service acessado, contatar a SEFAZ) DLL -
5002 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: a cadeia de certificação do Web Service acessado ou do certificado cliente inexistente no repositório de certificados do usuário corrente do Windows) DLL -
5003 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: serviço inexistente, verifique se o nome do serviço da url acessada está correto no arquivo wsNFSE_v2.xml) DLL -
5004 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: método não permitido) DLL -
5005 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: a url não encontrada, verifique se o nome do domínio da url acessada está correto no arquivo wsNFSE_v2.xml) DLL -
5006 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: Time-Out, o WS não respondeu a solicitação no tempo estabelecido: [{1:0}]) DLL -
5007 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: mensagem maior que a permitida) DLL -
5008 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: Servidor com problemas) DLL -
5009 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: Serviço não implementado) DLL -
5010 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: Serviço temporariamente indisponível, servidor sem recursos para atender a solicitação) DLL -
5011 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: Causa provável da falha na conexão: Rede indisponível) DLL -
5012 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: Versão do SOAP não suportada DLL -
5013 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: Web Service não consumido, não houve nenhum retorno ou resposta) DLL -
5014 Erro: Falha na conexão: [MENSAGEM DO WINDOWS] (Causa provável: Web Service não consumido, falha desconhecida) DLL -
5015 Erro: Falha na conexão: Tempo limite de time-out alcançado [tempo limite ms] - [MENSAGEM DO WINDOWS] DLL -
5016 Erro: Falha na conexão: Falha da Biblioteca Criptografica: [MENSAGEM DO WINDOWS] DLL -
5017 Erro: Falha ao tratar o XML de retorno do WS: [MENSAGEM DO WINDOWS] DLL -
5018 Erro: Web Service não devolveu nehuma mensagem de resposta. DLL -
5019 Erro: O município: [cMunicipio informado] não oferece o WS: [Nome WS]. DLL -
5020 Erro: A mensagem XML é inválida - [MENSAGEM DO WINDOWS]. DLL -
5101 Erro: A mensagem de retorno do WS não é um XML válido: [MENSAGEM DO WINDOWS] DLL -
5102 Erro: Tag cStat inexistente na mensagem de retorno [MENSAGEM DO WINDOWS] DLL -
5103 Erro: Tag xMotivo inexistente na mensagem de retorno [MENSAGEM DO WINDOWS] DLL -
5104 Erro: Tag [nome da tag] inexistente na mensagem de retorno [MENSAGEM DO WINDOWS] DLL -
5105 Erro: O WS não devolveu nenhum resultado DLL -
5201 Erro: O código do tipo de ambiente [valor recebido pela DLL] informado diferente de 1 - produção e 2 - homologação DLL -
5202 Erro: Ocorreu um erro de validação do XML do arquivo wsNFSE_v2.xml: [MENSAGEM DO WINDOWS] DLL -
5203 Erro: Inexiste url para o município [cMunicipio informado] informada no ambiente [ambiente informado] desejado, verifique se existe atualização do arquivo wsNFSE_v2.xml disponível. DLL -
5204 Erro: Arquivo wsNFSE_v2.xml com a URL do WS não localizado em {path da pasta} DLL -
5205 Erro: Ocorreu um erro inesperado no processamento da URL do município [cMunicipio informado] : [MENSAGEM DO WINDOWS] DLL -
5601 Erro: O parâmetro cMuncipio não foi informado DLL -
5602 Erro: A DLL ainda não foi customizada para o município: [cMunicipio informado], contate a FlexDocs para verificar a possibilidade de customizar a DLL para o município desejado pelo canal www.flexdocs.com.br/suporte DLL -
5603 Erro: O código do Município do parâmetro cMunicipio: [cMunicipio informado] é inválido. DLL -
5604 Erro: O DV do parâmetro cMunicipio: [cMunicipio informado] é inválido. DLL -
5605 Erro: O parâmetro CNPJPrestador não foi informado. DLL -
5606 Erro: O parâmetro CNPJPrestador: [CNPJ informado] não é um CNPJ válido. DLL -
5701 Erro: O lote não é um XML válido: [MENSAGEM DO WINDOWS] DLL -
5702 Erro: A tag Cnpj do lote não localizado:[MENSAGEM DO WINDOWS] DLL -
5703 Erro: Falha ao acessar o conteúdo da tag Cnpj DLL -
7001 Erro: O CNPJ não foi informado.
7002 Erro: O CNPJ informado: [CNPJ informado] tem tamanho diferente de 14 [tamanho do CNPJ informado]
7003 Erro: A licença não foi informada ou tem tamanho = 0.
7004 Erro: A licença informada: [licenca informada] tem tamanho diferente de 128:[licenca informada]
7005 Erro: A licença informada: [licenca informada] não pertence ao CNPJ:[CNPJ informado]
7006 Erro: O tipo de ambiente informado: [tipo ambiente informado] é inválido.

Os erros com código > 5000 são erros tratados pela DLL e ocorrem nas seguintes situações:

Histórico de atualização:

11.6. ConsultaLoteRPS
11. Web Services v2.0 [19-03-12]
« Anterior
11.5. SubstituirNFSe
Próximo »
11.7. ConsultarNFSeRPS