Frota · Referência

Licenciamento

Situação do licenciamento anual (DETRAN), boleto e gravame por veículo.

Permissão: licenciamentoAções: ler · exportar

GET/v1/licenciamentoListar GET/v1/licenciamento/{id}Detalhar GET/v1/licenciamento/exportarExportar em lote

O objeto licenciamento

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`vehicle_id`	inteiro	ID do veículo	filtro
`placa`	texto	Placa	filtro
`renavam`	texto	renavam
`exercicio`	texto	exercicio	filtro
`data_limite`	data	data limite	ordenar
`valor_total`	decimal (string)	valor total
`valor_licenciamento`	decimal (string)	valor licenciamento
`proprietario`	texto	proprietario
`itens`	objeto	itens
`situacao`	texto	situacao	filtro
`erro`	texto	erro
`consulted_at`	data-hora	consulted at
`linha_digitavel`	texto	linha digitavel
`codigo_barras`	texto	codigo barras
`boleto_venc`	data	boleto venc
`boleto_valor`	decimal (string)	boleto valor
`gravame_financeira`	texto	gravame financeira
`gravame_restricao`	texto	gravame restricao
`gravame_contrato`	texto	gravame contrato
`gravame_data`	data	gravame data
`gravame_situacao`	texto	gravame situacao
`gravame_at`	data-hora	gravame at
`observacao`	texto	observacao
`observacao_at`	data-hora	observacao at
`updated_at`	data-hora	Atualizado em	ordenar

Exemplo do objeto200 OK

{
    "id": 1024,
    "vehicle_id": 512,
    "placa": "ABC1D23",
    "renavam": "01234567890",
    "exercicio": "texto",
    "data_limite": "2026-10-15",
    "valor_total": "450.00",
    "valor_licenciamento": "150.00",
    "proprietario": "texto",
    "itens": {},
    "situacao": "texto",
    "erro": "texto",
    "consulted_at": "2026-10-08T14:30:00-03:00",
    "linha_digitavel": "texto",
    "codigo_barras": "texto",
    "boleto_venc": "2026-10-15",
    "boleto_valor": "150.00",
    "gravame_financeira": "texto",
    "gravame_restricao": "texto",
    "gravame_contrato": "texto",
    "gravame_data": "2026-10-15",
    "gravame_situacao": "texto",
    "gravame_at": "2026-10-08T14:30:00-03:00",
    "observacao": "texto",
    "observacao_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`, `data_limite`, `updated_at` — 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
`placa`	texto	Placa — valor exato ou lista separada por vírgula
`situacao`	texto	situacao — valor exato ou lista separada por vírgula
`exercicio`	texto	exercicio — 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 (pela coluna de atualização)

Requisição

Testar ▸

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

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/licenciamento?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/licenciamento?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/licenciamento?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,
            "placa": "ABC1D23",
            "renavam": "01234567890",
            "exercicio": "texto",
            "data_limite": "2026-10-15",
            "valor_total": "450.00",
            "valor_licenciamento": "150.00"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

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/licenciamento/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/licenciamento/1024');
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/licenciamento/1024', {
  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/licenciamento/1024",
    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,
        "placa": "ABC1D23",
        "renavam": "01234567890",
        "exercicio": "texto",
        "data_limite": "2026-10-15",
        "valor_total": "450.00",
        "valor_licenciamento": "150.00"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

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

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/licenciamento/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/licenciamento/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/licenciamento/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"])