accountsplus documentation
Choose a version
Version 1.x
Getting started with AccountsPlus #
Release status: This guide follows AccountsPlus 1.0.0.
Requirements #
- Python 3.10 or later
- Windows, Linux, or macOS
- Desktop environment for the GUI (optional)
- Android 8.0+ for the mobile companion (optional)
Install the desktop application #
From source (recommended for development) #
git clone https://github.com/ZFordDev/accountsplus.git
cd accountsplus
python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e '.[gui]'
On Windows, activate with .venv\Scripts\activate.
From PyPI (when published) #
pip install accountsplus
Launch the application #
Start the desktop GUI:
accountsplus-gui
Or use the command-line interface:
accountsplus --help
Set up your business #
On first launch, AccountsPlus guides you through creating your business profile:
- Enter your business name
- Add your ABN (optional)
- Set your default currency
- Configure tax settings (GST, etc.)
Add your first customer #
- Open Customers from the dashboard
- Click Add Customer
- Enter customer details (name, email, address)
- Save the customer
Create an invoice #
- Open Invoices from the dashboard
- Click Create Invoice
- Select the customer
- Add line items with quantities and prices
- Review the total (GST calculated automatically)
- Click Save to store or Generate PDF to export
Record an expense #
- Open Expenses from the dashboard
- Click Add Expense
- Enter the expense details (description, amount, category)
- Attach a receipt photo (optional)
- Save the expense
Export your data #
Generate a CSV export for your accountant:
accountsplus export --type transactions --format csv --output transactions.csv
Or from the GUI: File > Export > CSV.
Back up your data #
Create an encrypted backup:
accountsplus backup --output ~/backups/accountsplus-$(date +%Y%m%d).enc
From the GUI: File > Backup.
Next: use the desktop interface, consult the CLI reference, or set up cloud sync.