v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Cadastros Básicos

Veículo específico

Retorna um Veículo específico com base no parâmetro enviado na requisição.

get/v1/veiculos/{codigoVeiculo}

Path parameters

codigoVeiculointeger required

Código do Veículo para retorno

Response

Dados do Veículo retornados com sucesso.

codigoVeiculointeger

Código do veículo

placastring

Placa do veículo

marcaModelostring

Marca e modelo do veículo

numeroMotorstring

Número do motor

renavamstring

Número do RENAVAM

chassisstring

Número do chassi

categoriastring

Categoria do veículo

pesoMaximonumber float

Peso máximo suportado pelo veículo

veiculoProprioboolean

Indica se o veículo pertence à empresa

combustivel1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18

Tipo de combustível: 1 - Álcool
2 - Gasolina/Elétrico
3 - Gás Metano
4 - Diesel
5 - Elétrico/Fonte Interna
6 - Álcool/Gasolina
7 - Gasolina
8 - Elétrico/Fonte Externa
9 - Gasolina/Gás Natural Combustível
10 - Álcool/Gás Natural Combustível
11 - Diesel/Gás Natural Combustível
12 - Álcool/Gás Natural Veicular
13 - Gasolina/Gás Natural Veicular
14 - Gás Natural Veicular
15 - Vide/Campo/Observação
16 - Diesel/Gás Natural Veicular
17 - Gasolina/Álcool/Gás Natural Veicular
18 - Gasogênio

corstring

Cor do veículo

anoFabricacaointeger

Ano de fabricação do veículo

anoModelointeger

Ano do modelo do veículo

codigoCidadeinteger

Código da cidade de emplacamento

nomeCidadestring

Nome da cidade de emplacamento

codigoFuncionariointeger

Código do funcionário

nomeFuncionariostring

Nome do funcionário

codigoMotoristainteger

Código do motorista

nomeMotoristastring

Nome do motorista

codigoParceirointeger

Código do parceiro

nomeParceirostring

Nome do parceiro

ativoboolean

Indica se o veículo está ativo

Example response

{
  "codigoVeiculo": 1234,
  "placa": "ABC1D23",
  "marcaModelo": "Ford Focus",
  "numeroMotor": "XYZ123456789",
  "chassis": "9BWZZZ377VT004251",
  "categoria": "Caminhão",
  "pesoMaximo": 2500.5,
  "veiculoProprio": true,
  "combustivel": 7,
  "cor": "Preto",
  "anoFabricacao": 2022,
  "anoModelo": 2023,
  "codigoCidade": 3543402,
  "nomeCidade": "Uberlândia",
  "codigoFuncionario": 5678,
  "nomeFuncionario": "Mário Regis",
  "codigoMotorista": 4321,
  "nomeMotorista": "Roberto Magalhães",
  "codigoParceiro": 1111,
  "nomeParceiro": "José da Silva",
  "ativo": true
}