← InicioFleetPay / Schema

ValePedagioEmitido

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.

ReciboValePedagio ↗

uuidstring · uuidOpcional

Identificador del vale de peaje en FleetPay: utilízalo en las demás llamadas.

statusstringOpcional

pending_debit, debit_confirmed, confirmed, failed o canceled.

status_descricaostringOpcional

Estado en texto.

id_vpo_anttstring | nullOpcional

Número del vale de peaje registrado en la ANTT.

operadorastringOpcional

Operadora.

numero_viagemstring | nullOpcional

Número del viaje en la operadora.

nsustring | nullOpcional

NSU de la compra en la operadora.

placastringOpcional

Matrícula.

valor_pedagionumberOpcional

Peaje (en reales brasileños).

valor_totalnumberOpcional

Importe total debitado (en reales brasileños).

vigencia_iniciostring · date-timeOpcional

Inicio de vigencia.

vigencia_fimstring · date-timeOpcional

Fin de vigencia.

reciboobjectOpcional

ReciboValePedagio ↗

emuladobooleanOpcional

true cuando se emite en modo emulado (homologación).

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

{
  "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"
    },
    "recibo": {
      "$ref": "#/components/schemas/ReciboValePedagio"
    },
    "emulado": {
      "type": "boolean",
      "description": "`true` quando emitido em modo emulado (homologação)."
    }
  }
}