📡 Personal Finance Manager API

Welcome to the documentation for the Personal Finance Manager API — a secure backend built with Plumber in R for managing user account trees, transactions, and personal finances.

---

📘 API Reference Index

Filters

• Auth Filter

POST

• POST /register
• POST /login
• POST /deposit
• POST /withdraw
• POST /distribute
• POST /set_child_allocations
• POST /move_balance
• POST /change_account_status
• POST /set_priority
• POST /set_due_date
• POST /set_fixed_amount
• POST /set_account_type
• POST /set_account_freq
• POST /set_account_periods
• POST /register

GET

• GET /get_balance
• GET /get_transactions
• GET /list_child_accounts
• GET /list_all_accounts
• GET /find_account_by_name
• GET /find_account_by_uuid
• GET /compute_total_balance
• GET /compute_total_due
• GET /compute_total_due_within_days
• GET /spending
• GET /total_income
• GET /allocated_amount
• GET /income_utilization
• GET /walking_amount
• GET /get_account_status
• GET /get_priority
• GET /get_due_date
• GET /get_fixed_amount
• GET /get_account_type
• GET /get_account_freq
• GET /get_account_periods

Delete

• DELETE /delete

🔐 Authentication

Most endpoints require a valid Bearer JWT token in the Authorization header. Auth and rate limiting are enforced globally via a request filter.

Authorization: Bearer <your-token>

---

📦 Core Features

• Account creation and persistent storage (per user)
• Deposits, withdrawals, transfers, and account hierarchy logic
• Fully modular backend logic powered by the finman R package
• Works with Shiny, React, or any frontend via HTTP

---

🧭 How to Use the API

1. Register a user (/register)
2. Login to receive token (/login)
3. Use your token to make authenticated requests (e.g., /deposit, /accounts)
4. Each request is validated and tracked for rate limits

Need help? Contact: mutindafestus27@gmail.com

---

💖 Sponsors

Support my work through GitHub Sponsors!

GitHub Sponsors