← InícioFleetPay / API

Baixar recibo em PDF do Vale-Pedágio Obrigatório

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/vale-pedagio/{uuid}/recibo/pdf
obterReciboPdfValePedagioBase de Homologação: https://api.fleetpay.site/v1

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

Retorna o arquivo PDF oficial do comprovante de compra do Vale-Pedágio Obrigatório (VPO).

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Vale-Pedágio Obrigatório (VPO)
Perfis Aplicáveis
Embarcador · Gestor de Transporte · Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

uuidpath · stringObrigatório

UUID do Vale-Pedágio emitido.

Restrições
{
  "type": "string"
}

Respostas

200 Resposta HTTP

Binário PDF do recibo.

application/json

401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

404 Resposta HTTP

Vale-Pedágio não encontrado.

Definição Completa da Operação
{
  "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"
}