idstring · uuidObligatorioUUID público utilizado en todas las rutas del CT-e.
Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
statusobjectObligatoriolifecycle_statusobjectObligatoriofreightobjectObligatoriorouteobjectObligatorioaccess_keystring | nullObligatoriopattern"^\\d{44}$"numberinteger | nullObligatorioseriesstring | nullObligatorioprotocolstring | nullObligatoriosefaz_protocolstring | nullObligatoriocstatstring | nullObligatorioreasonstring | nullObligatorioauthorized_atstring | null · date-timeObligatorioservice_typeintegerObligatorioide/tpServ del documento: 0 normal, 1 subcontratación, 2 redespacho, 3 redespacho intermedio (4 solo en borradores antiguos, que no pueden emitirse). Un contra-CT-e guardado antes de existir este campo es 1.
minimum0maximum4service_type_labelstringObligatorioEtiqueta legible de service_type, por ejemplo Redespacho.
ciotobjectObligatorionfe_countintegerOpcionalPresente en los listados.
minimum0has_mdfebooleanOpcionalPresente en los listados.
payloadobjectOpcionalPresente en la respuesta de detalle; contiene el payload público validado del borrador.
additionalPropertiestruenfearrayOpcionalPresente en la respuesta de detalle.
eventsarrayOpcionalPresente en la respuesta de detalle.
created_atstring | null · date-timeObligatorioupdated_atstring | null · date-timeObligatoriofinancial_documentobject | nullOpcionalSolo para un tramo de contra-CT-e: el documento financiero del tramo, que contiene la transferencia al conductor. internal_id tiene el formato ROUTE:<lote>:<hex> y se acepta en GET /carriers/parcelas-repasse/{documento}; access_key es la clave del contra-CT-e, registrada cuando SEFAZ lo autoriza. null en los demás CT-e.
Definición JSON Original (Descripciones en Portugués)
{
"type": "object",
"required": [
"id",
"status",
"lifecycle_status",
"freight",
"route",
"access_key",
"number",
"series",
"protocol",
"sefaz_protocol",
"cstat",
"reason",
"authorized_at",
"service_type",
"service_type_label",
"ciot",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID público usado em todos os caminhos do CT-e."
},
"status": {
"$ref": "#/components/schemas/CteSituation"
},
"lifecycle_status": {
"$ref": "#/components/schemas/CteLifecycleStatus"
},
"freight": {
"type": "object",
"required": [
"total_value",
"cargo_value"
],
"properties": {
"total_value": {
"type": [
"number",
"null"
],
"format": "double"
},
"cargo_value": {
"type": [
"number",
"null"
],
"format": "double"
}
}
},
"route": {
"$ref": "#/components/schemas/FiscalRoute"
},
"access_key": {
"type": [
"string",
"null"
],
"pattern": "^\\d{44}$"
},
"number": {
"type": [
"integer",
"null"
]
},
"series": {
"type": [
"string",
"null"
]
},
"protocol": {
"type": [
"string",
"null"
]
},
"sefaz_protocol": {
"type": [
"string",
"null"
]
},
"cstat": {
"type": [
"string",
"null"
]
},
"reason": {
"type": [
"string",
"null"
]
},
"authorized_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"service_type": {
"type": "integer",
"minimum": 0,
"maximum": 4,
"description": "`ide/tpServ` do documento: `0` normal, `1` subcontratação, `2` redespacho, `3`\nredespacho intermediário (`4` só em rascunhos antigos, que não emitem). Um contra-CT-e\ngravado antes do campo é `1`.\n"
},
"service_type_label": {
"type": "string",
"description": "Rótulo legível do `service_type` — ex.: `Redespacho`.\n"
},
"ciot": {
"$ref": "#/components/schemas/CteCiotSummary"
},
"nfe_count": {
"type": "integer",
"minimum": 0,
"description": "Presente nas listagens."
},
"has_mdfe": {
"type": "boolean",
"description": "Presente nas listagens."
},
"payload": {
"type": "object",
"additionalProperties": true,
"description": "Presente no detalhe; contém o payload público validado do rascunho."
},
"nfe": {
"type": "array",
"description": "Presente no detalhe.",
"items": {
"$ref": "#/components/schemas/Nfe"
}
},
"events": {
"type": "array",
"description": "Presente no detalhe.",
"items": {
"$ref": "#/components/schemas/CteEvent"
}
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"financial_document": {
"type": [
"object",
"null"
],
"description": "Só para **perna de contra-CT-e**: o documento financeiro da perna (o que carrega o\nrepasse ao motorista). `internal_id` tem a forma `ROUTE:<lote>:<hex>` e é aceito em\n`GET /carriers/parcelas-repasse/{documento}`; `access_key` é a chave do contra-CT-e,\ncarimbada quando a SEFAZ autoriza. `null` nos demais CT-e.\n",
"properties": {
"id": {
"type": "integer"
},
"internal_id": {
"type": "string"
},
"access_key": {
"type": [
"string",
"null"
]
}
}
}
}
}