Frota · Referência

Multas

Multas de trânsito por veículo, com responsável (contrato), valores, taxa administrativa e vínculo com acordo.

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

GET/v1/multasListar GET/v1/multas/{id}Detalhar GET/v1/multas/{id}/veiculoRelação: Veículos GET/v1/multas/{id}/locacaoRelação: Locações GET/v1/multas/{id}/acordoRelação: Acordos GET/v1/multas/exportarExportar em lote POST/v1/multasRegistrar multa PATCH/v1/multas/{id}Corrigir dados da multa

O objeto multas

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`vehicle_id`	inteiro	ID do veículo	filtro
`rental_id`	inteiro	ID da locação	filtro
`fine_number`	texto	AIT (número do auto de infração)	filtro
`description`	texto	Descrição
`orgao_autuador`	texto	orgao autuador
`municipio`	texto	municipio
`local_infracao`	texto	local infracao
`pontos_gravidade`	texto	pontos gravidade
`situacao_detran`	texto	situacao detran	filtro
`data_hora_infracao`	texto	data hora infracao
`issue_date`	data	issue date	ordenar
`due_date`	data	Vencimento
`fine_amount`	decimal (string)	fine amount
`admin_fee`	decimal (string)	Taxa administrativa
`total_amount`	decimal (string)	Multa + taxa administrativa	ordenar
`status`	texto (enum)	pendente \| cobrado \| adicionado_acordo \| pago \| contestado \| pago_cliente `pendente` `cobrado` `adicionado_acordo` `pago` `contestado` `pago_cliente`	filtro
`added_to_agreement_id`	inteiro	added to agreement id	filtro
`consulted_at`	data-hora	consulted at
`baixa_obs`	texto	baixa obs
`baixa_user`	texto	baixa user
`baixa_at`	data-hora	baixa at
`client_notified_at`	data-hora	client notified at
`team_notified_at`	data-hora	team notified at
`created_at`	data-hora	Criado em	ordenar
`updated_at`	data-hora	Atualizado em
`log_origem`	texto	Origem do registro (sistema novo/antigo)

Exemplo do objeto200 OK

{
    "id": 1024,
    "vehicle_id": 512,
    "rental_id": 512,
    "fine_number": "PA0001234",
    "description": "Aluguel semanal",
    "orgao_autuador": "DETRAN-PA",
    "municipio": "Belém",
    "local_infracao": "texto",
    "pontos_gravidade": "texto",
    "situacao_detran": "texto",
    "data_hora_infracao": "texto",
    "issue_date": "2026-10-15",
    "due_date": "2026-10-15",
    "fine_amount": "150.00",
    "admin_fee": "50.00",
    "total_amount": "450.00",
    "status": "pendente",
    "added_to_agreement_id": 512,
    "consulted_at": "2026-10-08T14:30:00-03:00",
    "baixa_obs": "texto",
    "baixa_user": "texto",
    "baixa_at": "2026-10-08T14:30:00-03:00",
    "client_notified_at": "2026-10-08T14:30:00-03:00",
    "team_notified_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",
    "log_origem": "sistema_novo"
}

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`, `issue_date`, `created_at`, `total_amount` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`q`	texto	Busca em: `fine_number`, `description`
`status`	texto (enum)	pendente \| cobrado \| adicionado_acordo \| pago \| contestado \| pago_cliente — valor exato ou lista separada por vírgula `pendente` `cobrado` `adicionado_acordo` `pago` `contestado` `pago_cliente`
`vehicle_id`	inteiro	ID do veículo — valor exato ou lista separada por vírgula
`rental_id`	inteiro	ID da locação — valor exato ou lista separada por vírgula
`added_to_agreement_id`	inteiro	added to agreement id — valor exato ou lista separada por vírgula
`fine_number`	texto	AIT (número do auto de infração) — valor exato ou lista separada por vírgula
`situacao_detran`	texto	situacao detran — valor exato ou lista separada por vírgula
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (pelo registro de alterações do Mapogos)
`incluir`	texto	Só no detalhe. Relações: `veiculo`, `locacao`, `acordo`

Requisição

Testar ▸

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

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/multas?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/multas?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/multas?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,
            "rental_id": 512,
            "fine_number": "PA0001234",
            "description": "Aluguel semanal",
            "orgao_autuador": "DETRAN-PA",
            "municipio": "Belém",
            "local_infracao": "texto"
        }
    ],
    "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/multas/1024?incluir=veiculo" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/multas/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/multas/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/multas/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,
        "rental_id": 512,
        "fine_number": "PA0001234",
        "description": "Aluguel semanal",
        "orgao_autuador": "DETRAN-PA",
        "municipio": "Belém",
        "local_infracao": "texto"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`veiculo`	Veículos	um registro	`/v1/multas/{id}/veiculo`
`locacao`	Locações	um registro	`/v1/multas/{id}/locacao`
`acordo`	Acordos	um registro	`/v1/multas/{id}/acordo`

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/multas/exportar?limite=1000" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/multas/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/multas/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/multas/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 Registrar multa

Registrar multa (taxa adm. 50%, vincula contrato ativo e roda a automação de multas do sistema). Requer criar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`vehicle_id`	inteiro	obrigatório
`fine_number`	texto	obrigatório	AIT (até 50 caracteres)
`description`	texto	obrigatório	(até 2000 caracteres)
`issue_date`	data	obrigatório
`due_date`	data	opcional
`fine_amount`	decimal	obrigatório	Taxa administrativa = 50% e total = multa + taxa (regra do painel)

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/multas" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"vehicle_id":512,"fine_number":"PA1234567","description":"Avançar sinal vermelho","issue_date":"2026-10-01","fine_amount":"293.47"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/multas');
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,
    'fine_number' => 'PA1234567',
    'description' => 'Avançar sinal vermelho',
    'issue_date' => '2026-10-01',
    'fine_amount' => '293.47',
  ]),
]);
$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/multas', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "vehicle_id": 512,
      "fine_number": "PA1234567",
      "description": "Avançar sinal vermelho",
      "issue_date": "2026-10-01",
      "fine_amount": "293.47"
  }),
});
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/multas",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "vehicle_id": 512,
        "fine_number": "PA1234567",
        "description": "Avançar sinal vermelho",
        "issue_date": "2026-10-01",
        "fine_amount": "293.47"
    },
    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,
        "rental_id": 512,
        "fine_number": "PA0001234",
        "description": "Aluguel semanal",
        "orgao_autuador": "DETRAN-PA",
        "municipio": "Belém",
        "local_infracao": "texto"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

PATCH Corrigir dados da multa

Corrigir dados da multa (recalcula taxa e total). Requer atualizar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`vehicle_id`	inteiro	opcional
`fine_number`	texto	opcional	AIT (até 50 caracteres)
`description`	texto	opcional	(até 2000 caracteres)
`issue_date`	data	opcional
`due_date`	data	opcional
`fine_amount`	decimal	opcional	Taxa administrativa = 50% e total = multa + taxa (regra do painel)

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/multas/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"due_date":"2026-11-10"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/multas/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([
    'due_date' => '2026-11-10',
  ]),
]);
$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/multas/1024', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "due_date": "2026-11-10"
  }),
});
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/multas/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "due_date": "2026-11-10"
    },
    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,
        "rental_id": 512,
        "fine_number": "PA0001234",
        "description": "Aluguel semanal",
        "orgao_autuador": "DETRAN-PA",
        "municipio": "Belém",
        "local_infracao": "texto"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

Eventos de webhook

multa.criada — veja Webhooks.