← HomeFleetPay / Schema

Vehicle

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.

VehicleFiscalData ↗

idintegerRequired

minimum1

platestringRequired

plate_statestring | nullRequired

renavamstring | nullRequired

owner_typestringRequired

"own" · "third"

owner_documentstring | nullRequired

owner_namestring | nullRequired

owner_rntrcstring | nullRequired

fiscalobjectRequired

VehicleFiscalData ↗

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "id",
    "plate",
    "plate_state",
    "renavam",
    "owner_type",
    "owner_document",
    "owner_name",
    "owner_rntrc",
    "fiscal"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "minimum": 1
    },
    "plate": {
      "type": "string"
    },
    "plate_state": {
      "type": [
        "string",
        "null"
      ]
    },
    "renavam": {
      "type": [
        "string",
        "null"
      ]
    },
    "owner_type": {
      "type": "string",
      "enum": [
        "own",
        "third"
      ]
    },
    "owner_document": {
      "type": [
        "string",
        "null"
      ]
    },
    "owner_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "owner_rntrc": {
      "type": [
        "string",
        "null"
      ]
    },
    "fiscal": {
      "$ref": "#/components/schemas/VehicleFiscalData"
    }
  }
}