Referência da API

Veículos

Cadastro, listagem e leitura dos veículos de uma conta.

Todo veículo pertence à conta de X-Account-Id. DELETE não apaga a linha: marca is_active como falso e responde 204. Listagens só devolvem veículos ativos.

POST/api/v1/vehicles

Cria o veículo. A placa é normalizada e o Renavam é gravado com 11 dígitos.

Corpo

Campo	Tipo	Presença	Descrição
`plate`	`string`	obrigatório	Placa antiga ou Mercosul. Hífen é descartado.
`renavam`	`string`	obrigatório	9 a 11 dígitos.
`uf`	`string`	obrigatório	Sigla da UF de licenciamento.
`owner_document`	`string`	obrigatório	CPF ou CNPJ do proprietário. Só na escrita.
`nickname`	`string`	opcional	Apelido interno.

curl https://api.zera.mobi/api/v1/vehicles \
-H "X-Api-Key: zera_live_..." \
-H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f" \
-H "Content-Type: application/json" \
-d '{"plate":"ABC1D23","renavam":"123456789","uf":"SP","owner_document":"12345678901"}'

{
"id": "8c1d9e2a-7b34-4f10-9a11-22b33c44d55e",
"plate": "ABC1D23",
"renavam": "00123456789",
"uf": "SP",
"nickname": "",
"owner_document_masked": "***.456.789-**",
"is_active": true,
"created_at": "2026-10-20T12:00:00-03:00",
"latest_consultation_id": null,
"latest_consultation_status": null,
"latest_consultation_at": null,
"open_debts_count": 0,
"open_debts_amount": "0.00",
"consultations_count": 0
}

GET/api/v1/vehicles

Lista paginada. Cada item inclui o resumo da última consulta e o total em aberto.

Query

Campo	Tipo	Presença	Descrição
`q`	`string`	opcional	Trecho de placa, Renavam ou apelido.
`uf`	`string`	opcional	Filtra pela UF.
`status`	`string`	opcional	with_debts, clear, never_consulted, pending ou failed.
`page`	`integer`	opcional	Página, a partir de 1.
`page_size`	`integer`	opcional	Itens por página, até 100.

curl "https://api.zera.mobi/api/v1/vehicles?uf=SP&status=with_debts" \
-H "X-Api-Key: zera_live_..." \
-H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f"

{
"count": 1,
"next": null,
"previous": null,
"results": []
}

GET/api/v1/vehicles/{vehicle_id}

O mesmo objeto da lista, para um id. PATCH aceita os campos de escrita, todos opcionais. DELETE desativa e responde sem corpo.

Path

Campo	Tipo	Presença	Descrição
`vehicle_id`	`uuid`	obrigatório	Id devolvido na criação.

curl https://api.zera.mobi/api/v1/vehicles/8c1d9e2a-7b34-4f10-9a11-22b33c44d55e \
-H "X-Api-Key: zera_live_..." \
-H "X-Account-Id: 4b6e0c2a-1d4f-4a8b-9c3e-1a2b3c4d5e6f"

GET /api/v1/vehicles/summary devolve totais da conta: quantidade, veículos com débito, sem débito, nunca consultados, pendentes, com falha, e a quebra by_uf.