← HomeFleetPay / Schema

VehicleCreateInput

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.

platestringRequired

pattern"^[A-Z]{3}[0-9][A-Z0-9][0-9]{2}$"

plate_statestring | nullOptional

minLength2

maxLength2

renavamstring | nullOptional

pattern"^\\d{11}$"

tare_kgnumber | nullOptional

minimum0

capacity_kgnumber | nullOptional

minimum0

capacity_m3number | nullOptional

minimum0

axlesnumber | nullOptional

minimum0

maximum255

body_typenumber | nullOptional

minimum0

maximum255

wheel_typenumber | nullOptional

minimum0

maximum255

owner_typestring | nullOptional

"own" · "third"

owner_documentstring | nullOptional

maxLength14

owner_namestring | nullOptional

maxLength120

owner_rntrcstring | nullOptional

maxLength8

default_driver_user_idinteger | nullOptional

minimum1

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "plate"
  ],
  "properties": {
    "plate": {
      "type": "string",
      "pattern": "^[A-Z]{3}[0-9][A-Z0-9][0-9]{2}$"
    },
    "plate_state": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 2,
      "maxLength": 2
    },
    "renavam": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{11}$"
    },
    "tare_kg": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0
    },
    "capacity_kg": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0
    },
    "capacity_m3": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0
    },
    "axles": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0,
      "maximum": 255
    },
    "body_type": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0,
      "maximum": 255
    },
    "wheel_type": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0,
      "maximum": 255
    },
    "owner_type": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "own",
        "third"
      ],
      "default": "own"
    },
    "owner_document": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 14
    },
    "owner_name": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 120
    },
    "owner_rntrc": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 8
    },
    "default_driver_user_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1
    }
  }
}