- 12.8. Distribuição de DF-e
12.8.3. Consulta NF-e por Chave - 12.8.2. Consulta DF-e por NSU
« Anterior - 12.9. Consulta GTIN
Próximo »
12.8.3. Consulta NF-e por Chave [12-08-22]
Download do XML da NF-e pela chave de acesso.
ALERTA SOBRE O USO DA FUNCIONALIDADE
LIMITAÇÃO DE USO APÓS NT 2014.002 V1.12 de 09/03/2022
A versão 1.12 da NT 2014.002 implementou regras de USO INDEVIDO dos serviços de download de NF-e.
Veja o AVISO sobre a Atualização das regras de Uso do Web Service NFeDistribuiçãoDFe - NT 2014.002 para maiores detalhes das alterações.
Quantidade máxima de consulta por hora
Existe o limite de 20 consultas por hora, a consulta execedente provocará a rejeição "656 - Rejeição : Consumo indevido - ultrapassou o limite de 20 consultas por hora".
CONSUMO INDEVIDO - consequências
A ocorrência da rejeição "656 - Rejeição : Consumo indevido - ultrapassou o limite de 20 consultas por hora" provoca o BLOQUEIO do CNPJ/CPF do interessado por uma hora, impedindo a realização de consultas neste período.
O desbloqueio é automático, mas é necessário aguardar o intervalo de tempo de uma hora, toda consulta realizada durante o período de bloqueio provoca o reínicio da contagem do tempo de bloqueio e pode provocar um loop infinito de consumo indevido no caso do usuário não aguardar o decurso do prazo de uma hora para realizar uma nova consulta.USO DA FUNCIONALIDADE
O uso desta funcionalidade NÃO É RECOMENDADA em razão das limitação acima citadas e pela necessidade do prévio conhecimento da chave de acesso da NF-e.
A funcionalidade mais adequada para obter os DF-e é o distNSU que permite a obtenção de todos os documentos fiscais que são disponiibilizados para o interessado DISPENSANDO O USO DA CONSULTA DF-e por chave de acesso da NF-e.
Assinatura
string consChNFe(string siglaWS, int tipoAmbiente, string nomeCertificado, string versao, out string msgDados, out string msgRetWS, out int cStat, out string msgResultado, string CNPJ, string chaveNFe, out string verAplic, out string NSUXML, out string schemaXML, string proxy, string usuario, string senha, string licenca);
Descrição:
Download do XML da NF-e pela chave de acesso. o Web Service retorna o XML da NF-e para o destinatário, transportador e ao terceior cujo CNPJ esteja informados na tag autXML da NF-e.
Caso a consulta seja realizada pelo destinatário o Ambiente Nacional irá verificar a existência de sua manifestação (“Ciência da Operação”, “Operação não Realizada” ou “Confirmação de Operação”). Em caso da existência da manifestação do destinatário a NF-e será retornada para o destinatário. Caso contrário, será retornado apenas o resumo da NF-e. Com o resumo o destinatário terá as informações necessárias para realizar a manifestação.
Para transportador e terceiros a NF-e estará disponível integralmente na consulta. Para o emitente a NF-e não será disponibilizada nesta consulta.
Assim como nas demais consultas disponibilizadas pelo Web Service NFeDistribuicaoDFe, a consulta por chave de acesso estará disponível para documentos recebidos pelo Ambiente Nacional nos últimos 90 dias. Após este período não será possível recuperar a NF-e.
Preenchimento da siglaWS
AN - O WS do Ambiente Nacional (AN) atende qualquer UF.
Preenchimento do nomeCertificado
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 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 |
|---|---|---|---|
| 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". (novas opções) |
| 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. [26-08-18] |
| chaveNFe | string | entrada | informar a chave da NF-e que deseja consultar (obter o XML). |
| verAplic | string | saída | retorna a versão da aplicação do Web Service. |
| 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 |
| 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 https, a porta padrão do https é 443, 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 licenca de uso ou registro, esta funcionalidade pode ser utilizada sem qualquer 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 |
Retorno:
A chamada devolve uma string com o XML do documento consultado, caso a NF-e esteja disponível.
- 12.8.3. Consulta NF-e por Chave
12.8. Distribuição de DF-e - « Anterior
12.8.2. Consulta DF-e por NSU - Próximo »
12.9. Consulta GTIN