← InícioFleetPay / Schema

RotaPedagio

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

CustoModalidade ↗PracaPedagio ↗

idstringOpcional

Identificador da rota (ids das praças).

nomestringOpcional

Nome da rota.

distancia_kmnumberOpcional

Distância, quando informada pela operadora.

tempo_estimadostringOpcional

Tempo estimado, quando informado.

valor_totalnumberOpcional

Pedágio da rota (em reais) — use em valor_pedagio na compra.

recomendadabooleanOpcional

Rota recomendada pela operadora.

precificadabooleanOpcional

true quando o valor veio da operadora para esta placa/eixos.

operadora_rota_idstring | nullOpcional

Id da rota na operadora (informativo).

pracasarrayOpcional

Praças da rota — envie em pracas na compra.

PracaPedagio ↗

custosobjectOpcional

Valores por modalidade.

CustoModalidade ↗

Definição JSON Completa

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