📘 UI Expected Routes Documentation

This repository contains UI-driven API route documentation.
Each file represents the expected backend routes required to support a specific UI feature or screen.

⚠️ This repository does not contain backend implementation code.
It defines the API contract between Frontend and Backend teams.

---

🎯 Purpose

• Document expected API endpoints based on UI requirements
• Align frontend and backend before implementation
• Reduce misunderstandings and rework
• Act as a single source of truth for UI → API expectations

---

📂 Repository Structure

ui-routes/ ├── admin.md # Admin dashboard & management routes ├── ai-invoice.md # AI invoice parsing & automation routes ├── ask-ai.md # Ask AI / assistant-related routes ├── bills.md # Bills management routes ├── debt.md # Debts & financial overview routes ├── expenses.md # Expenses tracking routes ├── profile.md # User profile & settings routes ├── reminder.md # Reminder creation & scheduling routes └── README.md # Repository overview (this file)

---

🧩 File Responsibilities

admin.md

• Admin dashboards
• System statistics
• User management & moderation routes

ai-invoice.md

• Upload invoice images / PDFs
• AI-powered invoice parsing
• Auto-fill bill or expense data

ask-ai.md

• Ask AI financial questions
• AI insights, summaries, or recommendations

bills.md

• Create, update, delete bills
• Group & individual bills
• Bill payment status
• Smart bill parsing

debt.md

• Debt creation & management
• Debt summary statistics
• Paid / unpaid / overdue debts

expenses.md

• Expense tracking
• Categorized expenses
• Recurring expense reminders

profile.md

• User profile data
• Account settings
• Preferences & personal info

reminder.md

• Reminder creation
• Scheduling (daily / weekly / monthly)
• Activate / deactivate reminders

---

🛠 How to Use This Repo

Frontend Team

• Use these files to know which APIs to call
• Build UI independently from backend progress
• Validate responses against documented expectations

Backend Team

• Implement APIs as defined
• Treat this repo as an API contract
• Discuss and update docs before changing routes

---

📐 Conventions

• HTTP methods follow REST standards
• Endpoints use snake_case
• Dates follow ISO-8601
• JSON examples represent expected shapes, not strict schemas

---

🔄 Change Workflow

1. UI proposes a new route or change
2. Update the relevant .md file
3. Review with backend
4. Implement backend logic

---

📌 Notes

• This repository is documentation-only
• Backend may have internal or extra endpoints not listed here
• Any breaking change must be reflected in this repo first

---

🛡️ Guardians Team Members

• Moamen Yazouri (Team Lead)
  https://github.com/Moamen-Yazouri

• Ayat Ayoub
  https://github.com/ayatayoub20

• Shadi Sbaih
  https://github.com/ShadiSbaih

• Hamza Awad
  https://github.com/HamzaAbuAmrea9

• Isaac
  https://github.com/isaackq**