Shopware Plugin Installation

Installation and configuration of the Shopware plugin for the PDF document module.

The Solutioo Invoice Documents plugin extends Shopware with the ability to receive PDF documents from Business Central and display them in the customer portal.

1. Installation

1.1 Via Composer (recommended)

composer require solutioo/invoice-documents
bin/console plugin:refresh
bin/console plugin:install --activate SolutiooInvoiceDocuments
bin/console cache:clear

1.2 Manual installation

1. Download the plugin.
2. Extract it to custom/plugins/SolutiooInvoiceDocuments
3. Run the following commands:

bin/console plugin:refresh
bin/console plugin:install --activate SolutiooInvoiceDocuments
bin/console cache:clear
bin/console theme:compile

2. Plugin functions

2.1 API endpoints

The plugin provides the following API endpoints:

Endpoint	Method	Description
/api/solutioo-invoice-document/import	POST	Imports a new document
/api/solutioo-invoice-document/by-reference/{ref}	GET	Checks whether a document exists
/api/solutioo-invoice-document/update/{id}	PATCH	Updates a document
/api/solutioo-invoice-document/delete/{id}	DELETE	Deletes a document
/api/solutioo-invoice-document/bulk	POST	Bulk import of documents

2.2 Customer portal

After the installation, a new menu item "Documents" appears in the customer area:

3. Customer mapping

The plugin supports several methods for mapping customers:

Mapping priority

Customer ID

Direct Shopware customer ID (highest priority)

Email address

Search by customer email

Customer number

Search by customer number

Mapping by email is particularly useful when the customer numbers do not match between the systems.

4. API authentication

The API uses the standard Shopware Admin API authentication:

Integration (recommended)

1. Create an integration in Shopware under Settings System Integrations
2. Make a note of the Access Key ID and Secret Access Key
3. Enter these in Business Central

User authentication

Alternatively, an admin user can be used:

1. Create an admin user in Shopware
2. Use the user name and password in Business Central

5. Document types

The plugin supports the following document types:

API value	German label	English label
invoice	Rechnung	Invoice
credit_note	Gutschrift	Credit Note
delivery_note	Lieferschein	Delivery Note
cancellation	Storno	Cancellation
other	Sonstiges	Other

6. Database structure

The plugin creates a new table solutioo_invoice_document:

Field	Type	Description
id	binary(16)	Primary key (UUID)
customer_id	binary(16)	Associated customer
invoice_number	varchar(255)	Document number
invoice_date	date	Document date
document_type	varchar(50)	Document type
external_reference	varchar(255)	External reference (BC number)
media_id	binary(16)	Linked media file
original_filename	varchar(255)	Original file name

7. Updates

# Update the plugin
composer update solutioo/invoice-documents
bin/console plugin:update SolutiooInvoiceDocuments
bin/console cache:clear
bin/console theme:compile

Always create a backup of your database before updates!