sander-van-hooft/laravel-invoicable

Easy invoice generation using Laravel Eloquent

laravel-invoicable

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

Easy invoice creation for Laravel. Unlike Laravel Cashier, this package is payment gateway agnostic., _(*2)

If you're looking for Mollie payment processing, be sure to check out laravel-payable-redirect-mollie., _(*3)

Structure

database/
resources
src/
tests/
vendor/

Install

Via Composer, _(*4)

``` bash $ composer require sander-van-hooft/laravel-invoicable, <sub>(*5)</sub>

You can publish the migration with:

``` bash
$ php artisan vendor:publish --provider="SanderVanHooft\Invoicable\InvoicableServiceProvider" --tag="migrations"

After the migration has been published you can create the invoices and invoice_lines tables by running the migrations:, <sub>(*6)</sub>

``` bash $ php artisan migrate, <sub>(*7)</sub>

Optionally, you can also publish the `invoicable.php` config file with:

``` bash
$ php artisan vendor:publish --provider="SanderVanHooft\Invoicable\InvoicableServiceProvider" --tag="config"

This is what the default config file looks like:, <sub>(*8)</sub>

``` php, <sub>(*9)</sub>

return [ 'default_currency' => 'EUR', 'default_status' => 'concept', 'locale' => 'nl_NL', ];, <sub>(*10)</sub>

If you'd like to override the design of the invoice blade view and pdf, publish the view:

``` bash
$ php artisan vendor:publish --provider="SanderVanHooft\Invoicable\InvoicableServiceProvider" --tag="views"

You can now edit receipt.blade.php in <project_root>/resources/views/invoicable/receipt.blade.php to match your style., <sub>(*11)</sub>

Usage

Money figures are in cents!, <sub>(*12)</sub>

Add the invoicable trait to the Eloquent model which needs to be invoiced (typically an Order model):, <sub>(*13)</sub>

``` php use Illuminate\Database\Eloquent\Model; use SanderVanHooft\Invoicable\IsInvoicable\IsInvoicableTrait;, <sub>(*14)</sub>

class Order extends Model { use IsInvoicableTrait; // enables the ->invoices() Eloquent relationship }, <sub>(*15)</sub>

Now you can create invoices for an Order:

``` php
$order = Order::first();
$invoice = $order->invoices()->create([]);

// To add a line to the invoice, use these example parameters:
//  Amount:
//      121 (€1,21) incl tax
//      100 (€1,00) excl tax
//  Description: 'Some description'
//  Tax percentage: 0.21 (21%)
$invoice = $invoice->addAmountInclTax(121, 'Some description', 0.21);
$invoice = $invoice->addAmountExclTax(100, 'Some description', 0.21);

// Invoice totals are now updated
echo $invoice->total; // 242
echo $invoice->tax; // 42

// Set additional information (optional)
$invoice->currency; // defaults to 'EUR' (see config file)
$invoice->status; // defaults to 'concept' (see config file)
$invoice->receiver_info; // defaults to null
$invoice->sender_info; // defaults to null
$invoice->payment_info; // defaults to null
$invoice->note; // defaults to null

// access individual invoice lines using Eloquent relationship
$invoice->lines;
$invoice->lines();

// Access as pdf
$invoice->download(); // download as pdf (returns http response)
$invoice->pdf(); // or just grab the pdf (raw bytes)

// Handling discounts
// By adding a line with a negative amount.
$invoice = $invoice->addAmountInclTax(-121, 'A nice discount', 0.21);

// Or by applying the discount and discribing the discount manually
$invoice = $invoice->addAmountInclTax(121 * (1 - 0.30), 'Product XYZ incl 30% discount', 0.21);

// Convenience methods
Invoice::findByReference($reference);
Invoice::findByReferenceOrFail($reference);
$invoice->invoicable() // Access the related model

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*16)</sub>

Testing

bash $ composer test, <sub>(*17)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*18)</sub>

Security

If you discover any security related issues, please email info@sandervanhooft.com instead of using the issue tracker., <sub>(*19)</sub>

Credits

• Sander van Hooft
• All Contributors
• Inspired by Laravel Cashier's invoices.

License

The MIT License (MIT). Please see License File for more information., <sub>(*20)</sub>