Consulta de NF-e (productInvoiceQuery)
$nfe->productInvoiceQuery consulta qualquer NF-e (emitida por você ou por
terceiros) pela chave de acesso de 44 dígitos. Recurso global (não
recebe $companyId), servido por nfe.api.nfe.io.
Este recurso é distinto de productInvoices (emissão).
É família de dados (nfe-query): usa a dataApiKey com fallback para
apiKey. Veja Configuração.
Métodos
| Método | Descrição | Retorno |
|---|---|---|
retrieve($accessKey) | Consulta a NF-e pela chave de acesso. | ProductInvoiceDetails |
downloadPdf($accessKey) | DANFE em PDF. | string (bytes crus) |
downloadXml($accessKey) | XML autorizado. | string |
listEvents($accessKey) | Eventos fiscais da nota. | array |
Consultar uma NF-e
$accessKey = '35260111222333000181550010000012341000012349'; // 44 dígitos
$detalhes = $nfe->productInvoiceQuery->retrieve($accessKey);
A chave precisa ter 44 dígitos numéricos — um valor fora do formato lança
Nfe\Exception\InvalidRequestException antes de qualquer requisição.
Baixar DANFE e XML
file_put_contents('danfe.pdf', $nfe->productInvoiceQuery->downloadPdf($accessKey));
file_put_contents('nfe.xml', $nfe->productInvoiceQuery->downloadXml($accessKey));
Listar os eventos fiscais
$eventos = $nfe->productInvoiceQuery->listEvents($accessKey);
// cancelamentos, cartas de correção, manifestações...
Veja também
- Consulta de cupons (CFe-SAT/NFC-e) — o equivalente para cupons.
- Notas de entrada — captura automática de NF-e contra o seu CNPJ.
- Downloads — o contrato de bytes crus.