← InícioFleetPay / API

Atualizar dados fiscais do veículo

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

PUT/fiscal/veiculos/{id}/dados-fiscais
updateVehicleFiscalDataBase 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.

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

idpath · integerObrigatório

ID inteiro do veículo.

Restrições
{
  "type": "integer",
  "minimum": 1
}

Corpo da Requisição

Obrigatório

application/json

brandstring | nullOpcional
maxLength40
modelstring | nullOpcional
maxLength60
vehicle_kindinteger | nullOpcional
1 · 2
axlesinteger | nullOpcional
minimum1
maximum255
km_per_liter_modelnumber | nullOpcional
minimum0
maximum999.99
km_per_liter_vehiclenumber | nullOpcional
minimum0
maximum999.99
tare_kginteger | nullOpcional
minimum1
maximum999999
wheel_typestring | nullOpcional
"01" · "02" · "03" · "04" · "05" · "06"
body_typestring | nullOpcional
"00" · "01" · "02" · "03" · "04" · "05"
owner_iestring | nullOpcional
maxLength20
owner_statestring | nullOpcional
minLength2
maxLength2

Respostas

200 Resposta HTTP

Veículo atualizado.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

401 Resposta HTTP

Chave de API FleetPay ausente ou inválida.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

403 Resposta HTTP

Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

404 Resposta HTTP

Recurso não encontrado no tenant autenticado.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

422 Resposta HTTP

Payload inválido, pendência ou regra de negócio.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

429 Resposta HTTP

Limite por transportadora excedido.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

Retry-After

Segundos até uma nova tentativa.

500 Resposta HTTP

Falha interna sem detalhes de integrações operacionais.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

Definição Completa da Operação
{
  "tags": [
    "Veículos"
  ],
  "summary": "Atualizar dados fiscais do veículo",
  "operationId": "updateVehicleFiscalData",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/VehicleFiscalInput"
        }
      }
    }
  },
  "responses": {
    "200": {
      "$ref": "#/components/responses/VehicleOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "422": {
      "$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "PUT",
  "path": "/fiscal/veiculos/{id}/dados-fiscais",
  "parameters": [
    {
      "$ref": "#/components/parameters/VehicleId"
    }
  ]
}