PHPackages garrachachraf/invoicing-plugin - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. garrachachraf/invoicing-plugin ActiveSylius-plugin garrachachraf/invoicing-plugin ============================== Invoicing plugin for Sylius. v0.13.4(5y ago)06MITPHPPHP ^7.3 Since Jun 23Pushed 5y agoCompare [ Source](https://github.com/garrachachraf2/InvoicingPlugin)[ Packagist](https://packagist.org/packages/garrachachraf/invoicing-plugin)[ RSS](/packages/garrachachraf-invoicing-plugin/feed)WikiDiscussions master Synced today READMEChangelog (5)Dependencies (39)Versions (28)Used By (0) [ ![](https://camo.githubusercontent.com/1567208cc7c8ec53cf6e2af4f54449a9bb3ab0dee7916998de4e3ce9b7f79015/68747470733a2f2f64656d6f2e73796c6975732e636f6d2f6173736574732f73686f702f696d672f6c6f676f2e706e67) ](https://sylius.com) Invoicing Plugin ================ [](#invoicing-plugin) [![](https://camo.githubusercontent.com/9b437c7f32af7f569d4c0d8e750fd3e94c19a1a7ad491228a34cf567b0ea8af4/68747470733a2f2f73796c6975732e636f6d2f6173736574732f62616467652d6f6666696369616c2d73796c6975732d706c7567696e2e706e67)](https://sylius.com/plugins/) 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](docs/screenshot_invoice.png)](docs/screenshot_invoice.png)[![Screenshot showing invoice browsing page in administration panel](docs/screenshot_admin.png)](docs/screenshot_admin.png) Business value -------------- [](#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 ------------ [](#installation) 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. Apply migration to your database: ``` bin/console doctrine:migrations:migrate ``` 3. 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, add a following snippet at the end of your application's config.yml: ``` knp_snappy: pdf: enabled: true binary: /usr/local/bin/wkhtmltopdf # Change this! :) options: [] ``` 4. If you want to generate invoices for orders placed before plugin's installation run the following command using your terminal: ``` bin/console sylius-invoicing:generate-invoices ``` #### Beware! [](#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! :) Extension points ---------------- [](#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: ``` 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 `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: [http://docs.sylius.com/en/latest/components\_and\_bundles/bundles/SyliusResourceBundle/index.html](http://docs.sylius.com/en/latest/components_and_bundles/bundles/SyliusResourceBundle/index.html). Hence, template for displaying the list of Invoices is defined in `routing.yml` file: ``` 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 `default_channel_color`. Like any other parameter, `default_channel_color` can also be overwritten in your `config.yml` file. Fixtures -------- [](#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 --------------- [](#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 `security@sylius.com`. ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community18 Small or concentrated contributor base Maturity58 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~38 days Recently: every ~1 days Total 27 Last Release 1867d ago PHP version history (2 changes)0.1PHP ^7.2 v0.11.0PHP ^7.3 ### Community Maintainers ![](https://www.gravatar.com/avatar/e83c851bc872b432a2ebc31f05ece10c9e1b6b99af0ea2b86c808a729989e167?d=identicon)[garrachachraf](/maintainers/garrachachraf) --- Top Contributors [![bartoszpietrzak1994](https://avatars.githubusercontent.com/u/22262296?v=4)](https://github.com/bartoszpietrzak1994 "bartoszpietrzak1994 (130 commits)")[![GSadee](https://avatars.githubusercontent.com/u/6140884?v=4)](https://github.com/GSadee "GSadee (81 commits)")[![pamil](https://avatars.githubusercontent.com/u/1897953?v=4)](https://github.com/pamil "pamil (73 commits)")[![Zales0123](https://avatars.githubusercontent.com/u/6212718?v=4)](https://github.com/Zales0123 "Zales0123 (54 commits)")[![Prometee](https://avatars.githubusercontent.com/u/861820?v=4)](https://github.com/Prometee "Prometee (22 commits)")[![Tomanhez](https://avatars.githubusercontent.com/u/39232096?v=4)](https://github.com/Tomanhez "Tomanhez (9 commits)")[![lchrusciel](https://avatars.githubusercontent.com/u/6213903?v=4)](https://github.com/lchrusciel "lchrusciel (6 commits)")[![garrachachraf2](https://avatars.githubusercontent.com/u/75951633?v=4)](https://github.com/garrachachraf2 "garrachachraf2 (5 commits)")[![mamazu](https://avatars.githubusercontent.com/u/14860264?v=4)](https://github.com/mamazu "mamazu (4 commits)")[![stloyd](https://avatars.githubusercontent.com/u/67402?v=4)](https://github.com/stloyd "stloyd (3 commits)")[![pierre-H](https://avatars.githubusercontent.com/u/6079305?v=4)](https://github.com/pierre-H "pierre-H (3 commits)")[![bitbager](https://avatars.githubusercontent.com/u/28542010?v=4)](https://github.com/bitbager "bitbager (2 commits)")[![Roshyo](https://avatars.githubusercontent.com/u/9363039?v=4)](https://github.com/Roshyo "Roshyo (2 commits)")[![AdamKasp](https://avatars.githubusercontent.com/u/29897151?v=4)](https://github.com/AdamKasp "AdamKasp (2 commits)")[![jbcr](https://avatars.githubusercontent.com/u/51637606?v=4)](https://github.com/jbcr "jbcr (2 commits)")[![piotrdutko-k2](https://avatars.githubusercontent.com/u/78080195?v=4)](https://github.com/piotrdutko-k2 "piotrdutko-k2 (1 commits)")[![Gounlaf](https://avatars.githubusercontent.com/u/236413?v=4)](https://github.com/Gounlaf "Gounlaf (1 commits)")[![Konafets](https://avatars.githubusercontent.com/u/363363?v=4)](https://github.com/Konafets "Konafets (1 commits)")[![alanpoulain](https://avatars.githubusercontent.com/u/10920253?v=4)](https://github.com/alanpoulain "alanpoulain (1 commits)")[![chornobils](https://avatars.githubusercontent.com/u/20308356?v=4)](https://github.com/chornobils "chornobils (1 commits)") --- Tags symfonysyliuse-commerceinvoicingsylius-plugin ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/garrachachraf-invoicing-plugin/health.svg) ``` [![Health](https://phpackages.com/badges/garrachachraf-invoicing-plugin/health.svg)](https://phpackages.com/packages/garrachachraf-invoicing-plugin) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M647](/packages/sylius-sylius)[sylius/invoicing-plugin Invoicing plugin for Sylius. 901.0M2](/packages/sylius-invoicing-plugin)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu)[contao/core-bundle Contao Open Source CMS 1231.6M2.3k](/packages/contao-core-bundle) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)