← InicioFleetPay / Schema

EmitirVpoRequest

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.

transportador_documentostringObligatorio

CPF o CNPJ del transportista contratado (solo números).

maxLength20

transportador_rntrcstringObligatorio

RNTRC del transportista (FleetPay lo verifica en la ANTT; prevalece el RNTRC de la ANTT).

maxLength20

transportador_nomestring | nullOpcional

Nombre del transportista (opcional; si se omite, se utiliza el nombre de la ANTT).

maxLength150

placastringObligatorio

Matrícula del vehículo (con tag en la operadora e incluido en la flota del RNTRC).

maxLength10

eixosintegerObligatorio

Cantidad de ejes.

minimum2

maximum10

operadorastring | nullOpcional

Operadora de peaje.

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

modalidadestringObligatorio

Modalidad de la ruta.

"planejada" · "estendida" · "customizada"

valor_pedagionumberObligatorio

Peaje de la ruta cotizada (rotas[n].valor_total).

minimum0.01

vigencia_iniciostring · dateObligatorio

Inicio de vigencia (AAAA-MM-DD).

vigencia_fimstring · dateObligatorio

Fin de vigencia (AAAA-MM-DD).

pracasarrayObligatorio

Obligatorio para sem_parar. Plazas de la ruta elegida en la cotización (rotas[n].pracas), con el id de cada una. Puedes reenviar los objetos de la cotización sin cambios.

minItems1

numero_ciotstring | nullOpcional

Número de CIOT de la operación de transporte.

maxLength50

referencia_externastring | nullOpcional

Tu referencia (pedido, viaje).

maxLength100

origem_cidadestring | nullOpcional

Ciudad de origen.

origem_ufstring | nullOpcional

Estado de origen.

maxLength2

destino_cidadestring | nullOpcional

Ciudad de destino.

destino_ufstring | nullOpcional

Estado de destino.

maxLength2

desvio_autorizado_porstring | nullOpcional

En el complemento: quién autorizó el desvío.

"embarcador" · "motorista"

emuladoboolean | nullOpcional

Solo homologación. Con true, la emisión ocurre realmente en la operadora (viaje, número ANTT, recibo, cancelación), pero no se debita ni se devuelve ningún importe de la Cuenta Operativa. En producción, la solicitud se rechaza (422).

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

{
  "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
    }
  }
}