Invoicing Plugin

This plugin creates an invoice related to the order.

SyliusInvoicingPlugin creates new immutable invoice when the order is in given state (default: created) and allows both customer and admin to download invoices related to the order.   ## Business value The primary aim of Invoicing Plugin is to create a document representing Customer's will to buy particular products and pay for them. An Invoice can also be treated as a proof of placing an Order. Thus, it is downloadable as .pdf file and can be sent to Customer manually by the Administrator or automatically once an Order is paid. Additional feature of the plugin that fulfills Invoicing domain is the ability to set billing data on a Seller. ## Installation #### Beware! This installation instruction assumes that you're using Symfony Flex. If you don't, take a look at the [legacy installation instruction](docs/legacy_installation.md). However, we strongly encourage you to use Symfony Flex, it's much quicker! 1. Require plugin with composer: > Remember to allow community recipes with `composer config extra.symfony.allow-contrib true` or during plugin installation process 2. Apply migrations to your database: 3. Default configuration assumes enabled PDF file generation. If you don't want to use that feature change your app configuration: Otherwise, check if you have wkhtmltopdf binary. If not, you can download it [here](https://wkhtmltopdf.org/downloads.html). In case wkhtmltopdf is not located in `/usr/local/bin/wkhtmltopdf` modify the `WKHTMLTOPDF_PATH` environment variable in the `.env` file: 4. If you want to generate invoices for orders placed before plugin's installation run the following command using your terminal: ## Extension points Majority of actions contained in SyliusInvoicingPlugin is executed once an event after changing the state of the Order. Here is the example for `Winzou State Machine`: Code placed above is a part of configuration placed in `config.yml` file. You can customize this file by adding new state machine events listeners or editing existing ones. Here is the example for Symfony's `workflow`: Apart from that an Invoice model is treated as a Resource. You can read more about Resources here: . Hence, template for displaying the list of Invoices is defined in `routing.yml` file: Another aspect that can be both replaced and customized is displaying Invoices list on Order show view. Code responsible for displaying Invoices related to the Order is injected to existing Sylius template using Sonata events. You can read about customizing templates via events here: ### Invoices files By default, when the order is paid, an immutable Invoice pdf file is saved on the server. The save directory is specified with `%sylius_invoicing.invoice_save_path%` parameter, that can be overridden if needed. There is no direct relation between `Sylius\InvoicingPlugin\Entity\Invoice` entity and its file. It's resolved based on the `Invoice::$number`, which is defined in `Sylius\InvoicingPlugin\Provider\InvoiceFileProviderInterface` service. By overriding this service, you can change a logic that is used to retrieve the invoice file. ## Fixtures You can add `ShopBillingData` fixtures into a yaml to add Channel ShopBillingData info to your installation. More instructions on the [fixtures configuration instructions](docs/fixtures.md). ## Security issues If you think that you have found a security issue, please do not use the issue tracker and do not post it publicly. Instead, all security issues must be sent to `[email protected]`.