Consultar

Quando a receita informa que uma nota fiscal foi emitida contra a empresa, recebemos o xml completo da nota fiscal.

As notas fiscais recebidas possuem um campo chamado "versao" que é único entre todos os documentos do mesmo CNPJ. Isto facilita a busca apenas dos documentos que seu sistema ainda não conhece, sendo necessário que você armazene apenas um número por CNPJ.

Este endpoint retorna as 100 primeiras notas encontradas. Para recuperar as demais notas você deverá fazer uma nova requisição alterando o parâmetro versao.

Para auxiliar o processo de consultar a API irá devolver os seguintes cabeçalhos HTTP:

  • X-Total-Count: O número total de registros (incluindo aqueles que não foram devolvidos pelo limite de 100 registros)
  • X-Max-Version: Valor máximo da versão dos documentos devolvidos. Utilize este cabeçalho para utilizar na próxima busca de versão, caso seja necessário.

Como retorno você receberá os campos descritos nos exemplos abaixo, de acordo com o status da nota.

Query Params
string
required

CNPJ da empresa recebedora

string

Se informado com o valor "1", devolve os dados completos do XML da nota. Caso contrário, devolve os dados resumidos de forma simplificada.

number

Busca apenas os documentos cuja versão seja maior que o parâmetro recebido. Utilize este parâmetro para buscar apenas as notas que seu sistema ainda não conhece.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html