Guia

Relatórios e cruzamentos

Indicadores prontos e consultas que cruzam módulos.

Rotas

Rota	Permissão	Parâmetros	Conteúdo
GET `/v1/dashboard`	`dashboard`	carteira	Indicadores gerais do sistema: frota por status, locações ativas, cobranças pendentes e em atraso, recebido no dia e no mês, acordos e OS abertas.
GET `/v1/relatorios/financeiro`	`relatorios_financeiro`	de, ate, carteira	Recebido, a receber e em atraso num período (?de=AAAA-MM-DD&ate=AAAA-MM-DD&carteira=), somando aluguéis, taxas e parcelas de acordo. Contratos com receita oculta ficam fora, igual ao painel.
GET `/v1/relatorios/frota`	`relatorios_frota`	carteira	Situação da frota: disponível, locado, em manutenção, inativo, vendido e bloqueado no rastreador, por carteira.
GET `/v1/relatorios/dre`	`financeiro_visao`	de, ate	DRE do período, previsão de fluxo de caixa 30/60/90 e ROI por veículo — os mesmos cálculos das telas DRE & Lucro, Fluxo de Caixa e ROI por Veículo.
GET `/v1/relatorios/fluxo_caixa`	`financeiro_visao`	dias (7–180)	DRE do período, previsão de fluxo de caixa 30/60/90 e ROI por veículo — os mesmos cálculos das telas DRE & Lucro, Fluxo de Caixa e ROI por Veículo.
GET `/v1/relatorios/roi_veiculos`	`financeiro_visao`	de, ate	DRE do período, previsão de fluxo de caixa 30/60/90 e ROI por veículo — os mesmos cálculos das telas DRE & Lucro, Fluxo de Caixa e ROI por Veículo.
GET `/v1/carteiras`	`carteiras`	—	Carteiras do Mapogos (mapogos = frota própria, premium = frota Premium/particular). Uma chave pode ser restrita a uma ou mais carteiras.

Exemplo: relatório financeiro do mês

Recebido, a receber e em atraso por carteira. Também traz, em painel, os mesmos números dos cards do Dashboard do Mapogos.

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/relatorios/financeiro?de=2026-10-01&ate=2026-10-31" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/relatorios/financeiro?de=2026-10-01&ate=2026-10-31');
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/relatorios/financeiro?de=2026-10-01&ate=2026-10-31', {
  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/relatorios/financeiro?de=2026-10-01&ate=2026-10-31",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Cruzamentos

Rota	Retorna
`GET /v1/locacoes/{id}?incluir=cliente,veiculo,pagamentos,vistorias`	Locação com dados relacionados
`GET /v1/clientes/{id}/locacoes`	Contratos do cliente (paginado)
`GET /v1/clientes/{id}/pagamentos`	Cobranças de todos os contratos do cliente
`GET /v1/veiculos/{id}/historico`	Linha do tempo: locações, OS, multas, vistorias e rastreador
`GET /v1/acordos/{id}/parcelas`	Parcelas do acordo