← InicioFleetPay / API

Descargar recibo en PDF del Peaje Obligatorio (VPO)

Parámetros, estructura de datos y respuestas del contrato versionado.

GET/vale-pedagio/{uuid}/recibo/pdf
obterReciboPdfValePedagioBase de Pruebas: https://api.fleetpay.site/v1

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

Devuelve el archivo PDF oficial del comprobante de compra del Peaje Obligatorio (VPO).

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Peaje Obligatorio (VPO)
Perfiles Aplicables
Embarcador · Gestor de Transporte · Transportista Flotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

uuidpath · stringObligatorio

UUID del Peaje Obligatorio emitido.

Restricciones
{
  "type": "string"
}

Respuestas

200 Respuesta HTTP

Binario PDF del recibo.

application/json

401 Respuesta HTTP

Credencial ausente, inválida o de otro entorno.

403 Respuesta HTTP

Permiso del panel no habilitado o recurso fuera del alcance de la company.

404 Respuesta HTTP

Peaje Obligatorio no encontrado.

Definición Completa de la Operación
{
  "tags": [
    "Vale-Pedágio (VPO)"
  ],
  "operationId": "obterReciboPdfValePedagio",
  "summary": "Baixar recibo em PDF do Vale-Pedágio Obrigatório",
  "description": "Retorna o arquivo PDF oficial do comprovante de compra do Vale-Pedágio Obrigatório (VPO).",
  "parameters": [
    {
      "name": "uuid",
      "in": "path",
      "required": true,
      "description": "UUID do Vale-Pedágio emitido.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Binário PDF do recibo.",
      "content": {
        "application/json": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "404": {
      "description": "Vale-Pedágio não encontrado."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "vale-pedagio",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/vale-pedagio/{uuid}/recibo/pdf"
}