← HomeFleetPay / Schema

RotaPedagio

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.

CustoModalidade ↗PracaPedagio ↗

idstringOptional

Route identifier (toll plaza IDs).

nomestringOptional

Route name.

distancia_kmnumberOptional

Distance, when provided by the operator.

tempo_estimadostringOptional

Estimated time, when provided.

valor_totalnumberOptional

Route toll amount (in Brazilian reais) — use in valor_pedagio when purchasing.

recomendadabooleanOptional

Route recommended by the operator.

precificadabooleanOptional

true when the operator supplied the amount for this license plate and axle count.

operadora_rota_idstring | nullOptional

Operator's route ID (informational).

pracasarrayOptional

Route toll plazas — send in pracas when purchasing.

PracaPedagio ↗

custosobjectOptional

Amounts by route option.

CustoModalidade ↗

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Identificador da rota (ids das praças)."
    },
    "nome": {
      "type": "string",
      "description": "Nome da rota."
    },
    "distancia_km": {
      "type": "number",
      "description": "Distância, quando informada pela operadora."
    },
    "tempo_estimado": {
      "type": "string",
      "description": "Tempo estimado, quando informado."
    },
    "valor_total": {
      "type": "number",
      "description": "Pedágio da rota (em reais) — use em `valor_pedagio` na compra."
    },
    "recomendada": {
      "type": "boolean",
      "description": "Rota recomendada pela operadora."
    },
    "precificada": {
      "type": "boolean",
      "description": "`true` quando o valor veio da operadora para esta placa/eixos."
    },
    "operadora_rota_id": {
      "type": "string",
      "description": "Id da rota na operadora (informativo).",
      "nullable": true
    },
    "pracas": {
      "type": "array",
      "description": "Praças da rota — envie em `pracas` na compra.",
      "items": {
        "$ref": "#/components/schemas/PracaPedagio"
      }
    },
    "custos": {
      "type": "object",
      "description": "Valores por modalidade.",
      "properties": {
        "planejada": {
          "$ref": "#/components/schemas/CustoModalidade"
        },
        "estendida": {
          "$ref": "#/components/schemas/CustoModalidade"
        },
        "customizada": {
          "$ref": "#/components/schemas/CustoModalidade"
        }
      }
    }
  }
}