Pular para o conteúdo

Despesas

Gerencie despesas pessoais e da empresa separadamente. Cada tipo possui CRUD completo com filtros, resumos e categorizacao.

Despesas Pessoais

GET/api/expenses/personal

Lista despesas pessoais com paginacao e filtros.

Parametros

NomeTipoObrigatorioDescricao
page(query)integerNaoPagina(default: 1)
limit(query)integerNaoItens por pagina(default: 20)
type(query)stringNaoTipo de despesa
category(query)stringNaoCategoria
startDate(query)stringNaoData inicio (YYYY-MM-DD)
endDate(query)stringNaoData fim (YYYY-MM-DD)
bash
curl -s "https://flow.seudominio.com/api/expenses/personal?category=alimentacao&startDate=2026-02-01" \
  -H "Authorization: Bearer $TOKEN" | jq .
200Lista de despesas pessoais
json
{
  "success": true,
  "data": {
    "expenses": [
      {
        "id": "clx...",
        "description": "Almoco reuniao cliente",
        "amount": 85.00,
        "category": "alimentacao",
        "date": "2026-02-14",
        "type": "variable"
      }
    ],
    "total": 28,
    "page": 1,
    "limit": 20
  }
}
POST/api/expenses/personal

Registra uma nova despesa pessoal.

Body

NomeTipoObrigatorioDescricao
descriptionstringSimDescricao da despesa
amountnumberSimValor
categorystringSimCategoria
datestringSimData (YYYY-MM-DD)
typestringNaoTipo (fixed, variable)
curl -X POST "https://flow.seudominio.com/api/expenses/personal" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Almoco reuniao cliente",
    "amount": 85.00,
    "category": "alimentacao",
    "date": "2026-02-14"
  }'
GET/api/expenses/personal/{id}

Retorna detalhes de uma despesa pessoal.

PUT/api/expenses/personal/{id}

Atualiza uma despesa pessoal.

bash
curl -X PUT "https://flow.seudominio.com/api/expenses/personal/clx123" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 95.00 }'
DELETE/api/expenses/personal/{id}

Remove uma despesa pessoal.

GET/api/expenses/personal/summary

Resumo de despesas pessoais.

200Resumo pessoal
json
{
  "success": true,
  "data": {
    "totalExpenses": 2850.00,
    "byCategory": {
      "alimentacao": 650.00,
      "transporte": 420.00,
      "saude": 380.00,
      "educacao": 1400.00
    },
    "count": 28
  }
}

Despesas da Empresa

GET/api/expenses/company

Lista despesas da empresa com paginacao e filtros.

Parametros

NomeTipoObrigatorioDescricao
page(query)integerNaoPagina(default: 1)
limit(query)integerNaoItens por pagina(default: 20)
type(query)stringNaoTipo de despesa
category(query)stringNaoCategoria
startDate(query)stringNaoData inicio (YYYY-MM-DD)
endDate(query)stringNaoData fim (YYYY-MM-DD)
bash
curl -s "https://flow.seudominio.com/api/expenses/company?category=infraestrutura" \
  -H "Authorization: Bearer $TOKEN" | jq .
POST/api/expenses/company

Registra uma nova despesa da empresa.

Body

NomeTipoObrigatorioDescricao
descriptionstringSimDescricao da despesa
amountnumberSimValor
categorystringSimCategoria
datestringSimData (YYYY-MM-DD)
typestringNaoTipo (fixed, variable)
bash
curl -X POST "https://flow.seudominio.com/api/expenses/company" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Licenca software design",
    "amount": 250.00,
    "category": "software",
    "date": "2026-02-10",
    "type": "fixed"
  }'
GET/api/expenses/company/{id}

Retorna detalhes de uma despesa da empresa.

PUT/api/expenses/company/{id}

Atualiza uma despesa da empresa.

DELETE/api/expenses/company/{id}

Remove uma despesa da empresa.

GET/api/expenses/company/summary

Resumo de despesas da empresa.

Parametros

NomeTipoObrigatorioDescricao
startDate(query)stringNaoData inicio
endDate(query)stringNaoData fim
200Resumo empresa
json
{
  "success": true,
  "data": {
    "totalExpenses": 12500.00,
    "byCategory": {
      "infraestrutura": 4500.00,
      "software": 3200.00,
      "marketing": 2800.00,
      "escritorio": 2000.00
    },
    "count": 45
  }
}