← HomeFleetPay / Schema

MdfeDraftInput

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

MdfeInsuranceInput ↗MdfeTechnicalContactInput ↗

cte_uuidsarrayRequired

Public UUIDs of authorized and available CT-e documents.

minItems1

vehicle_idintegerRequired

minimum1

trailersarray | nullOptional

maxItems3

driver_user_idinteger | nullOptional

minimum1

starts_atstring | null · dateOptional

ends_atstring | null · dateOptional

origin_city_codestring | nullOptional

pattern"^\\d{7}$"

origin_citystring | nullOptional

maxLength80

origin_statestringRequired

minLength2

maxLength2

destination_city_codestring | nullOptional

pattern"^\\d{7}$"

destination_citystring | nullOptional

maxLength80

destination_statestringRequired

minLength2

maxLength2

seguroobjectOptional

MdfeInsuranceInput ↗

salvar_seguro_padraoboolean | nullOptional

info_fiscostring | nullOptional

maxLength2000

observacoesstring | nullOptional

maxLength5000

resp_tecobjectOptional

MdfeTechnicalContactInput ↗

seriestring | nullOptional

maxLength3

Original JSON Definition (Portuguese Descriptions)

{
  "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
    }
  }
}