Install PeppolKit in Joomla
This is how you install the PeppolKit plugin in Joomla and connect your HikaShop or VirtueMart shop. After that every order gets an invoice as soon as it reaches a paid status, and a credit note when you set it to Refunded.
What you need
- Joomla 4.2 or newer with HikaShop or VirtueMart, and PHP 8.1 or newer. Tested with Joomla 5.4, HikaShop Starter and VirtueMart 4.8.
- An administrator who may install extensions.
- A company established in the Netherlands or Belgium, with your VAT number and your company registration number.
The screenshots come from an English admin. If yours is in Dutch or French, PeppolKit's texts are translated.
Install
- Download the zip at peppolkit.com/downloads/joomla/plg_system_peppolkit.zip. The plugin is not in the Joomla Extensions Directory yet.
- Upload it in your Joomla admin under System → Install → Extensions, on the Upload Package File tab. The plugin switches itself on.
Drag the zip into the box or choose it with the green button. - Open the plugin. Go to System → Manage → Plugins and search for peppolkit. In an English admin it is called System - PeppolKit.
The plugin in the list, with the search term peppolkit.
Connect
- Connect your shop. Check your email address, agree to the terms and click Connect to PeppolKit. The account is free up to 20 invoices a month and asks for no payment details.
Connecting takes only your email address. - Fill in your company details. Click Open the PeppolKit dashboard. The dashboard opens in a new tab and you are signed in at once. Under Settings, fill in your company name, address, VAT number and company registration number and save. As long as those are missing, PeppolKit makes no invoices.
Set up
On the same page you choose at which order statuses PeppolKit acts. You see the statuses of your own shop: HikaShop's or VirtueMart's. Save with Save.
- Invoice at status: an order gets its invoice the first time it reaches one of these statuses. By default: Confirmed and Shipped, plus Delivered in HikaShop or Completed in VirtueMart.
- Credit note at status: an invoiced order that reaches one of these statuses gets a credit note. By default: Refunded.
When is an invoice or credit note made?
- Invoice: the first time an order reaches one of the chosen statuses. With bank transfer an order is first Created (HikaShop) or Pending (VirtueMart): the invoice follows as soon as you or the payment plugin sets it to Confirmed.
- Amounts: a coupon is shown as a discount on the product lines. Shipping is a line of its own, and so is a payment fee in VirtueMart.
- Credit note: HikaShop and VirtueMart have no partial refund with an amount. When you set an order to Refunded, PeppolKit makes a credit note for the whole order.
VAT numbers of business customers
HikaShop has a VAT number field on the address, but it is switched off by default. Publish it under HikaShop → Display → Custom fields (VAT number). VirtueMart has no VAT number field of its own: create a field named vat_number under Configuration → Shopper Fields. PeppolKit reads the number, checks it with VIES and applies reverse charge on the invoice for a valid number from another EU country.
Activate Peppol
In the dashboard, Settings → Peppol says how your shop sends. Belgian shop? Confirm your company's identity there once, in about 5 minutes; Peppol is then included in every plan. Dutch shop? Connect your own free Peppyrus account, see Create a Peppyrus account.
Earlier orders and your first test
The button Invoice the paid orders of the last 60 days makes invoices for orders that were paid before you connected. An order never gets two invoices. Want to test first? Place a test order, mark it as paid and look in the dashboard under Invoices: the invoice is there as a PDF and as a UBL file.
Frequently asked questions
No invoice arrives. What now?
Check that the order's status is one you ticked under Invoice at status and that your company details are saved in the dashboard. The plugin's page says how many orders are still waiting to be sent, with PeppolKit's last answer. More causes are in Fix an invoice problem.
Does it work with VirtueMart?
Yes, since version 1.1 of the plugin. If you have an older version, install the new zip over the old one: your connection stays in place.
How do I remove the plugin?
Click Disconnect on the plugin's page, or uninstall the plugin under System → Manage → Extensions: that disconnects your shop as well. Your invoices stay in your PeppolKit dashboard for 30 days.
PeppolKit by platform: Shopify, WooCommerce, PrestaShop, Magento, Drupal Commerce, OpenCart, Shopware, Joomla, bol.com, Lightspeed, CCV Shop, Wix and Stripe. See how it works for your webshop.
Leave Peppol to PeppolKit.
Install PeppolKit and your business customers get their invoice over Peppol, without you having to deal with the network.
Choose your platform Start free with 20 invoices a month.An explanation for orientation, not tax advice.