Frota · Referência

Débitos Veiculares

IPVA, licenciamento, DPVAT e outros débitos por veículo.

Permissão: debitos_veicularesAções: ler · criar · atualizar · exportar

GET/v1/debitos_veicularesListar GET/v1/debitos_veiculares/{id}Detalhar GET/v1/debitos_veiculares/{id}/veiculoRelação: Veículos GET/v1/debitos_veiculares/exportarExportar em lote POST/v1/debitos_veicularesCadastrar débito PATCH/v1/debitos_veiculares/{id}Atualizar débito

O objeto débitos veiculares

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`vehicle_id`	inteiro	ID do veículo	filtro
`type`	texto (enum)	type `ipva` `licenciamento` `dpvat` `servicos_bancarios` `multa_semob` `multa_detran` `outro`	filtro
`reference_year`	inteiro	reference year	filtroordenar
`description`	texto	Descrição
`amount`	decimal (string)	Valor	ordenar
`due_date`	data	Vencimento	ordenar
`status`	texto (enum)	Situação `pendente` `quitado` `parcelado` `isento` `vencido`	filtro
`sync_source`	texto	sync source
`synced_at`	data-hora	synced at
`created_at`	data-hora	Criado em
`updated_at`	data-hora	Atualizado em

Exemplo do objeto200 OK

{
    "id": 1024,
    "vehicle_id": 512,
    "type": "ipva",
    "reference_year": 1,
    "description": "Aluguel semanal",
    "amount": "150.00",
    "due_date": "2026-10-15",
    "status": "pendente",
    "sync_source": "texto",
    "synced_at": "2026-10-08T14:30:00-03:00",
    "created_at": "2026-10-08T14:30:00-03:00",
    "updated_at": "2026-10-08T14:30:00-03:00"
}

GET Listar

Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`pagina`	inteiro	Página (padrão 1)
`por_pagina`	inteiro	1 a 200 (padrão 50)
`ordenar`	texto	Aceita: `id`, `due_date`, `reference_year`, `amount` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`vehicle_id`	inteiro	ID do veículo — valor exato ou lista separada por vírgula
`type`	texto (enum)	type — valor exato ou lista separada por vírgula `ipva` `licenciamento` `dpvat` `servicos_bancarios` `multa_semob` `multa_detran` `outro`
`reference_year`	inteiro	reference year — valor exato ou lista separada por vírgula
`status`	texto (enum)	Situação — valor exato ou lista separada por vírgula `pendente` `quitado` `parcelado` `isento` `vencido`
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (pela coluna de atualização)
`incluir`	texto	Só no detalhe. Relações: `veiculo`

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/debitos_veiculares?por_pagina=20" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/debitos_veiculares?por_pagina=20');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/debitos_veiculares?por_pagina=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/debitos_veiculares?por_pagina=20",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": [
        {
            "id": 1024,
            "vehicle_id": 512,
            "type": "ipva",
            "reference_year": 1,
            "description": "Aluguel semanal",
            "amount": "150.00",
            "due_date": "2026-10-15",
            "status": "pendente"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

Use incluir para embutir relações (cada uma exige Ler no módulo relacionado).

Erro	Quando
`404 nao_encontrado`	Não existe ou está fora das carteiras da chave
`403 permissao_negada`	Sem Ler no módulo (ou numa relação pedida)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/debitos_veiculares/1024?incluir=veiculo" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/debitos_veiculares/1024?incluir=veiculo');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/debitos_veiculares/1024?incluir=veiculo', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/debitos_veiculares/1024?incluir=veiculo",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "vehicle_id": 512,
        "type": "ipva",
        "reference_year": 1,
        "description": "Aluguel semanal",
        "amount": "150.00",
        "due_date": "2026-10-15",
        "status": "pendente"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`veiculo`	Veículos	um registro	`/v1/debitos_veiculares/{id}/veiculo`

GET Exportar em lote

Até 1000 registros por chamada, paginando por cursor. Requer Ler e Exportar. Aceita os mesmos filtros da listagem e formato=csv. Detalhes no guia Exportação em lote.

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/debitos_veiculares/exportar?limite=1000" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/debitos_veiculares/exportar?limite=1000');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/debitos_veiculares/exportar?limite=1000', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/debitos_veiculares/exportar?limite=1000",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

POST Cadastrar débito

Cadastrar débito. Requer criar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`vehicle_id`	inteiro	obrigatório
`type`	enum	obrigatório	`ipva` `licenciamento` `dpvat` `servicos_bancarios` `multa_semob` `multa_detran` `outro`
`reference_year`	inteiro	opcional
`description`	texto	opcional	(até 2000 caracteres)
`amount`	decimal	obrigatório
`due_date`	data	opcional
`status`	enum	opcional	`pendente` `quitado` `parcelado` `isento` `vencido`

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/debitos_veiculares" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"vehicle_id":512,"type":"ipva","reference_year":2026,"amount":"1250.00","due_date":"2026-03-15"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/debitos_veiculares');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'vehicle_id' => 512,
    'type' => 'ipva',
    'reference_year' => 2026,
    'amount' => '1250.00',
    'due_date' => '2026-03-15',
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/debitos_veiculares', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "vehicle_id": 512,
      "type": "ipva",
      "reference_year": 2026,
      "amount": "1250.00",
      "due_date": "2026-03-15"
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/debitos_veiculares",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "vehicle_id": 512,
        "type": "ipva",
        "reference_year": 2026,
        "amount": "1250.00",
        "due_date": "2026-03-15"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta201 Created

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "vehicle_id": 512,
        "type": "ipva",
        "reference_year": 1,
        "description": "Aluguel semanal",
        "amount": "150.00",
        "due_date": "2026-10-15",
        "status": "pendente"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

PATCH Atualizar débito

Atualizar débito. Requer atualizar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`vehicle_id`	inteiro	opcional
`type`	enum	opcional	`ipva` `licenciamento` `dpvat` `servicos_bancarios` `multa_semob` `multa_detran` `outro`
`reference_year`	inteiro	opcional
`description`	texto	opcional	(até 2000 caracteres)
`amount`	decimal	opcional
`due_date`	data	opcional
`status`	enum	opcional	`pendente` `quitado` `parcelado` `isento` `vencido`

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X PATCH "https://apimapogos.sixinformatica.com/v1/debitos_veiculares/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"status":"quitado"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/debitos_veiculares/1024');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'status' => 'quitado',
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/debitos_veiculares/1024', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "status": "quitado"
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "PATCH",
    "https://apimapogos.sixinformatica.com/v1/debitos_veiculares/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "status": "quitado"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "vehicle_id": 512,
        "type": "ipva",
        "reference_year": 1,
        "description": "Aluguel semanal",
        "amount": "150.00",
        "due_date": "2026-10-15",
        "status": "pendente"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}