Reference · v1.5.0
HomeBook User Manual
Every screen in HomeBook, what it shows, and how to get there. Organized in the order you'd actually meet each screen — start with how the app is laid out, then work through each module.
Updated for version 1.5 — anything added since 1.0 is marked NEW.
Onboarding & Auth
What you see before you're using the app day to day. Sign-in is opt-in throughout — HomeBook works fully without ever reaching Login.
Welcome
welcomeOn this screen
- House illustration, "HomeBook" title, tagline
- 5 checkmarked value props (track things, warranties, maintenance, documents, family sharing)
Actions
- "Get Started" → Onboarding
Onboarding
onboardingOn this screen
- 4-page swipeable carousel (Home / Organize / Money / Family themes)
- Dot page indicator
Actions
- "Skip" (hidden on last page)
- "Next" → advances; "Get started" on last page → Success
Login
loginOn this screen
- Email, Password fields (show/hide toggle)
- Mode toggle: Login ↔ Create Account
- "Continue with Google" (real Google logo)
Actions
- "Forgot password?" → reset-link dialog
- Submit → pops back on success; errors show in a red banner
Success
successOn this screen
- Illustration + title + message
Actions
- Single CTA button (e.g. "Go to Home")
Home dashboard
homeTab 1. A rolled-up view of your whole household — every section below only appears when it has something to show.
Header
- Time-of-day greeting + "Your Home"
- Bell → Notifications NEW (dot when something is unread)
- Search icon → Search
- "Needs attention" badge when things are overdue
Sections, top to bottom
- Keep your HomeBook safe / sync status card NEW — suggests signing in when you have data only on this phone; after sign-in shows "Syncing…" or "Waiting to sync" with Retry, and disappears once everything is synced
- Home banner — around a festival or family occasion it turns into a warm festive card NEW (see Family & Occasions)
- Needs attention (overdue reminders)
- Smart Capture pending review — with a line saying how many came from payment notifications NEW
- Quick access (Things/Vehicles/Documents/Reminders counts)
- Money overview + monthly spending + insights
- Upcoming reminders · Recent purchases
- Active recurring payments · Savings goals
- Recently added things
Things
thingsTab 2. Appliances, furniture, electronics — anything you own that's worth tracking.
Things list
On this screen
- Search field
- Category filter chips: All / Appliances / Electronics / Vehicles (jumps to Vehicles) / Furniture / Other
- Filtered card list
Actions
- Header "+" → Add Thing
- Tap a card → Thing detail
Add / Edit Thing
addThingFields
- Name · Category (dropdown)
- Brand · Model
- Purchase date · Purchase price
Actions
- "Save / Update Thing"
Thing detail
thingDetailOn this screen
- Photo hero, name, brand/model
- "Active" warranty pill if applicable
- Purchase · Warranty · Maintenance (last/next service) sections
- Linked Expenses (total + recent 3)
- Documents · Reminders sections
- Attachments — photos and PDFs NEW
Actions
- "Add service" / "Edit thing"
- Per-section "+ Add" (warranty/expense/document/reminder)
- "Add file" in Attachments
- AppBar delete
Vehicles
vehiclesCars, bikes, anything with insurance, PUC, and its own running costs.
Vehicles list
On this screen
- Vehicle cards
- "Upcoming" section — insurance/PUC expiries sorted by date
Actions
- Header "+" → Add Vehicle
- Tap a card → Vehicle detail
Add / Edit Vehicle
addVehicleFields
- Photo (optional, camera/gallery)
- Name · Registration number
- Make · Model
- Purchase date
- Insurance expiry · PUC expiry
Actions
- "Save / Update Vehicle"
Vehicle detail
vehicleDetailOn this screen
- Photo hero, name, registration number
- "Vehicle health" — Insurance/PUC status
- 5 tabs: Overview · Service · Documents · Expenses · Reminders
- Overview tab: Attachments — RC, insurance papers, photos NEW
Actions
- "Add service" / "Edit vehicle"
- Per-tab "+ Add"
- AppBar delete
Documents
documentsAny file worth keeping — attach once, find it later.
Documents list
On this screen
- Search field
- Document cards, swipe/inline delete
Actions
- Header "+" → Add Document
Add / Edit Document
addDocumentFields
- Document type (dropdown) · Document name
- Issue date · Expiry date · Document number
- Attachments — one or more photos / PDFs: take a photo, choose photos, or choose a file
Actions
- Add, open or remove files
- "Save / Update Document"
Warranties
warrantiesKnow exactly when coverage runs out, before it does.
Warranties list
On this screen
- "OK" section
- "Expiring soon" section
Actions
- Header "+" → Add Warranty
- Delete via confirmation dialog
Add / Edit Warranty
addWarrantyFields
- Thing (dropdown — locked if opened from a Thing, or editing)
- Provider
- Start date · End date
- Warranty number (optional)
- Attachments — warranty card or invoice NEW
Actions
- "Save / Update Warranty"
Maintenance
maintenanceA service log for anything that needs upkeep — Things and Vehicles both feed the same list.
Maintenance list
On this screen
- "Upcoming" tiles
- "Recent services" tiles
Actions
- Header "+" → Add Service
- Delete
Add / Edit Service
addServiceFields
- Thing / Vehicle (combined dropdown — locked if preset or editing)
- Service date · Service type · Cost
- Provider · Notes
- Attachments — service bill or job card NEW
Actions
- "Save / Update Service"
Reminders
remindersTab 3. Renewal dates, service due dates — anything with a deadline.
Reminders list
On this screen
- Segmented toggle: Upcoming / Completed
- Cards with a mark-complete circle toggle
Actions
- Header "+" → Add Reminder
- Tap card → edit; toggle → complete/reopen; swipe → delete
Add / Edit Reminder
addReminderFields
- Title · Date
- Remind me (minutes-before dropdown)
- Repeat (stored for future use, not yet acted on)
- Related to — Thing/Vehicle (locked if preset)
Actions
- "Save / Update Reminder"
Money hub
moneyThe one screen that ties all your household money together for the month. It's the Money tab NEW (also reachable from Profile → Money).
On this screen
- Month switcher (can't advance past current month)
- Monthly Overview — Available, Income, Committed, Saved, Spent
- Budget progress card · Insights
Link rows
- Upcoming Money · Next 7 days (with the amount to keep aside) NEW
- Planned expenses NEW
- Money Calendar · Money Timeline NEW
- Expenses · Spending analytics NEW · Recurring · Savings · Income
- Transfers NEW
- Money waiting for you · Money you owe NEW
Expenses
expensesEvery expense, grouped by day, against your budget.
Expenses list
On this screen
- Month switcher · Budget progress card
- "Category budgets" link
- Category breakdown · day-grouped list with daily totals
- Header buttons: Spending analytics and PDF statement NEW
- Each row shows an icon for what it was (Swiggy → food delivery, Airtel → mobile) — never a company logo — and "Category · Subcategory" NEW
- List | Notebook switch — Notebook View writes the month out day by day, like an expense notebook, with your notes and each day's total; the choice is remembered on your phone NEW
- "Filter" button NEW — active filters show as removable chips with a "N expenses · ₹total" summary
Filter sheet NEW
- Category · Subcategory
- Amount range (min / max)
- Payment method · Merchant name or note
- Related Thing/Vehicle · Paid by
- Added from: Manually / Shared / Receipt / Recurring
- "Reset" / "Show N expenses"
Add / Edit Expense
addExpenseFields
- Amount · Merchant · Category — a grid of large category icons, including Loans & Debt and Personal NEW
- More detail (optional) — subcategory chips, e.g. Food → Restaurant / Cafe / Delivery NEW
- Date · Part of a plan (when a planned expense covers that date) NEW
- Paid with — Cash, UPI, Credit card, Debit card, Bank transfer, Net banking, Other, or Not specified NEW
- Paid by — shown once the household has two or more members NEW
- Related to — Thing/Vehicle (optional)
- Odometer (fuel entries only) · Notes
- Attachments — receipt or bill NEW
Actions
- "Save / Update Expense"
Expense detail
expenseDetailOn this screen
- Category icon + amount header
- Merchant, date, payment method, odometer
- Subcategory · Paid by NEW
- Related record card (tappable) · Notes
- Attachments NEW
Actions
- AppBar edit · AppBar delete
Spending analytics
expenseAnalyticsNEWOn this screen
- Month switcher (back to your first month with expenses)
- Month total · transactions · average per day · highest expense · no-spend days
- Change from last month, shown only once there's enough history; a month in progress is compared with the same days of last month
- Six-month trend (tap a month to open it)
- Categories chart with a ranked list
- Top merchants · Monthly insights
Actions
- Tap a category → its expenses for the month, with a "By type" breakdown (e.g. Loans & Debt → Home Loan EMI) NEW
- Tap a merchant → its whole history: total, count, average, last paid, trend
- "Statement" → PDF statement for what you're looking at
PDF statement
expenseStatementNEWChoose
- Period: this month, last month, an earlier month, custom dates, or all time
- Filters: the same as the Expenses filter sheet
- Live count and total as you change them
- Style: Professional, or Notebook — expenses written out by day NEW
The statement
- Summary, categories and merchants, then every expense with page numbers
- Each expense shows its date, merchant, "Category · Payment" and your note NEW
- "Preview" opens it in your phone's PDF viewer
- "Share" · "Save"
Category budgets
categoryBudgetsOn this screen
- One row per active category — icon, spent-of-budget (red if over)
Actions
- Inline amount field + checkmark to save, per row
Smart Expense Capture
smartCaptureTurn a receipt, payment message or (optionally) a payment notification into an Expense without typing it in — parsed entirely on-device, and always reviewed before it's added.
Capture entry
On this screen
- 2×2 action grid: Scan Receipt · Paste Transaction · Share to HomeBook · Add Manually
- "Detect payment notifications" row with its status (Android) NEW
- "Needs review" list of pending candidates
Actions
- Scan Receipt → camera/gallery → OCR parse
- Paste Transaction → text dialog
- Share to HomeBook → instructions (actually triggered from another app's share sheet)
- Add Manually → Add Expense
- Detect payment notifications → Smart Expense Detection
Smart Expense Detection NEW
smartDetectionOn this screen
- Switch with status: Off · On — watching for payment notifications · "Notification access is currently disabled." with Enable
- How it works
- Privacy — notification text processed in memory on the phone, never saved or uploaded; only amount, merchant, date, payment method, category and a hashed reference kept until you review
- Turn off (when on)
Actions
- Switch on → HomeBook's explanation sheet → "Enable Notification Access" opens Android's Notification access page for "HomeBook payment detection"; "Not now" changes nothing
- Enable → Android's page again (only when you tap it)
- Turn off → stops immediately; a snackbar offers Android Settings to also remove the access
Review capture
smartCaptureReviewOn this screen
- Confidence label — or, for a payment notification, what it looks like: Expense / Income / Refund / Transfer detected, or "Review transaction" NEW
- "Source: payment notification" line, and a hint for transfers and refunds NEW
- Duplicate-detection banner if flagged
- Editable pre-filled fields: Amount, Merchant, Category, Subcategory, Date, Payment method, Notes
- Payment method read from the message — UPI, credit or debit card, NEFT/IMPS/RTGS as bank transfer; UPI is filled in for payments from UPI apps NEW
- Merchant is optional: leave it blank and the expense is saved under its category name; a merchant you add is remembered for next time NEW
- Merchant memory: a merchant you've categorised before comes pre-filled with the same category and subcategory NEW
- "Suggested category — please check" when the category guess is uncertain NEW
- Raw source text shown in a muted box (pasted/shared/scanned only — notification text is never kept)
- Money received from a notification is reviewed as Income: Amount, Source, Date, Notes NEW
Actions
- "Ignore"
- "Confirm & Add" (or "Add anyway" if a duplicate was flagged) · "Add income" for money received
- Duplicate banner: "View existing" / "Use existing" NEW
Recurring Payments
recurringSubscriptions and bills that repeat — with an option to auto-create the Expense when due.
Recurring list
On this screen
- Monthly total card
- "Upcoming" (next 3) · full list
Actions
- Per-row 3-dot menu: Edit / Pause-Resume / Delete
- "Add Recurring Payment" button
Add / Edit Recurring
addRecurring / editRecurringFields
- Name · Amount · Category · Frequency
- More detail (optional) — e.g. Loan / EMI → Home Loan EMI; the expenses it creates are recorded under it NEW
- Due day (1–31) · Start date · End date (optional)
- Recipient/Provider · Notes
Switches
- "Reminder enabled" (+ days-before dropdown)
- "Auto-create expense"
Savings
savingsGoals with a target amount, a monthly plan, and progress you can top up any time.
Savings list
On this screen
- Monthly-allocation total card
- Goal cards with progress
Actions
- "Add allocation" dialog per goal
- Per-row 3-dot menu: Edit / Pause-Resume / Delete
- "Add Savings Goal" button
Add / Edit Savings Goal
addSavings / editSavingsFields
- Name · Category
- Target amount · Monthly target
- Target date · Notes
Actions
- "Save / Update Goal"
Income
incomeWhat's coming in, month by month.
Income list
On this screen
- Month switcher · monthly total card
- Income tiles
Actions
- Per-row 3-dot menu: Edit / Delete
- "Add Income" button
Add / Edit Income
addIncome / editIncomeFields
- Source · Amount · Frequency
- Date · Notes
Actions
- "Save / Update Income"
Upcoming Money
upcomingMoneyNEWWhat's coming up, and how much money to keep aside for it.
On this screen
- Toggle: Next 7 days / Next 30 days
- "Money to keep aside" total
- Items grouped by day ("In 2 days · Mon, 28 Sep")
- Recurring payments due, scheduled services with a cost, money you owe that's due
- Listed without an amount: insurance & PUC renewals, warranties ending, reminders, festivals, family occasions
Actions
- Tap an item → its screen (a festival or occasion opens Add Savings, to set money aside)
Planned expenses
plannedExpensesNEWPlan for something ahead — a festival, a trip, a service — then compare what you expected with what you actually spent.
Plans list
On this screen
- One card per plan: expected vs actual, with a progress bar
- "Remaining", "Right on plan", or how far over; "Ended" once its dates have passed
Actions
- "Add plan"
- Tap a plan → plan detail
Add / Edit plan
addPlannedExpense / editPlannedExpenseFields
- What's it for? (e.g. Diwali)
- Expected amount
- From · To dates
- Category (optional) · Notes
Actions
- Save
Plan detail
plannedExpenseDetailOn this screen
- Expected · Actual · Remaining (or Difference)
- "Expenses in this plan"
Actions
- "Add expense" — opens Add Expense already linked to the plan
- Edit · Delete (only the plan is removed; its expenses stay, just unlinked)
Money Calendar & Timeline
moneyCalendar / moneyTimelineNEWTwo ways to look back at a month: as a calendar, or as a running story.
Money Calendar
On this screen
- Month switcher
- Month grid — each day shows what was spent
Actions
- Tap a day → sheet with that day's expenses and transfers
Money Timeline
On this screen
- Everything that moved, day by day: expenses, "Sent to / Received from", "Lent to / Borrowed from", "Paid back"
Actions
- Filter chips: All / Expenses / Transfers / Lending
- Month switcher
Transfers
transfersNEWMoney sent or received outside your everyday spending — to family, from a friend — so it doesn't distort your expenses.
Add Transfer
- Direction: Sent / Received
- Person name · Amount
- Date · Notes
List
- Every transfer, sent and received
- Header "+" → Add Transfer
- ⋮ menu → Delete
Lending & Borrowing
debtsNEWWho owes you, and who you owe — including partial repayments.
On this screen
- Tabs: Waiting for you / You owe, each with its total
- Cards with person, amount left, due date and status: Pending · Partially settled · Settled
- Per card: "Record payment" (part or all of it) · payment history
Add lent / borrowed
- Direction: I Lent / I Borrowed
- Person name · Amount · Date
- Due date (optional) · Notes
Attachments
NEWPhotos and PDFs on Things, Vehicles, Documents, Warranties, Services and Expenses — all handled the same way.
Adding a file
- "Add file" → Take photo · Choose from photos · Choose file
- JPG, PNG, WebP or PDF, up to 10 MB each
- Photos are shrunk to a sensible size first; the same file can't be attached twice
Each file shows
- Thumbnail, name, size
- Status: Waiting to sync · Uploading % · Synced · Upload failed (with Retry)
- ⋮ menu: Open · Remove
Notifications
notificationCenterNEWGentle, useful nudges worked out on your phone — never a feed to monitor.
Notification Center
On this screen
- Recent notifications grouped Today / Yesterday / Earlier, each with its time or date
- Unread ones tinted, with a dot
Actions
- Tap → the screen it's about
- "Mark all as read" · swipe to dismiss, with Undo
What HomeBook can tell you about
Types
- Budget alerts — once each at 70%, 80%, 90% and 100%
- Upcoming payments · Reminders
- Vehicle insurance/PUC · Warranties ending
- Debt reminders
- Festivals & family occasions — with "Set aside" and "Maybe later"
- Spending insights — an occasional end-of-day note
- Backup reminders
Your controls (Settings)
- Switch each type on or off
- Quiet hours — nothing between 10 PM and 7 AM
- "Show amounts and names" — off keeps money notifications vague on the lock screen
Search
searchOne search box across everything in your home.
On this screen
- Autofocus search field
- Results grouped by type: Things / Vehicles / Documents / Warranties / Service / Reminders
- Also Expenses, Transfers and Lending & Borrowing NEW
- Status chips where relevant
Actions
- Tap a result → its detail screen, or the matching tab
Family & Occasions
familyThe people in your household, for your records (like who paid) — and the family days worth remembering. Adding a member doesn't give them access to your HomeBook.
Family members
On this screen
- Member list — avatar initial, name, role
- Members now sync, so "Paid by" is the same on every device NEW
Actions
- Header "+" or tap a member → Member sheet (Name, Email, Role — a label only; it doesn't grant access)
- Footer: "Adding someone doesn't give them access to your HomeBook." NEW
- Delete button per row
Family occasions
NEWOn this screen
- Birthdays, anniversaries, housewarmings and other yearly days, soonest first
- Each shows its type, date, "In 5 days" / "Today", and years completed (e.g. "25 years")
Add / Edit occasion
- Occasion: 🎂 Birthday · 💐 Anniversary · 🏡 Housewarming · 🎉 Other
- Name (e.g. "Amma's birthday") · Date
- Mention it: 1 / 3 / 7 / 14 days before
- Save · Delete
The festive touch on Home
NEWWhen
- A festival within the next week (Sankranti, Ugadi, Vinayaka Chavithi, Dussehra, Diwali, Holi, Eid, Christmas, Republic Day, Independence Day)
- A family occasion within the next 3 days
- The day itself: "Happy Diwali!" or "🎂 Amma's birthday is today"
What changes
- Only Home's banner — a warm card with a greeting and illustration
- Before the day: a "Set aside" link to Add Savings
- Everything else in HomeBook stays exactly as usual
Backup & Restore
backupA portable export of your records — independent of cloud sync.
On this screen
- "Last backup" card (date + record/file count)
- Illustration shown only if never backed up
Actions
- "Back up now" → exports and shares a file
- "Restore from backup" → pick file → confirm (shows home name, record count, export date) → restore
Settings & Profile
profile / settingsTab 4, plus everything nested one level under it.
Profile
On this screen
- Avatar (tappable if signed in) + home name
Rows
- My Home (rename) · Warranties · Maintenance · Money
- Sign in & sync (or Sync now/Sign out if signed in) — shows "Everything is synced ✓" or "N changes waiting to sync" NEW
- Family members · Backup & restore · App lock · Settings
Settings
Preferences
- Language (English/Telugu/Hindi)
- Reminder defaults · Notifications (switch)
- Notification types — one switch each, plus Quiet hours and "Show amounts and names" NEW (see Notifications)
- Smart Expense Detection — Off / On / "Notification access is currently disabled." → its own screen NEW (see Smart Expense Capture)
- Appearance (System/Light/Dark)
Security, storage & account
- App lock · Storage usage (read-only)
- About HomeBook · Privacy Policy · Terms & Conditions
- Delete account (signed-in users only) — also removes your household's cloud backup and files; records on this phone stay NEW
App Lock
appLockAn on-device PIN gate — separate from and unrelated to your cloud sign-in.
App lock settings
On this screen
- "App lock" switch
- "Change PIN" row (visible once enabled)
Actions
- Enable → set PIN, then confirm it (min 4 digits)
- Disable / change → requires entering the current PIN first
Lock screen
On this screen
- Lock illustration · PIN field
Actions
- "Unlock" — inline error on a wrong PIN
Legal
privacyPolicy / termsOfServiceOne reusable screen for both documents.
On this screen
- Heading + body sections, scrollable
Behavior
- Shows the Firestore-synced version when available
- Falls back to the bundled copy offline, with a visible note