Módulos
Cada módulo tem sua página com endpoints, parâmetros, campos e exemplos. As permissões são concedidas por módulo na criação da chave.
Operação
/v1/clientesLocatários e compradores: identificação, CNH, contato e endereço.
/v1/locacoesContratos de locação (aluguel normal/particular) e de venda, com ciclo de cobrança e situação.
/v1/pos_encerramentoEncerramento do contrato (KM, avarias, caução, multas, saldo financeiro) e o acompanhamento de pendências após o encerramento. Pela API: leitura comp…
/v1/vistoriasVistorias 360° de entrada/saída: KM, avarias por área, fotos e análise de IA.
Financeiro
/v1/pagamentosCobranças dos contratos (aluguel, taxas, entradas) com situação, vencimento e baixa. A escrita segue exatamente as regras do painel (baixa, recebimen…
/v1/cobrancas_pixCobranças PIX emitidas nos bancos (Sicredi/Itaú/Mercado Pago) e sua situação. O código copia-e-cola só sai com permissão de dados pessoais; QR em ima…
/v1/taxasTaxas de desbloqueio (cobranças cuja descrição começa com "Taxa de Desbloqueio"): pagar, estornar e cancelar seguem a tela Taxas.
/v1/acordosAcordos/parcelamentos de débitos (multas, avarias, atrasos) com itens e parcelas.
/v1/despesasDespesas da empresa (fornecedor, categoria, NF, veículo/OS vinculados).
/v1/lancamentos_financeirosLançamentos avulsos do financeiro (referência, valor, vencimento, situação).
/v1/conciliacao_bancariaTransações bancárias importadas e o vínculo com pagamentos/despesas/acordos.
Frota
/v1/veiculosFrota: cadastro, situação, KM, restrição e estado do rastreador. Bloqueio/desbloqueio NÃO é feito pela API.
/v1/multasMultas de trânsito por veículo, com responsável (contrato), valores, taxa administrativa e vínculo com acordo.
/v1/debitos_veicularesIPVA, licenciamento, DPVAT e outros débitos por veículo.
/v1/licenciamentoSituação do licenciamento anual (DETRAN), boleto e gravame por veículo.
/v1/real_condutorCondutor principal indicado na SENATRAN por placa.
/v1/manutencao_preditivaPróximas manutenções previstas por veículo (KM e data), com situação ok/próxima/atrasada.
Oficina
/v1/ordens_servicoOS da oficina: abertura, diagnóstico, peças e serviços, conclusão.
/v1/ordens_servico_legadoOS do sistema anterior (somente consulta histórica).
/v1/orcamentosOrçamentos de peças e serviços para clientes/veículos.
Estoque
/v1/estoque_pecasPeças cadastradas: código, categoria, preço, estoque mínimo e atual.
/v1/estoque_movimentacoesEntradas, saídas e ajustes de estoque (com referência à OS quando houver).
/v1/estoque_saldoPosição atual do estoque por peça ativa (estoque atual × mínimo).
Atendimento
/v1/central_atendimentoAtendimentos (tickets) da Central: contato, setor, atendente, situação e tempos de resposta. Envio de mensagens não é feito pela API.
/v1/whatsapp_mensagensMensagens automáticas enviadas pelo sistema (cobranças, avisos), com situação do envio.
/v1/pre_leadsInteressados captados pelo WhatsApp e a triagem da IA (documentos, score, decisão).
Arquivos
/v1/drivePastas e arquivos do Drive interno (metadados). Download em /v1/drive/{id}/download exige também a permissão de dados pessoais.
/v1/documentos_iaDocumentos gerados pela IA (notificações, cartas, relatórios).
Administração
/v1/usuariosUsuários do painel. Senhas e hashes nunca são expostos. Somente leitura pela API (criar usuário por chave de API permitiria escalada de privilégio).
/v1/cargosCargos (perfis) do painel e as permissões de cada um. Somente leitura.
/v1/modelos_contratoModelos (templates HTML) usados para gerar contratos de aluguel e venda, com histórico de versões. Somente leitura (texto jurídico).
/v1/notificacoesNotificações internas exibidas no sino do painel (pagamentos recebidos, OS, alertas).
Relatórios
Dashboard, financeiro, frota, DRE, fluxo de caixa e ROI: veja Relatórios e cruzamentos.