← InícioFleetPay / Schema

Cte

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

idstring · uuidObrigatório

UUID público usado em todos os caminhos do CT-e.

freightobjectObrigatório
access_keystring | nullObrigatório
pattern"^\\d{44}$"
numberinteger | nullObrigatório
seriesstring | nullObrigatório
protocolstring | nullObrigatório
sefaz_protocolstring | nullObrigatório
cstatstring | nullObrigatório
reasonstring | nullObrigatório
authorized_atstring | null · date-timeObrigatório
service_typeintegerObrigatório

ide/tpServ do documento: 0 normal, 1 subcontratação, 2 redespacho, 3 redespacho intermediário (4 só em rascunhos antigos, que não emitem). Um contra-CT-e gravado antes do campo é 1.

minimum0
maximum4
service_type_labelstringObrigatório

Rótulo legível do service_type — ex.: Redespacho.

nfe_countintegerOpcional

Presente nas listagens.

minimum0
has_mdfebooleanOpcional

Presente nas listagens.

payloadobjectOpcional

Presente no detalhe; contém o payload público validado do rascunho.

additionalPropertiestrue
nfearrayOpcional

Presente no detalhe.

created_atstring | null · date-timeObrigatório
updated_atstring | null · date-timeObrigatório
financial_documentobject | nullOpcional

Só para perna de contra-CT-e: o documento financeiro da perna (o que carrega o repasse ao motorista). internal_id tem a forma ROUTE:<lote>:<hex> e é aceito em GET /carriers/parcelas-repasse/{documento}; access_key é a chave do contra-CT-e, carimbada quando a SEFAZ autoriza. null nos demais CT-e.

Definição JSON Completa
{
  "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"
          ]
        }
      }
    }
  }
}