Skip to content

CATEGORY_TAXONOMY.md

Latest commit

 

History

History
116 lines (97 loc) · 6.24 KB

CATEGORY_TAXONOMY.md

File metadata and controls

116 lines (97 loc) · 6.24 KB
Raw

Category Taxonomy

The pre-built widgets in Cashew-Reports are configured for the category and subcategory structure documented here. This is the taxonomy you should set up in your Cashew app for the best out-of-the-box experience.

If your categories differ, see the Customization Guide for how to adapt.

Expense Categories (16)

Category Subcategories
Utility Bills Electricity, Mobile Recharge, Cooking Gas, Home Internet, Society Maintenance, Digital Subscriptions
Transit Metro, Cab, Public Transport, Vehicle Fuel, Toll, Parking
Investment Mutual Funds, Stocks, Govt & Retirement Schemes, Gold, Deposits & Bonds
Food Eating Out, Dairy, Fruits & Vegetables, Non-Veg, Other Food
Home Essentials Groceries, Home Supplies, Other Household
Personal Purchases Clothing & Footwear, Accessories, Entertainment, Hobbies & Leisure
Home Durables Electronics, Home Appliances, Furniture, Furnishings & Decor, Kitchenware
Services Personal Care, Vehicle Expenses, Repairs, Household Staff, Home Services, Family Transfer
Financial Admin Insurance, Tax & Compliance, Bank Charges, Professional Fees, Govt Fees, Loan EMI
Healthcare Doctor & Hospital, Medicines, Diagnostics, Therapy & Wellness
Education School Charges, Tuition, Courses, Books & Stationery
Occasion Gifts, Pooja, Event Hosting, Celebration Shopping, Donations
Vacation Travel, Meals, Trip Shopping, Stay, Activities
Misc Expense Uncategorized Expense, Untraced Expense, Rare Expense
Balance Correction (internal -- transfers, wallet top-ups, ATM withdrawals)
Payroll Deductions Income Tax, EPF, NPS

Income Categories (8)

Category Subcategories
Salary Monthly Salary, Bonus, Reimbursement
Passive Income Interest, Rent, Dividend
Capital Gains Maturity & Withdrawal, Market Sale, Asset Sale
Rewards CC Rewards, App Cashback, Fuel Reversal
Refunds Merchant Refund, Overpayment & Reversal, Deposit Return
Ad Hoc Income Side Income, Govt Credit, Insurance & Compensation
Misc Income Uncategorized Income
Balance Correction (internal -- transfers in, wallet top-ups)

How Categories Map to Widgets

flowchart TD
    subgraph UNIVERSAL["Universal Widgets (any categories)"]
        BR["burn_rate"]
        MR["money_received"]
        SR["savings_rate"]
        CB["cat_breakdown"]
        BT["burn_trend"]
        TS["top_subcats"]
        BI["biggest_increases"]
    end

    subgraph TAXONOMY["Pre-Built Widgets (taxonomy-specific)"]
        DS["disc_split"]
        LT["lifestyle_tax"]
        DQ["data_quality"]
        UB["utility_bills"]
        GT["grocery_trend"]
        INV["investment"]
        RR["rewards_refunds"]
        HC["household_cost"]
        CT["cab_transit"]
        PP["people_payments"]
        RT["rent_trend"]
    end

    BURN_EX["BURN_RATE_EXCLUDED"] --> BR & BT & SR & CB & TS & BI & DS
    CORE_INC["CORE_INCOME_CATEGORIES"] --> SR
    DISC["DISC / NON_DISC / SEMI_DISC"] --> DS
    EUB["EXPECTED_UTILITY_BILLS"] --> UB
    IS["INVESTMENT_SUBCATEGORIES"] --> INV
    RS["REWARDS_SUBCATEGORIES"] --> RR
    HRC["HOUSEHOLD_RUNNING_CATEGORIES"] --> HC
    PPF["PEOPLE_PAYMENT_FILTERS"] --> PP
Loading

CONFIG Reference

Each CONFIG key in Code.gs controls which categories feed into specific widgets. Edit these arrays to match your own taxonomy.

CONFIG key Default values Used by widgets
BURN_RATE_EXCLUDED Investment, Balance Correction, Payroll Deductions burn_rate, burn_trend, savings_rate, cat_breakdown, top_subcats, biggest_increases, disc_split
CORE_INCOME_CATEGORIES Salary, Passive Income, Capital Gains, Ad Hoc Income savings_rate
DISC_CATEGORIES Personal Purchases, Occasion, Vacation, Home Durables disc_split
NON_DISC_CATEGORIES Utility Bills, Financial Admin, Home Essentials, Healthcare, Education disc_split
SEMI_DISC_CATEGORIES Food, Transit, Services, Misc Expense disc_split
EXPECTED_UTILITY_BILLS Electricity (NJH), Electricity (AJH), Mobile Recharge, Cooking Gas, Home Internet, Society Maintenance, Digital Subscriptions utility_bills
INVESTMENT_SUBCATEGORIES Mutual Funds, Govt & Retirement Schemes, Stocks, Gold, NPS investment
REWARDS_SUBCATEGORIES CC Rewards, App Cashback, Bank Cashback rewards_refunds
HOUSEHOLD_RUNNING_CATEGORIES Utility Bills, Home Essentials household_cost
PEOPLE_PAYMENT_FILTERS Services > Household Staff, Services > Family Transfer, Occasion > Gifts, Occasion > Donations people_payments

Hardcoded Category References

Some widgets reference specific category > subcategory paths directly in their compute functions (not via CONFIG arrays). To adapt these, you need to edit the compute function in Code.gs:

Widget Hardcoded reference Compute function
lifestyle_tax Food > Eating Out, Personal Purchases computeLifestyleTax_()
data_quality Misc Expense > Uncategorized Expense, Misc Expense > Untraced Expense computeDataQuality_()
grocery_trend Home Essentials > Groceries computeGroceryTrend_()
cab_transit Transit > Cab, Transit > Metro, Transit > Public Transport computeCabTransit_()
rent_trend Passive Income > Rent (+ title-based AJH/NJH split) computeRentTrend_()
household_cost Services > Household Staff (in addition to CONFIG categories) computeHousehold_()
money_received Excludes "Misc Income" category computeIncome_()
investment "Investment" category computeInvestment_()
rewards_refunds "Rewards" and "Refunds" categories computeRecovery_()

Relationship to Mail2Cashew-TPS

If you use Mail2Cashew-TPS for automated transaction entry, the categorySubcategoryKeywordMap in your TPS userConfig defines the same taxonomy documented here. The keyword lists (which merchant names map to which subcategory) are TPS-specific and not used by the dashboard -- only the category and subcategory names need to match.