v1

latestOpenAPI 3.0.3Proprietary2026-07-26125148541.3 KB
NFSe Nacional Recebidas

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.

get/nfsens_recebidas

Query parameters

cnpjstring required
Example:12345678000123

CNPJ da empresa recebedora

completastring
Example:1

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

versaonumber
Example:123

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.

Response

Requisição processada com sucesso

nome_prestadorstring

Nome do emitente da nota fiscal

documento_prestadorstring

CNPJ ou CPF do emitente da nota fiscal

chave_nfsestring

Chave da NFSe

valor_totalstring

Valor total da NFSe

data_emissaostring date-time

Data e hora de emissão da NFSe

data_geracaostring date-time

Data e hora de geração da NFSe

situacao'autorizado' | 'cancelado' | 'substituido'

Situação da NFe

versaonumber

Versão da nota fiscal

data_cancelamentostring date-time

Data de cancelamento da nota fiscal, caso ela tenha sido cancelada

motivo_cancelamentostring

Justificativa de cancelamento da nota fiscal, caso ela tenha sido cancelada

chave_nfse_substitutastring

Chave da NFS-e substituta, caso ela tenha sido substituida