Pular para o conteúdo
ZYRAQ / DOCS
API

Financeiro

Controlar receitas, despesas e comissões via API.

Financeiro

Em breve na API pública

O endpoint /api/v1/financial ainda não está disponível na API pública. Registros financeiros podem ser criados e gerenciados diretamente pelo painel da Zyraq.

Se você precisa registrar movimentações financeiras via API, entre em contato: suporte@zyraqgroup.com

O módulo financeiro da Zyraq controla receitas, despesas e custos ligados à operação.

Tipos de Registro

TipoDescrição
revenueReceita (vendas de veículos, comissões, etc.)
expenseDespesa operacional
costCusto de preparação de veículo (funilaria, mecânica, etc.)

Categorias

Receitas (revenue):

  • venda-veiculo — Venda de veículo
  • comissao — Comissão de venda
  • financiamento — Comissão de financiamento
  • seguro — Comissão de seguro

Despesas (expense):

  • aluguel — Aluguel da loja/pátio
  • pessoal — Folha de pagamento
  • marketing — Marketing e publicidade
  • tecnologia — Software e tecnologia

Custos (cost):

  • funilaria — Funilaria e pintura
  • mecanica — Revisão mecânica
  • higienizacao — Higienização e polimento
  • documentacao — Documentação e transferência

Status dos Registros

StatusDescrição
pendingPendente de pagamento
paidPago/Recebido
cancelledCancelado

Métodos de Pagamento

MétodoDescrição
pixPIX
boletoBoleto bancário
cartaoCartão de crédito/débito
transferenciaTransferência bancária
financiamentoFinanciamento bancário
dinheiroDinheiro
chequeCheque

O que está disponível hoje

Enquanto o endpoint financeiro não está disponível na API pública v1, você pode:

  • Registrar receitas, despesas e custos pelo painel da Zyraq
  • Acompanhar o DRE (Demonstrativo de Resultado) e fluxo de caixa pelo dashboard
  • Gerenciar contas a pagar e contas a receber pela interface
  • Categorizar e conciliar registros financeiros

Roadmap

Planejamos disponibilizar os seguintes endpoints na API pública:

GET  /api/v1/financial           — Listar registros financeiros
POST /api/v1/financial           — Criar registro
GET  /api/v1/financial/:id       — Buscar registro
PUT  /api/v1/financial/:id       — Atualizar registro
DELETE /api/v1/financial/:id     — Cancelar registro
GET  /api/v1/financial/summary   — Resumo financeiro por período
GET  /api/v1/financial/overdue   — Registros em atraso