← InicioFleetPay / Schema

RotaPedagio

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

CustoModalidade ↗PracaPedagio ↗

idstringOpcional

Identificador de la ruta (identificadores de las plazas).

nomestringOpcional

Nombre de la ruta.

distancia_kmnumberOpcional

Distancia, cuando la informa la operadora.

tempo_estimadostringOpcional

Tiempo estimado, cuando se informa.

valor_totalnumberOpcional

Peaje de la ruta (en reales brasileños): utiliza este importe en valor_pedagio al comprar.

recomendadabooleanOpcional

Ruta recomendada por la operadora.

precificadabooleanOpcional

true cuando el importe proviene de la operadora para esta matrícula y cantidad de ejes.

operadora_rota_idstring | nullOpcional

Identificador de la ruta en la operadora (informativo).

pracasarrayOpcional

Plazas de la ruta: envíalas en pracas al comprar.

PracaPedagio ↗

custosobjectOpcional

Importes por modalidad.

CustoModalidade ↗

Definición JSON Original (Descripciones en Portugués)

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