Consulta de NFC-e (consumer_invoice_query)
O recurso consumer_invoice_query consulta cupons fiscais NFC-e (CFe-SAT) já
emitidos, pela chave de acesso. Faz parte da família de dados nfe_query,
servida por nfe.api.nfe.io (/v1, caminho /coupon/).
Este recurso é distinto de consumer_invoices (emissão de NFC-e): host e
versão de API diferentes. Aqui apenas recuperamos e baixamos um cupom já
emitido.
data_api_keyEsta é uma família de dados: usa a data_api_key quando presente, com
fallback para a api_key. Configure data_api_key: (ou NFE_DATA_API_KEY).
Veja Configuração.
Métodos públicos
consumer_invoice_query.retrieve(access_key) # => Nfe::TaxCoupon
consumer_invoice_query.download_xml(access_key) # => String (bytes ASCII-8BIT)
Exemplos
Recuperar um cupom e baixar o XML
require "nfe"
client = Nfe::Client.new(
api_key: ENV.fetch("NFE_API_KEY"),
data_api_key: ENV.fetch("NFE_DATA_API_KEY")
)
chave = "35200114200166000187650010000000071234567890"
cupom = client.consumer_invoice_query.retrieve(chave)
xml = client.consumer_invoice_query.download_xml(chave)
File.binwrite("nfce.xml", xml)
A chave de acesso precisa ter 44 dígitos. Uma chave inválida levanta
Nfe::InvalidRequestError antes de qualquer requisição.
download_xml retorna bytes bináriosO retorno são os bytes do XML (ASCII-8BIT); grave com File.binwrite. Veja
o guia de Downloads.
Veja também
- Consulta de NF-e (product_invoice_query) — o equivalente para NF-e.
- Downloads — manipulação de XML binário.
- Configuração — modelo de duas chaves.