Consultar as informações resumidas e documentos interesse da consulente.
string consNSU(string siglaWS, int tipoAmbiente, string nomeCertificado, string versao, out string msgDados, out string msgRetWS, out int cStat, out string msgResultado, string CNPJ, string cUF, string NSU, out string verAplic, out string dhResp, out string ultNSU, out string maxNSU, out string NSUXML, out string schemaXML, string proxy, string usuario, string senha, string licenca)
Consulta DF-e a partir do NSU informado, o Web Service retorna as informações resumidas ou documento fiscal vinculado ao NSU consultado.
Informar o Nome do titular (campo Assunto) do certificado digital a ser utilizado na conexão SSL, formas possí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 ressaltar 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 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.
| nome | tipo | fluxo | descrição |
|---|---|---|---|
| siglaWS | string | entrada | informar “AN” – o WS do Ambiente Nacional (AN) atende destinatário de qualquer UF. |
| tipoAmbiente | inteiro | entrada | informar o código do ambiente desejado: 1- produção ou 2-homologação |
| NomeCertificado | string | entrada | informar o certificado digital que será utilizado para assinatura: 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”. |
| versao | string | entrada | informar a versão da mensagem do WS: 4.00 |
| msgDados | string | saída | retorna a mensagem XML enviada para o WS |
| msgRetWS | string | saída | retorna a mensagem XML de resposta do WS |
| cStat | inteiro | saída | retorna o resultado da chamada do WS |
| msgResultado | string | saída | retorna a literal do resultado da chamada do WS |
| CNPJ | string | entrada | informar o CNPJ ou CPF do ator que se deseja consultar os documentos fiscais |
| cUF | string | entrada | informar o cUF |
| NSU | string | entrada | informar o NSU a partir do qual deseja realizar a consulta. |
| verAplic | string | saída | retorna a versão da aplicação do Web Service. |
| dhResp | string | saída | retorna a Data e hora da mensagem de Resposta. |
| ultNSU | string | saída | retorna o Último NSU pesquisado na Web Service. Se exisitrem mais NSU (maxNSU > ultNSU), o solicitante pode continuar a consulta a partir deste NSU para obter novos resultados. |
| maxNSU | string | saída | retorna Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado. |
| NSUXML | string | saída | retorna o NSU do documento consultado. |
| schemaXML | string | saída | retorna o Identificação do Schema XML que será utilizado para validar o XML consultado. Vai identificar o tipo do documento e sua versão. Exemplos: resNFe_v1.00.xsd procNFe_v3.10.xsd resEvento_1.00.xsd procEventoNFe_v1.00.xsd |
A chamada devolve uma string com o XML do documento consultado.