Transacoes

Registre e gerencie transacoes financeiras (receitas e despesas). Inclui filtros avancados, resumos e operacoes em lote.

GET/api/transactions

Lista transacoes com paginacao e filtros avancados.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina(default: `1`)
`limit`(query)	`integer`	Nao	Itens por pagina(default: `20`)
`type`(query)	`string`	Nao	income ou expense
`status`(query)	`string`	Nao	paid ou pending
`category`(query)	`string`	Nao	Categoria
`clientId`(query)	`string`	Nao	Filtrar por cliente
`startDate`(query)	`string`	Nao	Data inicio (YYYY-MM-DD)
`endDate`(query)	`string`	Nao	Data fim (YYYY-MM-DD)
`scope`(query)	`string`	Nao	personal ou company
`search`(query)	`string`	Nao	Busca por descricao

bash

curl -s "https://flow.seudominio.com/api/transactions?type=income&status=paid&startDate=2026-01-01&endDate=2026-02-15" \
  -H "Authorization: Bearer $TOKEN" | jq .

200Lista paginada

json

{
  "success": true,
  "data": {
    "transactions": [
      {
        "id": "clx...",
        "date": "2026-02-15",
        "description": "Servico de consultoria",
        "amount": 5000.00,
        "type": "income",
        "status": "paid",
        "category": "servicos",
        "clientId": "clx..."
      }
    ],
    "total": 120,
    "page": 1,
    "limit": 20
  }
}

POST/api/transactions

Registra uma nova transacao financeira.

Body

Nome	Tipo	Obrigatorio	Descricao
`date`	`string`	Sim	Data (YYYY-MM-DD)
`description`	`string`	Sim	Descricao
`amount`	`number`	Sim	Valor
`type`	`string`	Sim	income ou expense
`category`	`string`	Sim	Categoria
`status`	`string`	Nao	paid ou pending(default: `pending`)
`scope`	`string`	Nao	personal ou company
`clientId`	`string`	Nao	ID do cliente associado

curl -X POST "https://flow.seudominio.com/api/transactions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2026-02-15",
    "description": "Servico de consultoria - Empresa ABC",
    "amount": 5000.00,
    "type": "income",
    "category": "servicos",
    "status": "paid",
    "clientId": "clx123"
  }'

GET/api/transactions/{id}

Obtem detalhes de uma transacao.

PUT/api/transactions/{id}

Atualiza uma transacao existente.

DELETE/api/transactions/{id}

Remove uma transacao.

Resumo

GET/api/transactions/summary

Resumo de transacoes por periodo.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`startDate`(query)	`string`	Nao	Data inicio
`endDate`(query)	`string`	Nao	Data fim

200Resumo financeiro

json

{
  "success": true,
  "data": {
    "totalIncome": 85000.00,
    "totalExpense": 32000.00,
    "balance": 53000.00,
    "transactionCount": 120
  }
}

Analytics

GET/api/transactions/by-category

Transacoes agrupadas por categoria.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`type`(query)	`string`	Nao	income ou expense
`startDate`(query)	`string`	Nao	Data inicio
`endDate`(query)	`string`	Nao	Data fim

GET/api/transactions/monthly

Dados mensais para graficos.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`months`(query)	`integer`	Nao	Numero de meses(default: `6`)

GET/api/transactions/yoy

Comparacao ano a ano (Year-over-Year).

Operacoes em Lote

POST/api/transactions/bulk-delete

Remove multiplas transacoes de uma vez.

Body

Nome	Tipo	Obrigatorio	Descricao
`ids`	`array`	Sim	Array de IDs das transacoes

bash

curl -X POST "https://flow.seudominio.com/api/transactions/bulk-delete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "ids": ["clx1", "clx2", "clx3"] }'

POST/api/transactions/bulk-status

Atualiza o status de multiplas transacoes.

Body

Nome	Tipo	Obrigatorio	Descricao
`ids`	`array`	Sim	Array de IDs
`status`	`string`	Sim	paid ou pending