CT-e JSON — referência de campos

Endpoint: GET /api/integration/dfe/cte/inbound/documentos · Referência OpenAPI: CT-e Public API.

Documento de referência — Dicionário campo a campo do objeto metadata retornado pelo endpoint de documentos CT-e inbound. O mesmo objeto, comprimido (Gzip+Base64), é o conteúdo do campo json quando json=true.

Endpoint: GET /api/integration/dfe/cte/inbound/documentos · Referência OpenAPI: CT-e Public API.

Convenções deste documento

  • emissionDatePart é a partição de data do documento (derivada de chCte), não um instante — sai como string ISO. As demais datas de negócio/auditoria (dhEmi, createdAt, updatedAt) saem como epoch milliseconds UTC. dhRecbto sai no formato ISO com offset (não foi convertido para epoch millis).
  • issuerType sai como o nome do enum ("INBOUND"/"OUTBOUND"), não o código numérico interno.
  • Os 5 papéis do CT-e (emitente/destinatário, remetente, expedidor, recebedor, tomador) aparecem sempre juntos no metadata, independentemente de qual deles é a empresa do tenant para este item (ver companyId).

1. Campos

CampoTipoDescrição
emissionDatePartstring (ISO datetime)Partição de data do documento (derivada de chCte), não um instante.
idUUIDIdentificador interno do registro do documento.
customerIdUUIDTenant proprietário do registro.
companyIdUUIDEmpresa (do tenant) que é parte do CT-e para este item — ver "Multiplicidade por empresa" na página do fluxo de listagem.
externalIdstring, nullableIdentificador externo, quando fornecido na ingestão.
issuerTypestring"INBOUND" (recebido) ou "OUTBOUND" (emitido pelo tenant). Sempre "INBOUND" nesta listagem.
dhEmilong (epoch ms)Data/hora de emissão do CT-e.
tpCtestringTipo do CT-e (normal, complemento de valores, anulação, substituto).
tpEmisstringForma de emissão (normal, contingência, etc.).
chCtestring (44)Chave de acesso do CT-e — chave de correlação com os eventos (ver Reconciliação de documentos e eventos CT-e inbound).
nCTintNúmero do CT-e.
serieshortSérie do CT-e.
modstringModelo do documento: "57" (CT-e), "67" (CT-e OS) ou "64" (GTV-e).
vCtdecimalValor total da prestação do serviço de transporte.
cnpjCpfEmitDeststringCNPJ/CPF do papel emitente/destinatário.
xNomeEmitDeststringNome/razão social do emitente/destinatário.
cnpjCpfRemetentestringCNPJ/CPF do remetente da carga.
xNomeRemetentestringNome/razão social do remetente.
cnpjCpfExpedidorstringCNPJ/CPF do expedidor.
xNomeExpedidorstringNome/razão social do expedidor.
cnpjCpfRecebedorstringCNPJ/CPF do recebedor.
xNomeRecebedorstringNome/razão social do recebedor.
cnpjCpfTomadorstringCNPJ/CPF do tomador do serviço.
xNomeTomadorstringNome/razão social do tomador.
statusstringCódigo de status interno (ver tabela na seção 2).
cStatshort, nullableCódigo de status de retorno da SEFAZ (ex.: 100 = autorizado).
xMotivostring, nullableMotivo/mensagem do protocolo SEFAZ.
nProtlong, nullableNúmero do protocolo de autorização SEFAZ.
dhRecbtostring (ISO datetime com offset), nullableData/hora de recebimento pela SEFAZ.
createdAtlong (epoch ms)Quando o registro foi persistido no MI.
updatedAtlong (epoch ms)Última atualização do registro.
transmittedbooleanDerivado de status — ver seção 2.
inProgressbooleanDerivado de status — ver seção 2.
authorizedbooleanDerivado de status — ver seção 2.
cancelledbooleanDerivado 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ódigoSignificado
0Não processado
1Importado
2Em processamento
3Aguardando confirmação de recebimento
4Erro / abortado
5Autorizado
6Denegado
7Cancelado
8Não utilizado
9Encerrado

Os quatro booleans do item são derivados desse código:

BooleanRegra
authorizedstatus == "5"
cancelledstatus == "7"
inProgressstatus em {"2", "3"}
transmittedstatus em {"5", "6", "7", "8"} — qualquer resultado final devolvido pela SEFAZ (autorizado, denegado, cancelado ou não utilizado), em contraste com pendente/erro.

3. Exemplo

{
  "emissionDatePart": "2026-01-01T00:00:00",
  "id": "0198c0de-0000-7000-8000-000000000003",
  "customerId": "0198c0de-0000-7000-8000-000000000001",
  "companyId": "0198c0de-0000-7000-8000-000000000002",
  "issuerType": "INBOUND",
  "dhEmi": 1768469400000,
  "tpCte": "0",
  "tpEmis": "1",
  "chCte": "35260111111111111111570010000000011000000015",
  "nCT": 1,
  "serie": 1,
  "mod": "57",
  "vCt": 1500.00,
  "cnpjCpfEmitDest": "11111111111111",
  "xNomeEmitDest": "Destinatario Ltda",
  "cnpjCpfRemetente": "22222222222222",
  "xNomeRemetente": "Remetente Ltda",
  "cnpjCpfExpedidor": "33333333333333",
  "xNomeExpedidor": "Expedidor Ltda",
  "cnpjCpfRecebedor": "44444444444444",
  "xNomeRecebedor": "Recebedor Ltda",
  "cnpjCpfTomador": "55555555555555",
  "xNomeTomador": "Tomador Ltda",
  "status": "5",
  "cStat": 100,
  "xMotivo": "Autorizado o uso do CT-e",
  "nProt": 135260000000001,
  "dhRecbto": "2026-01-15T09:35:00-03:00",
  "createdAt": 1768478400000,
  "updatedAt": 1768478700000,
  "transmitted": true,
  "inProgress": false,
  "authorized": true,
  "cancelled": false
}

Nesta página