Hello, I am Wiego. Please start by reading the whole documentation! If you have any questions, find a bug or experience difficulties getting the plugin to work please use the Support Forum. Only leave a Review if you are happy with the plugin or are still unhappy with the plugin after reaching out to me in the Support Forum. Thank you!

Why is this a paid plugin?

Someting that is free has little or no perceived value. Users do not commit to free products and only use them untill something else that looks nice and is free comes along. When I invest my time in the development of a new plugin or theme I commit to supporting and maintaining it. I ask my customers to do the same. I do not make money from this plugin by advertisements, upgrades or additional services like hosting or setup. I simply sell the software.

Did you know that only about 30% of my plugins are paid (70% of my plugins are free) and that 30% of your purchase or donation goes to help fund the October Project?

My plugins take many hours to develop (10-120+) and even more hours to document and maintain. My paid plugins have to pay for both this time and the time I am spending on free plugins and less successfull paid plugins. This means that it will take even a successfull plugin years to become profitable. Please consider buying an extended license if you want me to continue to maintain these plugins for the very small fee I ask in return or hire me for adding functionality that you feel is missing but valuable.

Table of contents

• Installation
• Getting started
• Invoices component
• Customize invoice template
• Online payments
• Recurring invoices
• Programmatically adding items to orders
• Programmatically logging order history
• Mail template
• Available events
• Available permissions
• Available languages
• Support

Installation

You need an account on octobercms.com to install this plugin.

1. Sign in and click on the Add to Project button on the product page for the plugin in the marketplace.
2. Select the project you wish to add the plugin to (or create one).
3. Make sure you install any 3rd-party plugins this plugin depends on
4. Make sure you have attached this project to your website in the backend of your website in order to pull in the new plugin (Settings > Updates & Plugins). Don't worry, attaching or detaching your website to a project will never delete anything!
5. Make sure you allow short_open_tag (default PHP setting)

Getting started

Please note that RainLab.User, RainLab.UserPlus and LukeTowers.SnappyPDF are required for this plugin and that the RainLab.UserPlus plugin now requires RainLab.Location and RainLab.Notify. All these plugins are FREE.

1. Add Briddle.Invoice to a project and attach it to your website (This plugin requires RainLab.User, RainLab.UserPlus, and LukeTowers.SnappyPDF. The User Plus Plugin requires RainLab.Location and RainLab.Notify so add those first). All these plugins are FREE.
2. Make sure you allow short_open_tag (this is the default PHP configuration)
3. Go to Settings > Omnipay > Invoice settings to configure the plugin

Invoices component

This component lists unpaid invoices for a logged in user. Simply place the component on the page and specify a pay URL (without trailing slash). My FREE Briddle.Omnipay plugin will take care of the rest.

Customize invoice template

You can fully customize the invoice template in Settings > Omnipay > Invoice configuration

The following variables are available:

Online payments

Please use my FREE plugin Briddle.Omnipay to allow online payments. Online payments with this plugin are automagically logged.

My Omnipay plugin does not support automatic payments but you could implement SEPA Direct Debit with Mollie.com to setup automatic payments or use Stripe to setup automatic payments using a credit-card yourself.

Recurring invoices

Please use my plugin Briddle.Members to setup recurring invoices.

Programmatically adding items to orders

Please note that the total amount due and the total VAT in the order will now also be automagically recalculated and updated if you add/update/remove items using the Item model (https://octobercms.com/docs/database/model#basic-inserts).

You can programmatically create a new order using the Order model of the plugin. You can then add/update/remove items in that order. This will automagically recalculate the total amount due and the total VAT.

use Briddle\Invoice\Models\Order;
use Briddle\Invoice\Models\Item;

$order = new Order;
$order->description = 'Some deal';
$order->user_id = 3;
$order->due = '2020-12-01';  
$order->currency = 'USD';
$order->save();   

$item = new Item;
$item->description = 'Something';
$item->quantity = 1;
$item->vat = 21;
$item->price = 1000;
$item->order_id= 3;
$item->save();

$item = Item::find(3);
$item ->description = 'Some other thing';
$item ->save();

$item = Item::find(3);
$item ->delete();

or (deprecated):

use Briddle\Invoice\Models\Order;

$order = new Order; 

$order->addItem($orderId,[
    'description' => 'Test item',
    'quantity' => 1,
    'vat' => 21,
    'price' => 1000
]);

$order->updateItem($orderId,[
    'id' => 1,
    'description' => 'Test item',
    'quantity' => 1,
    'vat' => 21,
    'price' => 1000
]);

$order->removeItem($orderId,$itemId);

Programmatically logging order history

Mails and online payments using my FREE plugin Briddle.Omnipay are automagically logged

You can use the Log model to log history. The created_on and updated_on fields are added automagically.

use Briddle\Invoice\Models\Log;

$log = new Log;
$log->name = 'Something';
$log->order_id= 3;
$log->save();

Mail template

Mails are automagically logged

Upon installation the mail template briddle.invoice::mail.invoice is created. The following variables are available inside this template:

Available events

The following events are available to extend the functionality of this plugin:

Available permissions

As always you can set permissions for this plugin in Settings > Administrators > Invoice

• Manage orders
• Manage items
• Manage settings
• Manage log

Available languages

This plugin can be translated in any language

This plugin supports the following languages out of the box:

• english
• dutch
• german

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

IMPORTANT NOTICE! All my activities on October CMS are suspended indefinitely after my second burn-out. I do not offer any support or updates