DOCSEARCHbyAlgolia
Submit Docs

PersonalFinance Telegram Bot

website·Indexed 30 days ago

https://aw09.github.io/Personal-Finance

End-user manual for the PersonalFinance Telegram bot, featuring guides on wallet management, credit and investment tracking, receipt uploading via Gemini, and a comprehensive command reference for transactions, reports, and balance tracking.

Tokens
5.7K
Snippets
38
Records
53
Agent score
71%

What's inside PersonalFinance

  1. Introduction to PersonalFinance Telegram Bot

    The PersonalFinance Telegram bot is a tool for recording expenses, checking wallet balances, and tracking debts directly within Telegram. Users interact with the bot using chat commands (e.g., /wallet list) to manage their finances without needing API or server configuration.

  2. Sync transactions across devices

    Transactions and data are stored in the backend rather than locally. Because the Telegram bot acts as the interface, all data remains synchronized across any device (desktop or mobile) where the user is logged into their Telegram account.

  3. Test basic PersonalFinance bot commands

    After running /start, you can verify the bot's functionality using these basic commands:

    • /help wallet: Get an overview of wallet actions.
    • /wallet list: View all wallets, their balances, and the default wallet marker.
    • /categories list: Review the auto-classifier categories.
    • /categories reset: Restore the recommended default category list.
    • Shorthand expense entry: Use e [category] [amount] [description] (e.g., e lunch 12000 quick) as a shortcut for /add expense.
    /help wallet
/wallet list
e lunch 12000 quick
/categories list

  4. Understand user account scoping in PersonalFinance bot

    The PersonalFinance bot supports multiple users. Each Telegram user ID is mapped to a unique account, ensuring that wallets, transactions, and reports are automatically scoped and isolated per user.

  5. Repay credit wallet debt

    Use the /wallet credit repay command to pay off credit debt. The bot logs a withdrawal from the source wallet and an income transaction on the credit wallet. Partial repayments are supported; any remaining installments will stay open. If the from=@wallet parameter is omitted, the bot uses the default wallet.
    /wallet credit repay Visa 500000 from=@Main\ Wallet beneficiary=Tokped desc=June bill

  6. Capture transactions and receipts

    The bot supports three ways to record financial data: free-text shorthand, the /add command, and photo uploads.

    Amount Formatting: The bot accepts commas, decimals, and shorthands: k for thousands (e.g., 50k = 50,000) and jt for millions (e.g., 1.5jt = 1,500,000).

    # Free text shorthand: [optional @wallet] [type: e/i/d/r] [amount] [description]
@travel e taxi 75000 airport

# Full add command: /add [@wallet] [type] [amount] [description] [optional date]
# Types: expense, income, debt, receivable
/add @cash expense 125000 groceries 2024-01-01

    Receipt Photos: Send a photo with a caption using these tokens:

    • @wallet: Specify the wallet
    • installments=<n>: Number of installments
    • beneficiary=Name: Name of the beneficiary

    Example caption: @cash installments=6 beneficiary=Travel

  8. View and edit transactions

    Use these commands to retrieve details for a specific transaction or update existing records.
    # View full detail for a transaction using its index from the /recent list
/t 1

# Edit the most recent transaction
/edit amount=55000

# Edit a specific transaction by index
/edit 1 category=Food

  9. Get help with bot commands

    If you forget command syntax, use the /help command to access inline buttons for common flows. The bot also provides usage hints automatically if a command is entered incorrectly.
    /help

  10. Track investment performance using ROE

    Calculate the simple Return on Equity (ROE) for an investment wallet over a specific period. This calculation combines contributions, withdrawals, and adjustments to determine net gains.
    /wallet investment roe Brokerage start=2024-01-01 end=2024-12-31

  11. Initialize and verify your PersonalFinance bot account

    To start using the PersonalFinance bot, open the bot in Telegram (using the handle @pfin_bot or your production handle) and send the /start command. This process links your Telegram user ID to a PersonalFinance account. New users will have an account created automatically with a Main Wallet in IDR, while returning users will be re-attached to their existing data.
    /start

  12. Manage shared expenses and debts

    To track shared expenses, create a dedicated wallet (e.g., 'Household') and transfer funds into it. Use /report @WalletName to reconcile expenses. For lending or borrowing, record entries as receivable or debt and track them using the /owed command.
    /report @Household
/owed