Invoicing plugin for Sylius.
- dev-master / 1.0.x-dev
This package is auto-updated.
Last update: 2021-10-11 12:58:37 UTC
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.
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.
Require plugin with composer:
composer require sylius/invoicing-plugin
Remember to allow community recipes with
composer config extra.symfony.allow-contrib trueor during plugin installation process
Apply migrations to your database:
Check if you have wkhtmltopdf binary. If not, you can download it here.
In case wkhtmltopdf is not located in
/usr/local/bin/wkhtmltopdf modify the
WKHTMLTOPDF_PATH environment variable in the
WKHTMLTOPDF_PATH=/usr/local/bin/wkhtmltopdf # Change this! :)
If you want to generate invoices for orders placed before plugin's installation run the following command using your terminal:
This installation instruction assumes that you're using Symfony Flex. If you don't, take a look at the legacy installation instruction. However, we strongly encourage you to use Symfony Flex, it's much quicker! :)
Majority of actions contained in SyliusInvoicingPlugin is executed once an event after changing the state of
the Order on
winzou_state_machine is dispatched.
Here is the example:
winzou_state_machine: sylius_payment: callbacks: after: sylius_invoicing_plugin_payment_complete_producer: on: ['complete'] do: ['@sylius_invoicing_plugin.event_producer.order_payment_paid', '__invoke'] args: ['object']
Code placed above is a part of configuration placed in
You can customize this file by adding new state machine events listeners or editing existing ones.
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
sylius_invoicing_plugin_invoice: resource: | alias: sylius_invoicing_plugin.invoice section: admin templates: "@SyliusAdmin\\Crud" only: ['index'] grid: sylius_invoicing_plugin_invoice permission: true vars: all: subheader: sylius_invoicing_plugin.ui.manage_invoices index: icon: inbox type: sylius.resource
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:
Invoicing Plugin renders invoices grid using a certain pattern, including displaying a dot next to channel in which an invoice as issued.
The dot's color is dependant on a property defined on Channel entity or, if not provided, a global parameter named
Like any other parameter,
default_channel_color can also be overwritten in your
By default, when the order is paid, an immutable Invoice pdf file is saved on the server. The save directory is specified
%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
Invoice::$number, which is defined in
By overriding this service, you can change a logic that is used to retrieve the invoice file.
You can add
ShopBillingData fixtures into a yaml to add Channel ShopBillingData info to your installation.
More instructions on the fixtures configuration instructions.
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