Machine translation, not yet reviewed.
NF-e JSON — field reference
Endpoint: GET /api/integration/dfe/nfe/inbound/documentos · OpenAPI reference: NF-e Public API.
Reference document — Field-by-field dictionary of the
metadataobject returned by the inbound NF-e documents endpoint. The same object, compressed (Gzip+Base64), is the content of thejsonfield whenjson=true.
Endpoint: GET /api/integration/dfe/nfe/inbound/documentos · OpenAPI reference: NF-e Public API.
Conventions used in this document
emissionDatePartis the document's date partition (derived fromchNFe), not an instant — it is returned as an ISO date string (e.g.,"2026-01-01"), without time. The other business/audit dates (dhEmi,createdAt,updatedAt) are returned as epoch milliseconds UTC.dhRecbtois returned in ISO format with offset (it was not converted to epoch millis).issuerTypeis returned as the enum name ("INBOUND"/"OUTBOUND"), not the internal numeric code. Always"INBOUND"in this listing.- ⚠️ The issuer CNPJ/CPF is published in the field
cnpjcpf(all lowercase) — note: the corresponding request filter is namedcnpjCpf(camelCase). They are different names; a client that readscnpjCpffrom the response getsnull. externalIdexists in the model but is omitted when null; in inbound documents it is always null, so it does not appear.statusMdeis the recipient manifestation status (specific to NF-e — see section 3).
1. Fields
| Field | Type | Description |
|---|---|---|
emissionDatePart | string (ISO date) | Document date partition (derived from chNFe), not an instant. Date format, without time. |
id | UUID | Internal identifier of the document record. |
customerId | UUID | Tenant that owns the record. |
companyId | UUID | Company (of the tenant) that is a party to the NF-e for this item — see "Multiplicity per company" on the listing flow page. |
issuerType | string | "INBOUND" (received) or "OUTBOUND" (issued by the tenant). Always "INBOUND" in this listing. |
dhEmi | long (epoch ms) | NF-e issuance date/time. |
tpNF | string | Operation type: "0" (inbound/entry) or "1" (outbound/exit), from the issuer's point of view. |
tpEmis | string | Issuance mode (normal, contingency, etc.). |
chNFe | string (44) | NF-e access key — correlation key with the events (see Inbound NF-e document and event reconciliation). |
nNF | string | NF-e number. |
serie | int | NF-e series. |
mod | string | Document model: always "55" in this listing. |
vNF | decimal | Total value of the NF-e. |
xNome | string | Name/legal name of the issuer. |
cStat | long, nullable | SEFAZ return status code (e.g., 100 = authorized). |
xMotivo | string, nullable | Reason/message of the SEFAZ protocol. |
nProt | long, nullable | SEFAZ authorization protocol number. |
dhRecbto | string (ISO datetime with offset), nullable | Date/time of receipt by SEFAZ. |
status | string | Internal lifecycle status code (see section 2). |
statusMde | string, nullable | Recipient manifestation status (see section 3). Specific to NF-e. |
createdAt | long (epoch ms) | When the record was persisted in MI. Ordering/keyset field for pagination. |
updatedAt | long (epoch ms) | Last update of the record. |
cnpjcpf | string | CNPJ/CPF of the document issuer. Field name in lowercase (see Conventions); the corresponding request filter is named cnpjCpf. |
printed | boolean | Indicates whether the DANFE has already been generated/printed by MI. Specific to NF-e. |
cancelled | boolean | Derived from status — see section 2. |
transmitted | boolean | Derived from status — see section 2. |
inProgress | boolean | Derived from status — see section 2. |
authorized | boolean | Derived from status — see section 2. |
2. status codes and the derived booleans
status is the internal lifecycle code of the document in MI (not to be confused with cStat, which is the SEFAZ return code):
| Code | Meaning |
|---|---|
0 | Not processed |
1 | Imported |
2 | Processing |
3 | Awaiting receipt confirmation |
4 | Error / aborted |
5 | Authorized |
6 | Denied |
7 | Cancelled |
8 | Not used |
9 | Closed |
The item's four booleans are derived from this code:
| Boolean | Rule |
|---|---|
authorized | status == "5" |
cancelled | status == "7" |
inProgress | status in {"2", "3"} |
transmitted | status in {"5", "6", "7", "8"} — any final result returned by SEFAZ (authorized, denied, cancelled or not used), as opposed to pending/error. |
3. statusMde codes (recipient manifestation)
Reflects the latest manifestation registered by the recipient for the document. The manifestation events themselves appear in the events endpoint.
| Code | Manifestation |
|---|---|
0 | No manifestation |
1 | Acknowledgment of the Operation — Ciência da Operação (tpEvento 210210) |
2 | Confirmation of the Operation (210200) |
3 | Operation Unknown — Desconhecimento da Operação (210220) |
4 | Operation Not Performed (210240) |
4. Example
{
"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
}
NF-e events JSON — field reference
Endpoint: GET /api/integration/dfe/nfe/inbound/eventos · OpenAPI reference: NF-e Public API.
NF-e document and event reconciliation
The documents (/inbound/documentos) and events (/inbound/eventos) endpoints operate independently. The client consumes each one in its own loop of…