← InícioFleetPay / Schema

MdfeDraftInput

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.

cte_uuidsarrayObrigatório

UUIDs públicos de CT-e autorizados e disponíveis.

minItems1
vehicle_idintegerObrigatório
minimum1
trailersarray | nullOpcional
maxItems3
driver_user_idinteger | nullOpcional
minimum1
starts_atstring | null · dateOpcional
ends_atstring | null · dateOpcional
origin_city_codestring | nullOpcional
pattern"^\\d{7}$"
origin_citystring | nullOpcional
maxLength80
origin_statestringObrigatório
minLength2
maxLength2
destination_city_codestring | nullOpcional
pattern"^\\d{7}$"
destination_citystring | nullOpcional
maxLength80
destination_statestringObrigatório
minLength2
maxLength2
salvar_seguro_padraoboolean | nullOpcional
info_fiscostring | nullOpcional
maxLength2000
observacoesstring | nullOpcional
maxLength5000
seriestring | nullOpcional
maxLength3
Definição JSON Completa
{
  "type": "object",
  "required": [
    "cte_uuids",
    "vehicle_id",
    "origin_state",
    "destination_state"
  ],
  "properties": {
    "cte_uuids": {
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "description": "UUIDs públicos de CT-e autorizados e disponíveis.",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "vehicle_id": {
      "type": "integer",
      "minimum": 1
    },
    "trailers": {
      "type": [
        "array",
        "null"
      ],
      "maxItems": 3,
      "uniqueItems": true,
      "items": {
        "type": "integer",
        "minimum": 1
      }
    },
    "driver_user_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1
    },
    "starts_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "ends_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "origin_city_code": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{7}$"
    },
    "origin_city": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "origin_state": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "destination_city_code": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{7}$"
    },
    "destination_city": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "destination_state": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "seguro": {
      "$ref": "#/components/schemas/MdfeInsuranceInput"
    },
    "salvar_seguro_padrao": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "info_fisco": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 2000
    },
    "observacoes": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 5000
    },
    "resp_tec": {
      "$ref": "#/components/schemas/MdfeTechnicalContactInput"
    },
    "serie": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 3
    }
  }
}