sander-van-hooft / laravel-invoicable
Easy invoice generation using Laravel Eloquent
Installs: 8 155
Dependents: 0
Suggesters: 0
Security: 0
Stars: 146
Watchers: 5
Forks: 38
Open Issues: 4
Requires
- php: ^7.4 || ^8.0
- ext-intl: *
- dompdf/dompdf: ^1.0
- illuminate/support: ^7.0 || ^8.0
- nesbot/carbon: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.18
- graham-campbell/testbench: ^5.6
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: ^3.4
README
Easy invoice creation for Laravel. Unlike Laravel Cashier, this package is payment gateway agnostic.
If you're looking for Mollie payment processing, be sure to check out laravel-payable-redirect-mollie.
Structure
database/
resources
src/
tests/
vendor/
Install
Via Composer
$ composer require sander-van-hooft/laravel-invoicable
You can publish the migration with:
$ 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:
$ php artisan migrate
Optionally, you can also publish the invoicable.php
config file with:
$ php artisan vendor:publish --provider="SanderVanHooft\Invoicable\InvoicableServiceProvider" --tag="config"
This is what the default config file looks like:
return [ 'default_currency' => 'EUR', 'default_status' => 'concept', 'locale' => 'nl_NL', ];
If you'd like to override the design of the invoice blade view and pdf, publish the view:
$ 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.
Usage
Money figures are in cents!
Add the invoicable trait to the Eloquent model which needs to be invoiced (typically an Order model):
use Illuminate\Database\Eloquent\Model; use SanderVanHooft\Invoicable\IsInvoicable\IsInvoicableTrait; class Order extends Model { use IsInvoicableTrait; // enables the ->invoices() Eloquent relationship }
Now you can create invoices for an Order:
$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.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email info@sandervanhooft.com instead of using the issue tracker.
Credits
- Sander van Hooft
- All Contributors
- Inspired by Laravel Cashier's invoices.
License
The MIT License (MIT). Please see License File for more information.