NF-e JSON — referência de campos
Endpoint: GET /api/integration/dfe/nfe/inbound/documentos · Referência OpenAPI: NF-e Public API.
Documento de referência — Dicionário campo a campo do objeto
metadataretornado pelo endpoint de documentos NF-e inbound. O mesmo objeto, comprimido (Gzip+Base64), é o conteúdo do campojsonquandojson=true.
Endpoint: GET /api/integration/dfe/nfe/inbound/documentos · Referência OpenAPI: NF-e Public API.
Convenções deste documento
emissionDateParté a partição de data do documento (derivada dechNFe), não um instante — sai como string de data ISO (ex.:"2026-01-01"), sem hora. As demais datas de negócio/auditoria (dhEmi,createdAt,updatedAt) saem como epoch milliseconds UTC.dhRecbtosai no formato ISO com offset (não foi convertido para epoch millis).issuerTypesai como o nome do enum ("INBOUND"/"OUTBOUND"), não o código numérico interno. Sempre"INBOUND"nesta listagem.- ⚠️ O CNPJ/CPF do emitente é publicado no campo
cnpjcpf(tudo minúsculo) — atenção: o filtro de request correspondente chama-secnpjCpf(camelCase). São nomes diferentes; um cliente que lercnpjCpfna resposta recebenull. externalIdexiste no modelo mas é omitido quando null; em documentos inbound é sempre null, então não aparece.statusMdeé o status da manifestação do destinatário (específico da NF-e — ver seção 3).
1. Campos
| Campo | Tipo | Descrição |
|---|---|---|
emissionDatePart | string (ISO date) | Partição de data do documento (derivada de chNFe), não um instante. Formato de data, sem hora. |
id | UUID | Identificador interno do registro do documento. |
customerId | UUID | Tenant proprietário do registro. |
companyId | UUID | Empresa (do tenant) que é parte da NF-e para este item — ver "Multiplicidade por empresa" na página do fluxo de listagem. |
issuerType | string | "INBOUND" (recebido) ou "OUTBOUND" (emitido pelo tenant). Sempre "INBOUND" nesta listagem. |
dhEmi | long (epoch ms) | Data/hora de emissão da NF-e. |
tpNF | string | Tipo da operação: "0" (entrada) ou "1" (saída), do ponto de vista do emitente. |
tpEmis | string | Forma de emissão (normal, contingência, etc.). |
chNFe | string (44) | Chave de acesso da NF-e — chave de correlação com os eventos (ver Reconciliação de documentos e eventos NF-e inbound). |
nNF | string | Número da NF-e. |
serie | int | Série da NF-e. |
mod | string | Modelo do documento: sempre "55" nesta listagem. |
vNF | decimal | Valor total da NF-e. |
xNome | string | Nome/razão social do emitente. |
cStat | long, nullable | Código de status de retorno da SEFAZ (ex.: 100 = autorizado). |
xMotivo | string, nullable | Motivo/mensagem do protocolo SEFAZ. |
nProt | long, nullable | Número do protocolo de autorização SEFAZ. |
dhRecbto | string (ISO datetime com offset), nullable | Data/hora de recebimento pela SEFAZ. |
status | string | Código de status interno do ciclo de vida (ver seção 2). |
statusMde | string, nullable | Status da manifestação do destinatário (ver seção 3). Específico da NF-e. |
createdAt | long (epoch ms) | Quando o registro foi persistido no MI. Campo de ordenação/keyset da paginação. |
updatedAt | long (epoch ms) | Última atualização do registro. |
cnpjcpf | string | CNPJ/CPF do emitente do documento. Nome do campo em minúsculo (ver Convenções); o filtro correspondente na requisição chama-se cnpjCpf. |
printed | boolean | Indica se o DANFE já foi gerado/impresso pelo MI. Específico da NF-e. |
cancelled | boolean | Derivado de status — ver seção 2. |
transmitted | boolean | Derivado de status — ver seção 2. |
inProgress | boolean | Derivado de status — ver seção 2. |
authorized | boolean | Derivado de status — ver seção 2. |
2. Códigos de status e os booleans derivados
status é o código interno do ciclo de vida do documento no MI (não confundir com cStat, que é o código de retorno da SEFAZ):
| Código | Significado |
|---|---|
0 | Não processado |
1 | Importado |
2 | Em processamento |
3 | Aguardando confirmação de recebimento |
4 | Erro / abortado |
5 | Autorizado |
6 | Denegado |
7 | Cancelado |
8 | Não utilizado |
9 | Encerrado |
Os quatro booleans do item são derivados desse código:
| Boolean | Regra |
|---|---|
authorized | status == "5" |
cancelled | status == "7" |
inProgress | status em {"2", "3"} |
transmitted | status em {"5", "6", "7", "8"} — qualquer resultado final devolvido pela SEFAZ (autorizado, denegado, cancelado ou não utilizado), em contraste com pendente/erro. |
3. Códigos de statusMde (manifestação do destinatário)
Reflete a última manifestação registrada pelo destinatário para o documento. Os eventos de manifestação em si aparecem no endpoint de eventos.
| Código | Manifestação |
|---|---|
0 | Sem manifestação |
1 | Ciência da Operação (tpEvento 210210) |
2 | Confirmação da Operação (210200) |
3 | Desconhecimento da Operação (210220) |
4 | Operação não Realizada (210240) |
4. Exemplo
{
"emissionDatePart": "2026-01-01",
"id": "0198c0de-0000-7000-8000-000000000003",
"customerId": "0198c0de-0000-7000-8000-000000000001",
"companyId": "0198c0de-0000-7000-8000-000000000002",
"issuerType": "INBOUND",
"dhEmi": 1768469400000,
"tpNF": "1",
"tpEmis": "1",
"chNFe": "35260111111111111111550010000000011000000015",
"nNF": "1",
"serie": 1,
"mod": "55",
"vNF": 1500.0,
"xNome": "Emitente Ltda",
"cStat": 100,
"xMotivo": "Autorizado o uso da NF-e",
"nProt": 135260000000001,
"dhRecbto": "2026-01-15T09:35:00-03:00",
"status": "5",
"statusMde": "1",
"createdAt": 1768478400000,
"updatedAt": 1768478700000,
"cnpjcpf": "11111111111111",
"printed": false,
"cancelled": false,
"transmitted": true,
"inProgress": false,
"authorized": true
}