From installation to the finished document: create a text per payment method, use placeholders and templates, set document types and scopes, include PayPal Pay Upon Invoice and adapt the text block to the layout of the invoice.
Shopware 6.6 or 6.7. The plugin extends the Shopware document template and needs no theme build. For bank data to be available as placeholders, it should be maintained in the Shopware document settings.
The easiest way is the Plugin Suite: select the plugin, install and activate it, updates then come with one click. Alternatively upload the ZIP in the Shopware admin under Extensions, My extensions, Upload extension, then install and activate it. No SSH access is required.
The plugin sits in the admin menu under Stone & Water, Payment information on PDF documents. Below the header there are two tabs: Payment methods with the texts and Settings with position and appearance on the document.
The list shows all payment methods with the status of the text: Own text, Inherited from a parent scope or No text. At the top you choose sales channel and language, the search field filters by name.
With "Show inactive payment methods" payment methods that are deactivated in Shopware appear too. Labels show when a payment method is not assigned to the selected sales channel or when it is PayPal Pay Upon Invoice. The column "Show on invoice" switches the output on or off directly from the list.
"Edit" opens the window of the payment method. In the field Text you write the note that appears on the document directly below the selected payment method. Formatting such as bold, lists and line breaks is kept. After "Save" the text is active for new documents right away.
The switch Show on document defines whether the text is printed for the selected document type. When switched off the text stays saved and appears again as soon as you switch it on.
"Insert template" offers two ready-made texts: Bank transfer with invoice amount, payment period, bank details and customer and order number as payment reference, and PayPal Pay Upon Invoice (Ratepay) with the note on the assignment to Ratepay and the bank data of the payment. The template lands in the text and can then be adjusted freely.
Placeholders are written in curly brackets, for example {orderNumber}. A click in the placeholder list inserts it at the cursor position. When the document is created Shopware replaces it with the value of the respective order. The list is divided into groups and collapsed when opened.
The preview in the edit window shows the text as it appears on the document, using the current appearance from the settings. Without an entry the latest order with this payment method is used. In the field "Order number for preview" you can choose another order. If there is no order with the payment method yet, the preview works with sample data.
The edit window has a tab per document type: invoice, delivery note, credit note and cancellation invoice. The invoice is the basis. The other document types use its text until you create an own one there; adjusted tabs are marked.
For delivery note, credit note and cancellation invoice the switch "Show on document" is off at first. That way the bank details, for example, do not end up on the delivery note by accident.
At the top of the edit window you choose the sales channel and language you are editing the text for. The basis is "All sales channels" and "All languages". Every other scope uses their text until you set an own one with "Customise text for this scope". "Inherit again" returns to the parent text.
Sales channels and languages with own values are marked in the selection. If you switch scope with unsaved changes, the plugin asks first.
Under Settings, General you define where the text is placed: directly below the line "Selected payment method", after the shipping method before the additional text, or after the whole block, also after the additional text. The additional text is the Shopware snippet document.paymentShippingInfo.additionalInfo, maintained under Settings, Snippets.
Under Spacing you set margin and padding of the text block per side in pixels. Under Appearance you set background and text colour, border width, border colour, corner radius, font size, line height and alignment. Empty colours and the value 0 for font size and line height keep the values of the document.
For cases the settings do not cover there are custom CSS rules. They are inserted into the head of the document. The text block has the class staw-payment-info.
With PayPal Pay Upon Invoice the customer transfers to Ratepay. The bank data, payment reference and due date are stored in the payment of the order and can be inserted with the placeholders of the PayPal Pay Upon Invoice group. The template "PayPal Pay Upon Invoice" already contains the note on the assignment to Ratepay.
For Pay Upon Invoice PayPal adds its own note and bank data block to the document. If "Hide PayPal Pay Upon Invoice default block" is active, this block is removed as soon as an own text is printed. Without an own text the PayPal default block stays.
Questions and requests are welcome directly - support comes from the developer, not from a queue. A feature can also be requested through the Plugin Suite in the admin.
Every setting of the plugin with default value and explanation, in the same order as in the administration. The texts come directly from the plugin (version 1.1.6). Settings apply to the selected sales channel, without an own value the value of "All sales channels" is inherited.
Turns the output on all documents on or off.
Directly below the line "Selected payment method", after the shipping method before the additional text, or after the whole block, also after the additional text.
Hides the note and bank data block PayPal adds itself for Pay Upon Invoice when an own text is printed.
Space between the text block and the surrounding content, in pixels.
Space between border and text, in pixels - mainly useful with a background colour or border.
Leave empty for transparent.
Leave empty for the document text colour.
Value in pixels, 0 for no border.
Colour of the border.
Value in pixels.
Value in points, 0 keeps the document font size.
Factor, for example 1.4 - 0 keeps the document line height.
Alignment of the text in the block: left, centre, right or justified.
Inserted into the head of the document. The text block has the class staw-payment-info.
Defines the sales channel and language you are editing the text for. Without an own value the parent scope is inherited.
Tabs for invoice, delivery note, credit note and cancellation invoice. The other document types use the invoice text until an own text is created there.
Turns the output of the text on the selected document type on or off for the selected scope. The text stays saved.
Appears on the PDF document directly below the selected payment method. Formatting and placeholders are kept.
Optional. Without an order number the latest order with this payment method is used.
All placeholders in the same grouping as in the edit window.
All prices net plus VAT.
Download the free Plugin Suite and upload it in the admin, no SSH needed. It installs and updates the plugin with one click. You buy the licence directly from us, with an invoice from us and support straight from the developer.
The plugin will be listed in the official Shopware Community Store. Installation and automatic updates then run through the plugin manager in the backend, billing through your Shopware account. We will link it here as soon as it is available.