Built by

invoiceahoy

Category

Notification

Version

0.1.1

Last updated

Nov 23, 2023, 18:50:48 PM7 months ago

InvoiceAhoy

Documentation
|
Website

A Medusa Commerce plugin to create invoices with InvoiceAhoy

InvoiceAhoy <> Medusa

A Medusa Commerce plugin to create invoices with InvoiceAhoy.
The plugin subscribes to
Copy to clipboard
order
events and creates an invoice for the order.

Features

  • Automatically create compliant PDF & HTML invoices from Medusa Orders
  • Invoices are accessible from the Backend portal
  • Benefit from InvoiceAhoy's advanced invoicing features like localization
  • The plugin is in active development. If you have any feature requests, please open an issue.

Prerequisites


How to Install

1. Run the following command in the directory of the Medusa backend:
npm install medusa-plugin-invoiceahoy
2. Set the following environment variables in
Copy to clipboard
.env
:
INVOICEAHOY_API_KEY=<YOUR_INVOICEAHOY_API_KEY>
3. In
Copy to clipboard
medusa-config.js
add the following at the end of the
Copy to clipboard
plugins
array:
const plugins = [
// ...
{
resolve: `medusa-plugin-invoiceahoy`,
options: {
logo_url: "https://invoiceahoy.com/ia_logo.svg", // the logo to add to the invoice
api_key: process.env.INVOICEAHOY_API_KEY, // required
},
},
]

Test the Plugin

1. Run the following command in the directory of the Medusa backend to run the backend:
npm run start
2. Place an order using a storefront or the Store APIs. If using the
Copy to clipboard
Manual Payment
option, visit the
Copy to clipboard
Backend Portal
and manually capture the payment.
3. Verify that the invoice was created by checking your InvoiceAhoy account or the Order in
Copy to clipboard
Medusa Backend Portal
.

Events

"invoice.created"

Other channels

Build your own plugins

Develop your own plugins with our API to speed up your processes.

Make your plugin available via npm for it to be shared in our Plugin Library with the broader Medusa community.