NF-e

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 metadata object returned by the inbound NF-e documents endpoint. The same object, compressed (Gzip+Base64), is the content of the json field when json=true.

Endpoint: GET /api/integration/dfe/nfe/inbound/documentos · OpenAPI reference: NF-e Public API.

Conventions used in this document

  • emissionDatePart is the document's date partition (derived from chNFe), 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. dhRecbto is returned in ISO format with offset (it was not converted to epoch millis).
  • issuerType is 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 named cnpjCpf (camelCase). They are different names; a client that reads cnpjCpf from the response gets null.
  • externalId exists in the model but is omitted when null; in inbound documents it is always null, so it does not appear.
  • statusMde is the recipient manifestation status (specific to NF-e — see section 3).

1. Fields

FieldTypeDescription
emissionDatePartstring (ISO date)Document date partition (derived from chNFe), not an instant. Date format, without time.
idUUIDInternal identifier of the document record.
customerIdUUIDTenant that owns the record.
companyIdUUIDCompany (of the tenant) that is a party to the NF-e for this item — see "Multiplicity per company" on the listing flow page.
issuerTypestring"INBOUND" (received) or "OUTBOUND" (issued by the tenant). Always "INBOUND" in this listing.
dhEmilong (epoch ms)NF-e issuance date/time.
tpNFstringOperation type: "0" (inbound/entry) or "1" (outbound/exit), from the issuer's point of view.
tpEmisstringIssuance mode (normal, contingency, etc.).
chNFestring (44)NF-e access key — correlation key with the events (see Inbound NF-e document and event reconciliation).
nNFstringNF-e number.
serieintNF-e series.
modstringDocument model: always "55" in this listing.
vNFdecimalTotal value of the NF-e.
xNomestringName/legal name of the issuer.
cStatlong, nullableSEFAZ return status code (e.g., 100 = authorized).
xMotivostring, nullableReason/message of the SEFAZ protocol.
nProtlong, nullableSEFAZ authorization protocol number.
dhRecbtostring (ISO datetime with offset), nullableDate/time of receipt by SEFAZ.
statusstringInternal lifecycle status code (see section 2).
statusMdestring, nullableRecipient manifestation status (see section 3). Specific to NF-e.
createdAtlong (epoch ms)When the record was persisted in MI. Ordering/keyset field for pagination.
updatedAtlong (epoch ms)Last update of the record.
cnpjcpfstringCNPJ/CPF of the document issuer. Field name in lowercase (see Conventions); the corresponding request filter is named cnpjCpf.
printedbooleanIndicates whether the DANFE has already been generated/printed by MI. Specific to NF-e.
cancelledbooleanDerived from status — see section 2.
transmittedbooleanDerived from status — see section 2.
inProgressbooleanDerived from status — see section 2.
authorizedbooleanDerived 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):

CodeMeaning
0Not processed
1Imported
2Processing
3Awaiting receipt confirmation
4Error / aborted
5Authorized
6Denied
7Cancelled
8Not used
9Closed

The item's four booleans are derived from this code:

BooleanRule
authorizedstatus == "5"
cancelledstatus == "7"
inProgressstatus in {"2", "3"}
transmittedstatus 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.

CodeManifestation
0No manifestation
1Acknowledgment of the Operation — Ciência da Operação (tpEvento 210210)
2Confirmation of the Operation (210200)
3Operation Unknown — Desconhecimento da Operação (210220)
4Operation 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
}

On this page