base on Laravel package to generate PDF invoices from various customizable parameters ![![Banner]](https://banners.beyondco.de/Laravel%20Invoices.png?theme=light&packageManager=composer+require&packageName=laraveldaily%2Flaravel-invoices&pattern=architect&style=style_1&description=PDFs+made+easy&md=1&showWatermark=0&fontSize=100px&images=document-download) # Laravel Invoices [](https://packagist.org/packages/laraveldaily/laravel-invoices) [](https://packagist.org/packages/laraveldaily/laravel-invoices) [](https://packagist.org/packages/laraveldaily/laravel-invoices) [](https://packagist.org/packages/laraveldaily/laravel-invoices) [](https://packagist.org/packages/laraveldaily/laravel-invoices) [](https://packagist.org/packages/laraveldaily/laravel-invoices) This Laravel package provides an easy to use interface to generate **Invoice PDF files** with your provided data. Invoice file can be stored, downloaded, streamed on any of the filesystems you have configured. Supports different templates and locales. ## Features - Taxes - fixed or rate - for item or for invoice - Discounts - fixed or by percentage - for item or for invoice - Shipping - add shipping price to your invoices - Automatic calculation - provide minimal set of information, or calculate yourself and provide what to print - Due date - Easy to customize currency format - Serial numbers as you like it - Templates - Translations - Global settings and overrides on-the-fly ## Installation Via Composer ```bash $ composer require laraveldaily/laravel-invoices:^4.0 ``` > [Older versions](PREVIOUS.md) After installing Laravel Invoices, publish its assets, views, translations and config using the `invoices:install` Artisan command: ```bash $ php artisan invoices:install ``` ### Updates Since it is evolving fast you might want to have latest template after update using Artisan command: ```bash $ php artisan invoices:update ``` > It will give a warning if you really want to override default resources Or alternatively it can be done separately. ```bash $ php artisan vendor:publish --tag=invoices.views --force ``` ```bash $ php artisan vendor:publish --tag=invoices.translations --force ``` ## Basic Usage **RandomController.php** ```php use LaravelDaily\Invoices\Invoice; use LaravelDaily\Invoices\Classes\Buyer; use LaravelDaily\Invoices\Classes\InvoiceItem; // ... $customer = new Buyer([ 'name' => 'John Doe', 'custom_fields' => [ 'email' => '[email protected]', ], ]); $item = InvoiceItem::make('Service 1')->pricePerUnit(2); $invoice = Invoice::make() ->buyer($customer) ->discountByPercent(10) ->taxRate(15) ->shipping(1.99) ->addItem($item); return $invoice->stream(); ``` See result [Invoice_AA_00001.pdf](examples/invoice_AA_00001.pdf). ## Advanced Usage ``` php use LaravelDaily\Invoices\Invoice; use LaravelDaily\Invoices\Classes\Party; use LaravelDaily\Invoices\Classes\InvoiceItem; // ... $client = new Party([ 'name' => 'Roosevelt Lloyd', 'phone' => '(520) 318-9486', 'custom_fields' => [ 'note' => 'IDDQD', 'business id' => '365#GG', ], ]); $customer = new Party([ 'name' => 'Ashley Medina', 'address' => 'The Green Street 12', 'code' => '#22663214', 'custom_fields' => [ 'order number' => '> 654321 <', ], ]); $items = [ InvoiceItem::make('Service 1') ->description('Your product or service description') ->pricePerUnit(47.79) ->quantity(2) ->discount(10), InvoiceItem::make('Service 2')->pricePerUnit(71.96)->quantity(2), InvoiceItem::make('Service 3')->pricePerUnit(4.56), InvoiceItem::make('Service 4')->pricePerUnit(87.51)->quantity(7)->discount(4)->units('kg'), InvoiceItem::make('Service 5')->pricePerUnit(71.09)->quantity(7)->discountByPercent(9), InvoiceItem::make('Service 6')->pricePerUnit(76.32)->quantity(9), InvoiceItem::make('Service 7')->pricePerUnit(58.18)->quantity(3)->discount(3), InvoiceItem::make('Service 8')->pricePerUnit(42.99)->quantity(4)->discountByPercent(3), InvoiceItem::make('Service 9')->pricePerUnit(33.24)->quantity(6)->units('m2'), InvoiceItem::make('Service 11')->pricePerUnit(97.45)->quantity(2), InvoiceItem::make('Service 12')->pricePerUnit(92.82), InvoiceItem::make('Service 13')->pricePerUnit(12.98), InvoiceItem::make('Service 14')->pricePerUnit(160)->units('hours'), InvoiceItem::make('Service 15')->pricePerUnit(62.21)->discountByPercent(5), InvoiceItem::make('Service 16')->pricePerUnit(2.80), InvoiceItem::make('Service 17')->pricePerUnit(56.21), InvoiceItem::make('Service 18')->pricePerUnit(66.81)->discountByPercent(8), InvoiceItem::make('Service 19')->pricePerUnit(76.37), InvoiceItem::make('Service 20')->pricePerUnit(55.80), ]; $notes = [ 'your multiline', 'additional notes', 'in regards of delivery or something else', ]; $notes = implode("<br>", $notes); $invoice = Invoice::make('receipt') ->series('BIG') // ability to include translated invoice status // in case it was paid ->status(__('invoices::invoice.paid')) ->sequence(667) ->serialNumberFormat('{SEQUENCE}/{SERIES}') ->seller($client) ->buyer($customer) ->date(now()->subWeeks(3)) ->dateFormat('m/d/Y') ->payUntilDays(14) ->currencySymbol('$') ->currencyCode('USD') ->currencyFormat('{SYMBOL}{VALUE}') ->currencyThousandsSeparator('.') ->currencyDecimalPoint(',') ->filename($client->name . ' ' . $customer->name) ->addItems($items) ->notes($notes) ->logo(public_path('vendor/invoices/sample-logo.png')) // You can additionally save generated invoice to configured disk ->save('public'); $link = $invoice->url(); // Then send email to party with link // And return invoice itself to browser or have a different view return $invoice->stream(); ``` See result [Roosevelt Lloyd Ashley Medina.pdf](examples/Roosevelt%20Lloyd%20Ashley%20Medina.pdf). ### Alternatives using facade Optionally you can use a facade to make new party or item ```php use Invoice; $customer = Invoice::makeParty([ 'name' => 'John Doe', ]); $item = Invoice::makeItem('Your service or product title')->pricePerUnit(9.99); return Invoice::make()->buyer($customer)->addItem($item)->stream(); ``` ## Templates After publishing assets you can modify or make your own template for invoices. Templates are stored in the `resources/views/vendor/invoices/templates` directory. There you will find `default.blade.php` template which is used by default. You can specify which template to use by calling `template` method on Invoice object. For example if you have `resources/views/vendor/invoices/templates/my_company.blade.php` it should look like this: ```php Invoice::make('receipt')->template('my_company'); ``` Too see how things work in a template you can view `default.blade.php` as an example. ## Config ``` php return [ 'date' => [ /** * Carbon date format */ 'format' => 'Y-m-d', /** * Due date for payment since invoice's date. */ 'pay_until_days' => 7, ], 'serial_number' => [ 'series' => 'AA', 'sequence' => 1, /** * Sequence will be padded accordingly, for ex. 00001 */ 'sequence_padding' => 5, 'delimiter' => '.', /** * Supported tags {SERIES}, {DELIMITER}, {SEQUENCE} * Example: AA.00001 */ 'format' => '{SERIES}{DELIMITER}{SEQUENCE}', ], 'currency' => [ 'code' => 'eur', /** * Usually cents * Used when spelling out the amount and if your currency has decimals. * * Example: Amount in words: Eight hundred fifty thousand sixty-eight EUR and fifteen ct. */ 'fraction' => 'ct.', 'symbol' => '€', /** * Example: 19.00 */ 'decimals' => 2, /** * Example: 1.99 */ 'decimal_point' => '.', /** * By default empty. * Example: 1,999.00 */ 'thousands_separator' => '', /** * Supported tags {VALUE}, {SYMBOL}, {CODE} * Example: 1.99 € */ 'format' => '{VALUE} {SYMBOL}', ], 'paper' => [ // A4 = 210 mm x 297 mm = 595 pt x 842 pt 'size' => 'a4', 'orientation' => 'portrait', ], 'disk' => 'local', 'seller' => [ /** * Class used in templates via $invoice->seller * * Must implement LaravelDaily\Invoices\Contracts\PartyContract * or extend LaravelDaily\Invoices\Classes\Party */ 'class' => \LaravelDaily\Invoices\Classes\Seller::class, /** * Default attributes for Seller::class */ 'attributes' => [ 'name' => 'Towne, Smith and Ebert', 'address' => '89982 Pfeffer Falls Damianstad, CO 66972-8160', 'code' => '41-1985581', 'vat' => '123456789', 'phone' => '760-355-3930', 'custom_fields' => [ /** * Custom attributes for Seller::class * * Used to display additional info on Seller section in invoice * attribute => value */ 'SWIFT' => 'BANK101', ], ], ], ]; ``` ## Available Methods Almost every configuration value can be overrided dynamically by methods. ## Invoice #### General - addItem(InvoiceItem $item) - addItems(Iterable) - name(string) - status(string) - invoice status [paid/due] if needed - seller(PartyContract) - buyer(PartyContract) - setCustomData(mixed) - allows user to attach additional data to invoice - getCustomData() - retrieves additional data to use in template - template(string) - logo(string) - path to logo - getLogo() - returns base64 encoded image, used in template to avoid path issues - filename(string) - overrides automatic filename - taxRate(float) - shipping(float) - shipping amount - **totalDiscount(float) - If not provided calculates itself** - **totalTaxes(float) - If not provided calculates itself** - **totalAmount(float) - If not provided calculates itself** - **taxableAmount(float) - If not provided calculates itself** #### Serial number - series(string) - sequence(int) - delimiter(string) - sequencePadding(int) - serialNumberFormat(string) - getSerialNumber() - returns formatted serial number #### Date - date(CarbonInterface) - dateFormat(string) - Carbon format of date - payUntilDays(int) - Days payment due since invoice issued - getDate() - returns formatted date - getPayUntilDate() - return formatted due date #### Currency - currencyCode(string) - EUR, USD etc. - currencyFraction(string) - Cents, Centimes, Pennies etc. - currencySymbol(string) - currencyDecimals(int) - currencyDecimalPoint(string) - currencyThousandsSeparator(string) - currencyFormat(string) - getAmountInWords(float, ?string $locale) - Spells out float to words, second parameter is locale - getTotalAmountInWords() - spells out total_amount - formatCurrency(float) - returns formatted value with currency settings '$ 1,99' #### File - stream() - opens invoice in browser - download() - offers to download invoice - save($disk) - saves invoice to storage, use ->filename() for filename - url() - return url of saved invoice - toHtml() - render html view instead of pdf ## InvoiceItem - make(string) - [static function] same as `(new InvoiceItem())->title(string)` - title(string) - product or service name - description(string) - additional information for service entry - units(string) - measurement units of item (adds units columns if set) - quantity(float) - amount of units of item - pricePerUnit(float) - discount(float) - discount in currency - discountByPercent(float) - discount by percents discountByPercent(15) means 15% - tax(float) - taxByPercent(float) - **subTotalPrice(float) - If not provided calculates itself** ## Testing ``` bash $ composer test ``` ## Security If you discover any security related issues, please email [email protected] instead of using the issue tracker. ## Author - [David Lun][link-author] ## License GPL-3.0-only. Please see the [license file](LICENSE.md) for more information. [ico-version]: https://img.shields.io/packagist/v/laraveldaily/laravel-invoices.svg?style=flat-square [ico-downloads]: https://img.shields.io/packagist/dt/laraveldaily/laravel-invoices.svg?style=flat-square [ico-travis]: https://img.shields.io/travis/laraveldaily/laravel-invoices/master.svg?style=flat-square [ico-styleci]: https://styleci.io/repos/12345678/shield [link-packagist]: https://packagist.org/packages/laraveldaily/laravel-invoices [link-downloads]: https://packagist.org/packages/laraveldaily/laravel-invoices [link-travis]: https://travis-ci.org/laraveldaily/laravel-invoices [link-styleci]: https://styleci.io/repos/12345678 [link-author]: https://github.com/mc0de ", Assign "at most 3 tags" to the expected json: {"id":"4571","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"