← HomeFleetPay / Schema

ValePedagioDetalhe

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.

PracaPedagio ↗ReciboValePedagio ↗

uuidstring · uuidOptional

FleetPay toll voucher identifier — use in subsequent calls.

statusstringOptional

pending_debit, debit_confirmed, confirmed, failed or canceled.

status_descricaostringOptional

Human-readable status.

id_vpo_anttstring | nullOptional

Toll voucher number registered with ANTT.

operadorastringOptional

Operator.

numero_viagemstring | nullOptional

Operator's trip number.

nsustring | nullOptional

Operator's purchase NSU.

placastringOptional

License plate.

valor_pedagionumberOptional

Toll amount (in Brazilian reais).

valor_totalnumberOptional

Total debited amount (in Brazilian reais).

vigencia_iniciostring · date-timeOptional

Validity start.

vigencia_fimstring · date-timeOptional

Validity end.

eixosintegerOptional

Axles.

transportador_documentostringOptional

Carrier's CPF/CNPJ.

transportador_rntrcstringOptional

RNTRC (from ANTT).

modalidadestringOptional

Option.

pracasarrayOptional

PracaPedagio ↗

desviobooleanOptional

true for a supplementary toll voucher.

reciboobjectOptional

ReciboValePedagio ↗

emuladobooleanOptional

true when issued in emulated mode (sandbox).

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "properties": {
    "uuid": {
      "type": "string",
      "description": "Identificador do Vale-Pedágio na FleetPay — use nas demais chamadas.",
      "format": "uuid"
    },
    "status": {
      "type": "string",
      "description": "`pending_debit`, `debit_confirmed`, `confirmed`, `failed` ou `canceled`."
    },
    "status_descricao": {
      "type": "string",
      "description": "Status por extenso."
    },
    "id_vpo_antt": {
      "type": "string",
      "description": "Número do Vale-Pedágio registrado na ANTT.",
      "nullable": true
    },
    "operadora": {
      "type": "string",
      "description": "Operadora."
    },
    "numero_viagem": {
      "type": "string",
      "description": "Número da viagem na operadora.",
      "nullable": true
    },
    "nsu": {
      "type": "string",
      "description": "NSU da compra na operadora.",
      "nullable": true
    },
    "placa": {
      "type": "string",
      "description": "Placa."
    },
    "valor_pedagio": {
      "type": "number",
      "description": "Pedágio (em reais)."
    },
    "valor_total": {
      "type": "number",
      "description": "Valor total debitado (em reais)."
    },
    "vigencia_inicio": {
      "type": "string",
      "description": "Início da vigência.",
      "format": "date-time"
    },
    "vigencia_fim": {
      "type": "string",
      "description": "Fim da vigência.",
      "format": "date-time"
    },
    "eixos": {
      "type": "integer",
      "description": "Eixos."
    },
    "transportador_documento": {
      "type": "string",
      "description": "CPF/CNPJ do transportador."
    },
    "transportador_rntrc": {
      "type": "string",
      "description": "RNTRC (da ANTT)."
    },
    "modalidade": {
      "type": "string",
      "description": "Modalidade."
    },
    "pracas": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PracaPedagio"
      }
    },
    "desvio": {
      "type": "boolean",
      "description": "`true` para Vale-Pedágio complementar."
    },
    "recibo": {
      "$ref": "#/components/schemas/ReciboValePedagio"
    },
    "emulado": {
      "type": "boolean",
      "description": "`true` quando emitido em modo emulado (homologação)."
    }
  }
}