Emitir Vale-Pedágio complementar por desvio de rota

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

POST/vale-pedagio/{uuid}/complemento

emitirComplementoValePedagioBase 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.

Emite um Vale-Pedágio complementar vinculado a um VPO existente em decorrência de desvio autorizado de trajeto ou acréscimo de praças de pedágio.

Autenticação

[
  {
    "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 Obrigatório devolvido na emissão (/vale-pedagio/comprar).

Restrições

{
  "type": "string",
  "format": "uuid"
}

Corpo da Requisição

Obrigatório

`application/json`

EmitirVpoRequest ↗

transportador_documentostringObrigatório

CPF ou CNPJ do transportador contratado (apenas números).

maxLength20

transportador_rntrcstringObrigatório

RNTRC do transportador (a FleetPay confere na ANTT; vale o RNTRC da ANTT).

maxLength20

transportador_nomestring | nullOpcional

Nome do transportador (opcional; sem ele vale o nome da ANTT).

maxLength150

placastringObrigatório

Placa do veículo (com tag na operadora e na frota do RNTRC).

maxLength10

eixosintegerObrigatório

Quantidade de eixos.

minimum2

maximum10

operadorastring | nullOpcional

Operadora de pedágio.

"sem_parar" · "conectcar" · "veloe" · "move_mais"

modalidadestringObrigatório

Modalidade da rota.

"planejada" · "estendida" · "customizada"

valor_pedagionumberObrigatório

Pedágio da rota cotada (rotas[n].valor_total).

minimum0.01

vigencia_iniciostring · dateObrigatório

Início da vigência (AAAA-MM-DD).

vigencia_fimstring · dateObrigatório

Fim da vigência (AAAA-MM-DD).

pracasarrayObrigatório

Obrigatório para sem_parar. As praças da rota escolhida na cotação (rotas[n].pracas), com o id de cada uma. Pode reenviar os objetos da cotação como vieram.

minItems1

numero_ciotstring | nullOpcional

Número do CIOT da operação de transporte.

maxLength50

referencia_externastring | nullOpcional

Sua referência (pedido, viagem).

maxLength100

origem_cidadestring | nullOpcional

Cidade de origem.

origem_ufstring | nullOpcional

UF de origem.

maxLength2

destino_cidadestring | nullOpcional

Cidade de destino.

destino_ufstring | nullOpcional

UF de destino.

maxLength2

desvio_autorizado_porstring | nullOpcional

No complemento: quem autorizou o desvio.

"embarcador" · "motorista"

emuladoboolean | nullOpcional

Somente homologação. Com true, a emissão acontece de verdade na operadora (viagem, nº ANTT, recibo, cancelamento) mas nenhum valor é debitado ou estornado da Conta Operacional. Em produção o pedido é recusado (422).

Respostas

201 Resposta HTTP

Vale-Pedágio complementar emitido com sucesso

`application/json`

ComplementoVpoResponse ↗

successbooleanOpcional

dataobjectOpcional

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Escopo não habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

404 Resposta HTTP

Vale-Pedágio de origem não encontrado

`application/json`

Erro ↗

errorobjectOpcional

422 Resposta HTTP

Saldo insuficiente ou erro de validação

`application/json`

Erro ↗

errorobjectOpcional

429 Resposta HTTP

Limite de requisições excedido (limite_requisicoes). Aguarde o intervalo indicado no header Retry-After antes de repetir. Pode vir do provedor, repassado, ou do teto anti-abuso da própria FleetPay — contado por empresa autenticada e por grupo de rotas, com uma janela curta que pega a rajada e uma longa que pega o robô lento. Os tetos são folgados de propósito: integração real, inclusive lote grande processado de uma vez, não chega perto deles. Se a sua chegar, fale com a FleetPay.

`application/json`

Erro ↗

errorobjectOpcional

500 Resposta HTTP

Erro interno (erro_interno)

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "tags": [
    "Vale-Pedágio (VPO)"
  ],
  "summary": "Emitir Vale-Pedágio complementar por desvio de rota",
  "operationId": "emitirComplementoValePedagio",
  "description": "Emite um Vale-Pedágio complementar vinculado a um VPO existente em decorrência de desvio\nautorizado de trajeto ou acréscimo de praças de pedágio.\n",
  "parameters": [
    {
      "$ref": "#/components/parameters/VpoUuid"
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/EmitirVpoRequest"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Vale-Pedágio complementar emitido com sucesso",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ComplementoVpoResponse"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "description": "Vale-Pedágio de origem não encontrado",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Saldo insuficiente ou erro de validação",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    },
    "500": {
      "$ref": "#/components/responses/Erro500"
    }
  },
  "method": "POST",
  "path": "/vale-pedagio/{uuid}/complemento"
}