← InícioFleetPay / Schema

EmitirVpoRequest

Estrutura preservada do contrato versionado da API.

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

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

Definição JSON Completa
{
  "type": "object",
  "required": [
    "transportador_documento",
    "transportador_rntrc",
    "placa",
    "eixos",
    "modalidade",
    "valor_pedagio",
    "vigencia_inicio",
    "vigencia_fim",
    "pracas"
  ],
  "properties": {
    "transportador_documento": {
      "type": "string",
      "description": "CPF ou CNPJ do transportador contratado (apenas números).",
      "maxLength": 20
    },
    "transportador_rntrc": {
      "type": "string",
      "description": "RNTRC do transportador (a FleetPay confere na ANTT; vale o RNTRC da ANTT).",
      "maxLength": 20
    },
    "transportador_nome": {
      "type": "string",
      "description": "Nome do transportador (opcional; sem ele vale o nome da ANTT).",
      "nullable": true,
      "maxLength": 150
    },
    "placa": {
      "type": "string",
      "description": "Placa do veículo (com tag na operadora e na frota do RNTRC).",
      "maxLength": 10
    },
    "eixos": {
      "type": "integer",
      "description": "Quantidade de eixos.",
      "minimum": 2,
      "maximum": 10
    },
    "operadora": {
      "type": "string",
      "description": "Operadora de pedágio.",
      "enum": [
        "sem_parar",
        "conectcar",
        "veloe",
        "move_mais"
      ],
      "nullable": true
    },
    "modalidade": {
      "type": "string",
      "description": "Modalidade da rota.",
      "enum": [
        "planejada",
        "estendida",
        "customizada"
      ]
    },
    "valor_pedagio": {
      "type": "number",
      "description": "Pedágio da rota cotada (`rotas[n].valor_total`).",
      "minimum": 0.01
    },
    "vigencia_inicio": {
      "type": "string",
      "description": "Início da vigência (AAAA-MM-DD).",
      "format": "date"
    },
    "vigencia_fim": {
      "type": "string",
      "description": "Fim da vigência (AAAA-MM-DD).",
      "format": "date"
    },
    "pracas": {
      "type": "array",
      "minItems": 1,
      "description": "**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.",
      "items": {
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Id da praça."
          },
          "nome": {
            "type": "string",
            "description": "Nome da praça."
          }
        }
      }
    },
    "numero_ciot": {
      "type": "string",
      "description": "Número do CIOT da operação de transporte.",
      "nullable": true,
      "maxLength": 50
    },
    "referencia_externa": {
      "type": "string",
      "description": "Sua referência (pedido, viagem).",
      "nullable": true,
      "maxLength": 100
    },
    "origem_cidade": {
      "type": "string",
      "description": "Cidade de origem.",
      "nullable": true
    },
    "origem_uf": {
      "type": "string",
      "description": "UF de origem.",
      "nullable": true,
      "maxLength": 2
    },
    "destino_cidade": {
      "type": "string",
      "description": "Cidade de destino.",
      "nullable": true
    },
    "destino_uf": {
      "type": "string",
      "description": "UF de destino.",
      "nullable": true,
      "maxLength": 2
    },
    "desvio_autorizado_por": {
      "type": "string",
      "description": "No complemento: quem autorizou o desvio.",
      "enum": [
        "embarcador",
        "motorista"
      ],
      "nullable": true
    },
    "emulado": {
      "type": "boolean",
      "description": "**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).",
      "nullable": true,
      "default": false
    }
  }
}