Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-26125148541.3 KB
NFe Recebidas

Consultar

Quando a receita informa que uma nota fiscal foi emitida contra a empresa, recebemos apenas um resumo do xml da nota fiscal com os dados mais importantes. Caso a nota seja manifestada, recebemos um xml com todos os dados da nota. Da mesma forma, a receita poderá notificar quando a nota recebe uma carta de correção ou quando ela é cancelada.

Por isso as notas fiscais recebidas possuem um campo chamado "versao" que é único entre todos os documentos do mesmo CNPJ e que é atualizado a cada alteração nesta nota fiscal. 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.

Exemplo: Se você recebe uma nota fiscal, com versao = 60, e ela posteriormente receber uma carta de correção ou for cancelada, sua versão será atualizada para algum número maior que 60.

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/nfes_recebidas

Query parameters

cnpjstring required
Example:12345678000123

CNPJ da empresa recebedora

versaonumber
Example:1

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.

pendentenumber
Example:1

Lista apenas as notas que estão pendentes de manifestação final. São consideradas notas pendentes aquelas que não tem manifesto ou tem apenas manifesto de ciência (não havendo o manifesto final de operação de confirmação, desconhecimento ou operação não realizada)

pendente_ciencianumber
Example:1

Lista apenas as notas que não tem a operação de ciência registrada

Response

Requisição processada com sucesso

nome_emitentestring

Nome do emitente da nota fiscal

documento_emitentestring

CNPJ ou CPF do emitente da nota fiscal

cnpj_destinatariostring

CNPJ do destinatário da nota fiscal (o CNPJ de sua empresa)

chave_nfestring

Chave da NFe

valor_totalstring

Valor total da NFe

data_emissaostring date-time

Data e hora de emissão da NFe

situacao'autorizada' | 'cancelada' | 'denegada'

Situação da NFe

manifestacao_destinatario'nulo' | 'ciencia' | 'confirmacao' | 'desconhecimento' | 'nao_realizada'

Situação atual da manifestação do destinatário:

  • nulo: Se não houve manifestação ainda
  • ciencia: Se foi confirmada a ciência da operação
  • confirmacao: Se foi manifestado confirmação da operação
  • desconhecimento: Se foi manifestado desconhecimento da operação
  • nao_realizada: Se foi manifestado que operação é conhecida, porém por algum motivo não foi realizada
nfe_completastring

Se verdadeiro, indica que temos o XML completo da nota, caso contrário o sistema possui apenas o cabeçalho da nota

tipo_nfe'1' | '0'

Tipo da NFe:

  • 1: Saída
  • 0: Entrada
versaonumber

Versão da nota fiscal. Este número irá mudar apenas se a nota fiscal for alterada de alguma forma

digest_valuestring

Valor do resumo digital do XML da nota

numero_carta_correcaostring

Número sequencial da carta de correção, caso tenha sido emitida alguma

carta_correcaostring

Texto da carta de correção, caso tenha sido emitida alguma

data_carta_correcaostring date-time

Data da carta de correção, caso tenha sido emitida alguma

data_cancelamentostring date-time

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

justificativa_cancelamentostring

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

Example response

[
  {
    "nome_emitente": "EMPRESA FORNECEDORA LTDA",
    "documento_emitente": "123456780001233",
    "cnpj_destinatario": "123456780001234",
    "chave_nfe": "35122225222278000855550010000002821510931504",
    "valor_total": "100.00",
    "data_emissao": "2024-01-15T10:00:00-03:00",
    "situacao": "autorizada",
    "manifestacao_destinatario": "ciencia",
    "nfe_completa": "12345678000123",
    "tipo_nfe": "1",
    "versao": 73,
    "digest_value": "/C5IuK5fCNVQV2rbwV0d8W12zsk=",
    "numero_carta_correcao": "1",
    "carta_correcao": "Campo valor informado incorretamente. Onde lê-se R$ 100.00, deve ler-se R$ 100000,00.",
    "data_carta_correcao": "2024-01-15T10:00:00-03:00",
    "data_cancelamento": "2024-01-15T10:00:00-03:00",
    "justificativa_cancelamento": "Venda cancelada"
  }
]