behappy/invoice-plugin

A plugin to generate invoices in Sylius

sylius-invoice

A Plugin for Sylius to generate invoices, _(*1)

Installation-procedure

$ composer require behappy/invoice-plugin

Informations

This plugin use Knp Snappy Bundle. Please refer to it's documentation for wkhtmltopdf installation (https://github.com/KnpLabs/snappy), _(*2)

Enable the plugin

Enable those plugins in AppKernel, _(*3)

// in app/AppKernel.php
public function registerBundles() {
    $bundles = array(
        // ...
        new Knp\Bundle\SnappyBundle\KnpSnappyBundle(),

        new \BeHappy\SyliusCompanyDataPlugin\BeHappySyliusCompanyDataPlugin(),
        new \BeHappy\SyliusInvoicePlugin\BeHappySyliusInvoicePlugin(),
    );
    // ...
}

#in app/config/config.yml
imports:
    ...
    - { resource: "@BeHappySyliusCompanyDataPlugin/Resources/config/config.yml" }
    - { resource: "@BeHappySyliusInvoicePlugin/Resources/config/config.yml" }
    ...

# in routing.yml
...
behappy_company_data_plugin:
    resource: '@BeHappySyliusCompanyDataPlugin/Resources/config/routing.yml'

behappy_invoice_plugin.admin:
    resource: '@BeHappySyliusInvoicePlugin/Resources/config/routes/admin.yml'
    prefix: /admin

behappy_invoice_plugin.shop:
    resource: '@BeHappySyliusInvoicePlugin/Resources/config/routes/shop.yml'
    prefix: /{_locale}/account
    requirements:
        _locale: ^[a-z]{2}(?:_[A-Z]{2})?$
...

Generate database

Simply launch, _(*4)

php bin/console doctrine:schema:update --dump-sql --force

You might have tables referring to BeHappySyliusCompanyDataPlugin if you did not enabled it before requiring this plugin, _(*5)

Optional : generate invoices

In order to have invoices for previously placed orders, you can run this command :, _(*6)

php bin/console behappy:invoices:generate

This command will generate invoices for all orders in state FULFILLED with no invoices attached, _(*7)

That's it !

From now on, each and every time an order is fulfilled, the event listener will create a new invoice and copy (if needed) company data information into a separate table to make them static., _(*8)

A new block is also displayed in admin under the shipment section of orders that have an invoice linked., _(*9)

In the account section for your customers, a link is also displayed for every invoice linked to their orders., _(*10)

Configuration

Invoice number

By default, invoices will be generated with a 12 digits number filled with 0 (str_pad(12, '0', STR_PAD_LEFT)), _(*11)

You can redefine this length definition by overriding this :, _(*12)

# in app/config.yml
parameters:
    ...
    behappy_invoice_plugin.invoice_number.length: 14
    ...

Now every invoice will be 14 digits long., _(*13)

In a near future, this plugin will use a number generator that you'll be free to override according to your needs., _(*14)

Events

During the invoice creation, 2 events are fired with the order as argument., _(*15)

behappy_invoice_plugin.event.invoice.pre_create
behappy_invoice_plugin.event.invoice.post_create

You can subscribe to those events and do whatever you need, _(*16)

Override

In order to override the pdf template file, you simply have to create the following file : app/Resources/BeHappySyliusInvoicePlugin/views/Invoice/pdf.html.twig, _(*17)

Thanks

This plugin is partially inspired by BitBagCommerce/SyliusInvoicingPlugin (https://github.com/BitBagCommerce/SyliusInvoicingPlugin)., _(*18)

Feel free to contribute

You can also ask your questions at the mail address in the composer.json mentioning this package., _(*19)

Other

You can also check our other packages (including Sylius plugins) at https://github.com/BeHappyCommunication, _(*20)