Download the PHP package aroutinr/laravel-invoice without Composer
On this page you can find all versions of the php package aroutinr/laravel-invoice. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aroutinr/laravel-invoice
More information about aroutinr/laravel-invoice
Files in aroutinr/laravel-invoice
Package laravel-invoice
Short Description Create invoice for any model of your Laravel App
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-invoice
Laravel Invoice
Laraval package that allows you to create invoices, manage payments and track them from your models!
This will return a view with a simple and fully customizable invoice format.
Requirements
- PHP >=7.3
- Laravel 6 | 7 | 8
Install
Install through Composer.
Publish the migration.
Then run the migrations.
Additionally, you can publish the invoice.php configuration file. From here you can define various options for the operation of the package. Feel free to change whatever you need, such as the default currency, invoice header name, address and contact information, and more.
If you want to change the appearance of the invoice or the payment receipt, you can publish the blade views:
They will be saved in <project_root>/resources/views/vendor/laravel-invoice/
Usage
Important: the amount is expressed in cents!
The package has traits to keep track of the invoices that are issued. The first one is CustomerHasInvoice this trait must be added in the User or Company model for example, this will define the Customer associated with the invoice. In this same model you can add the HasAddresses trait, it will allow you to keep track of the addresses that you add to your invoices with the Customer. The second trait is HasInvoice, this must be added in the models that will be invoiceables, for example a service provided to the customer, subscription, orders, etc.
To create a new invoice, you only have to obtain a Customer model, an Invoiceable model and use the CreateInvoice Facade.
To create a payment to an invoice, you only need to use the Facade CreatePayment and pass in a invoice.
This is the example of the payment receipt.
In the following list you will find all the methods available in each Facade.
AroutinR\Invoice\Facades\CreateInvoice
| Method | Description |
|---|---|
| for() | Required. Arguments: Customer model, Invoiceable model |
| invoiceLine() | Required. Arguments: (string) description, (int) quantity, (int) amount |
| invoiceCurrency() | Optional. Arguments: (string) currency code |
| invoiceNumber() | Optional. Arguments: (string) invoice number |
| invoiceDate() | Optional. Arguments: (string) invoice date |
| invoiceDueDate() | Optional. Arguments: (string) invoice due date |
| fixedDiscountLine() | Optional. Arguments: (string) description, (int) amount |
| percentDiscountLine() | Optional. Arguments: (string) description, (int) amount |
| taxLine() | Optional. Arguments: (string) description, (int) amount |
| billingAddress() | Optional. Arguments: (array) Format: ['name' => 'Name', 'line_1' => 'Line 1, 'line_2' => 'Line 2, 'line_3' => 'Line 3'] |
| shippingAddress() | Optional. Arguments: (array) Format: ['name' => 'Name', 'line_1' => 'Line 1, 'line_2' => 'Line 2, 'line_3' => 'Line 3'] |
| customField() | Optional. Arguments: (string) name, (string) description |
| save() | Required. Save the invoice in the database |
| saveAndView() | Required if save is not present. Save the invoice in the database and render a view for the invoice |
AroutinR\Invoice\Facades\CreatePayment
| Method | Description |
|---|---|
| for() | Required. Arguments: Invoice model |
| paymentAmount() | Required. Arguments: (int) amount |
| paymentNumber() | Optional. Arguments: (string) invoice number |
| paymentDate() | Optional. Arguments: (string) invoice date |
| paymentMethod() | Optional. Arguments: (string) description |
| paymentReference() | Optional. Arguments: (string) description |
| save() | Required. Save the payment in the database |
| saveAndView() | Required if save is not present. Save the payment in the database and render a view for the payment |
Contributing
Feel free to contribute to this project. Any correction or improvement is welcome.
Testing
Run tests with PHPUnit:
Security
If you discover any security related issues, please email me [email protected] instead of using the issue tracker.
License
The MIT License (MIT). Please see License File for more information.
