Documentation

Find documentation for our Joomla extensions on this page.

Getting Started with JoomInvoice

System Requirements

  • PHP: >= 7.2.9
  • Joomla: 4.x, 5.x, or 6.x
  • MySQL: 5.6+ or MariaDB 10.1+
  • PHP Extensions: mbstring, gd or imagick (for PDF logo rendering)

Installation

  1. Log into your Joomla administrator panel.
  2. Navigate to System > Install > Extensions.
  3. Upload the package file pkg_joominvoice_v{version}_j4.zip.
  4. Joomla will install the component, system plugin, and payment plugins automatically.

Enable the System Plugin

The JoomInvoice system plugin must be enabled for the component to function. If it is not enabled, a warning message will appear in the admin panel.

  1. Go to System > Manage > Plugins.
  2. Search for joominvoice.
  3. Find the plugin named System - JoomInvoice and enable it.

Initial Configuration

After installation, configure the essential settings:

  1. Open JoomInvoice from Components > JoomInvoice.
  2. Click Configuration in the sidebar (or go to System > Component > JoomInvoice).
  3. Set at minimum:
    • Default currency - Select your primary currency.
    • Invoice number format - e.g., [yyyy]-[num] produces 2026-001.
    • Default invoicer data - Your company name, address, VAT number, email.
    • Default invoice template and Default quote template.
    • Default language for new invoices.

Creating a Frontend Menu Item

To allow clients to view their invoices on the frontend:

  1. Go to Menus > [Your Menu] > Add New Menu Item.
  2. Set Menu Item Type to JoomInvoice > Invoices.
  3. Configure access level as needed (e.g., Registered users only).
  4. Save the menu item.

This creates a page where logged-in users can see invoices assigned to their linked contact.

First Invoice

  1. In the admin panel, go to Components > JoomInvoice > Invoices.
  2. Click New in the toolbar.
  3. Fill in the Recipient tab with the client details (or search an existing contact).
  4. Add line items in the Items tab.
  5. Set the invoice date and due date.
  6. Click Save.

Your first invoice is ready to preview, download as PDF, or send by email.

We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience (tracking cookies). You can decide for yourself whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.

Ok