Generate an Invoice for every placed order
Branch: master
Clone or download
bartoszpietrzak1994 style #106 Add official Sylius plugin badge (Zales0123)
This PR was merged into the 1.0-dev branch.



0b460e3 Add official Sylius plugin badge
Latest commit cc3d405 Feb 15, 2019

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.

Screenshot showing invoice browsing page in administration panel

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.


  1. Require plugin with composer:

    composer require sylius/invoicing-plugin

    Remember to allow community recipes with composer config extra.symfony.allow-contrib true or during plugin installation process

  2. Copy plugin migrations to your migrations directory (e.g. src/Migrations) and apply them to your database:

    cp -R vendor/sylius/invoicing-plugin/migrations/* src/Migrations
    bin/console doctrine:migrations:migrate
  3. Check if you have wkhtmltopdf binary. If not, you can download it here.

In case wkhtmltopdf is not located in /usr/local/bin/wkhtmltopdf, add a following snippet at the end of your application's config.yml:

        enabled: true
        binary: /usr/local/bin/wkhtmltopdf # Change this! :)
        options: []


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! :)

Extension points

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:

                    on: ['complete']
                    do: ['@Sylius\InvoicingPlugin\EventProducer\OrderPaymentPaidProducer', '__invoke']
                    args: ['object']

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.

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:

    resource: |
        alias: sylius_invoicing_plugin.invoice
        section: admin
        templates: SyliusAdminBundle:Crud
        only: ['index']
        grid: sylius_invoicing_plugin_invoice
        permission: true
                subheader: sylius_invoicing_plugin.ui.manage_invoices
                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:


You can add ShopBillingData fixtures into a yaml to add Channel ShopBillingData info to your installation. More instructions on the fixtures configuration instructions.

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