Vertragsmanagement

Vertragsmanagement

Please click for English documentation.

Vorwort

Wir freuen uns, dass Sie sich für unser Shopware-6-Plugin Vertragsmanagement interessieren oder sich bereits dafür entschieden haben.
Dieses Plugin ermöglicht es Ihnen, Verträge direkt im Shopware-Admin zu erstellen, zu verwalten und Shopkunden transparent zur Verfügung zu stellen.

Durch digitale Akzeptanz im Kundenkonto, Revisionsverwaltung sowie eine flexible PDF-Konfiguration werden Ihre Vertragsprozesse effizienter und nachvollziehbar dokumentiert.

 

Sollten Sie Vorschläge zur Weiterentwicklung des Plugins haben oder individuelle Anpassungen wünschen, zögern Sie nicht, uns zu kontaktieren. Registrieren Sie sich hierzu unter https://www.synergy-networks.de/konto#show-registration und erstellen ein Ticket für unser Entwicklerteam. Wir setzen uns anschließend umgehend mit Ihnen in Verbindung.

Eine Schritt-für-Schritt-Anleitung, wie Sie ein Ticket bei SYNERGY NETWORKS erstellen können finden Sie in hier Support-Ticket bei SYNERGY NETWORKS.



1. Installation und Update

Die Installation des Plugins erfolgt über den Erweiterungen-Manager im Shopware-Admin.

1.1 Plugin installieren / updaten

  1. Öffnen Sie Erweiterungen → Meine Erweiterungen in der Shopware-Administration.

  2. Installieren bzw. aktualisieren Sie das Plugin.

  3. Aktivieren Sie das Plugin, falls dies noch nicht geschehen ist.


2. Konfiguration

Die Plugin-Konfiguration finden Sie unter
Erweiterungen → Meine Erweiterungen → Vertragsmanagement.

2.1 Basiseinstellungen

  1. Verkaufskanal auswählen
    Wählen Sie den Verkaufskanal, für den die Konfiguration gelten soll.

  2. Vertragsarten
    Geben Sie hier Ihre Vertragsarten an (z. B. Mitgliedervertrag;Leasingvertrag).
    Diese Vertragsarten stehen später bei der Vertragserstellung zur Auswahl
    (Inhalte → Vertragsmanagement → Neuen Vertrag erstellen → Typ).
    Hinweis: Trennen Sie mehrere Vertragsarten durch ein Semikolon (z.B. AVV;Leasingvertrag;…).

  3. Standard-Sales-Channel für PDF-Belegerstellung
    Wählen Sie den Verkaufskanal, der für die Erstellung der Vertrags-PDFs verwendet wird.

  4. Logging aktivieren / deaktivieren
    Ist diese Option aktiv, werden interne Log-Einträge zu relevanten Vertragsaktionen erstellt.
    Die Protokollierung dient ausschließlich der internen Nachvollziehbarkeit.

  5. Einstellungen speichern

Vertragsmanagement_Basiseinstellungen.png

3.Einstellungen in der Shopware-Administration

3.1 Vertragsmanagement – Übersicht

Das Vertragsmanagement erreichen Sie über Inhalte → Vertragsmanagement.

  1. In der Übersichtstabelle sehen Sie alle angelegten Verträge.

  2. Über die Listeneinstellungen können Sie die angezeigten Spalten (z. B. Aktiv, Typ, Titel, interne Notiz, aktuelle Revision, Erstellt, Zuletzt aktualisiert) ein- oder ausblenden sowie deren Reihenfolge anpassen.

  3. Über den Button „Neuen Vertrag erstellen“ legen Sie einen neuen Vertrag an.


3.2 Neuen Vertrag erstellen

Klicken Sie auf „Neuen Vertrag erstellen“, um einen neuen Vertrag anzulegen.

Vertragsmanagement_Vertrag erstellen_neu.png
  1. Titel
    Vergeben Sie einen eindeutigen Titel für den Vertrag.

  2. Typ
    Wählen Sie einen Vertragstyp aus.
    Die verfügbaren Typen werden in der Plugin-Konfiguration unter Vertragsarten definiert (siehe Punkt 2.1).

  3. Admin-Einstellungen
    Hinweis: Diese Einstellungen können nach der Erstellung nicht mehr geändert werden.

    • Vertrag mit Shop-Kunden
      Definiert, ob der Vertrag Shopkunden betrifft. Wenn aktiviert, dann gilt es für alle Shop-Kunden.

    • Akzeptieren erforderlich
      Shopkunden müssen den Vertrag im Kundenkonto aktiv akzeptieren. (Nur verfügbar wenn „Vertrag mit Shop-Kunden“ aktiviert ist).
      Ist nur diese Option aktiviert, wird der Vertrag bei allen Kunden im Kundenkonto zum Akzeptieren angezeigt.

    • Revisionen aktivieren
      Ermöglicht die Erstellung von Vertragsrevisionen. (Nur verfügbar wenn „Vertrag mit Shop-Kunden“ aktiviert ist).
      Ist die Option aktiviert, müssen Sie im Vertrag (Allgemein>Revisionen) initial den Button “Neue Revisionen jetzt erstellen” klicken, um den Vertrag zu veröffentlichen und im Kundenkonto sichtbar zu machen.

    • Spezielle Kundenzuweisung
      Standardmäßig erhalten alle Shopkunden den Vertrag. Ist die Option aktiviert, wird der Vertrag nur ausgewählten Kunden angezeigt. (Nur verfügbar wenn „Vertrag mit Shop-Kunden“ aktiviert ist)

    • Vertrag mit System-Benutzern (nähere Informationen, siehe unter Punkt 5)
      Aktivieren Sie diese Option, wenn Sie interne Verträge mit Systembenutzern erstellen.

  4. Speichern
    Nach dem Speichern erscheint der Vertrag in der Übersicht und kann weiter bearbeitet werden.

 


4. Einstellungen bei angelegten Verträgen

4.1 Hinweisbox beim Erstellen eines neuen Vertrags

Beim Anlegen eines neuen Vertrags kann eine Hinweisbox erscheinen, die auf fehlende Einstellungen hinweist.
Diese Hinweise helfen dabei, den Vertrag korrekt darzustellen und auszugeben.

Vertragsmanagement_Fehleranzeige.jpg

Hier im Beispiel:

  1. Fehlende PDF-Einstellungen

Der Hinweis erscheint, wenn erforderliche Angaben für die PDF-Erstellung noch nicht vollständig hinterlegt sind (z. B. PDF-Name, Geschäfts-Telefon, Geschäfts-Webseite).

Lösung:
Öffnen Sie die PDF-Einstellungen, ergänzen Sie die fehlenden Angaben und speichern Sie die Einstellungen.

  1. Fehlende Übersetzungen

Der Hinweis wird angezeigt, wenn für einzelne Sprachen oder Verkaufskanäle kein Vertragstext gespeichert ist.

  • Ist kein Text in einer Sprache vorhanden, wird automatisch der Text der Ausgangssprache (z. B. Deutsch) angezeigt.

  • Der Vertragstext muss dennoch pro Sprache einmal gespeichert werden.

Lösung:
Wechseln Sie über den Sprachumschalter in die jeweilige Sprache, tragen Sie einen Vertragstext ein (oder übernehmen Sie den Text der Ausgangssprache) und speichern Sie.

Oder, wenn Sie die Sprache nicht benötigen, deaktivieren Sie die jeweilige Sprache unter Einstellungen > Sprachen. Dann wird der Hinweis für die fehlende Übersetzung nicht weiter angezeigt.


4.2 Allgemeine Vertragsinformationen

Vertragsmanagement_allgemeine Vertragsinfos_1.png

Hinweis:
Hier im Beispiel wurde die Optionen “Akzeptieren” (Shopkunden müssen den Vertrag im Kundenkonto akzeptieren.) und “Spezielle Kundenzuweisung”(siehe 3.2) gewählt. Der Tab “Spezielle Kundenzuweisung” wird angezeigt. Kunden können hier ausgewählt werden, anschließend wird der Vertrag nur diesen Kunden angezeigt.

Allgemeine Vertragsinformationen (1)

  • Titel (2) – Bezeichnung des Vertrags

  • Typ (3)– Vertragstyp

  • Aktiv (4) – Aktiv-Status des Vertrags

  • Interne Notiz (5) – interne Hinweise zum Vertrag

Vertragstext (6)

Fügen Sie den vollständigen Vertragstext in das Textfeld ein.

Hilfsfunktionen (Platzhalter) (7)

  • SYN_Date
    Setzt automatisch das aktuelle Datum im Format dd.mm.yyyy.
    Hinweis: Das Datum wird bei erneuter PDF-Generierung aktualisiert.

  • SYN_User
    Fügt automatisch Empfängerdaten aus dem Kundenkonto ein (Name, Firma, Rechnungsadresse).

Vertragsmanagement_allgemeine Vertragsinfos_2.png

Setzen der Hilfsfunktionen: Ansicht im Admin mit SYN_User und SYN_Date gesetzt:

Vertragsmanagement_Hilfsfunktionen_backend.png

Ansicht im Kundenvertrag:

Vertragsmanagement_Hilfsfunktionen1.png

Hinweis zur PDF-Vorschau und Platzhaltern

Bei der Verwendung von Platzhaltern (z. B. für Datum oder Kundendaten) werden diese in der PDF-Vorschau im Admin-Bereich nicht aufgelöst.

In der Admin-Vorschau werden die Platzhalter (z. B. SYN_User) unverändert angezeigt, da zu diesem Zeitpunkt noch kein konkreter Empfänger zugeordnet ist.

Die Auflösung der Platzhalter erfolgt erst im Kundenkonto, sobald der Vertrag einem Shopkunden zugewiesen ist. Das Plugin bezieht die erforderlichen Daten automatisch aus den entsprechenden Kunden- und Adressfeldern und ersetzt die Platzhalter dort korrekt.


4.3 Revisionen

Wird angezeigt, wenn Sie unter 3.2. Neuen Vertrag erstellen > Einstellungen Revisionen aktiviert haben. Wenn aktiviert, müssen Sie nach Anlage des Vertrages initial den Button “Neue Revisionen jetzt erstellen”(9) klicken, um den Vertrag zu veröffentlichen und im Kundenkonto sichtbar zu machen.

Änderungen an Vertragsinhalten werden über Revisionen (8) vorgenommen.

  • Tragen Sie die Änderungen stichpunktartig in das Revisionsfeld ein.
    Diese Informationen werden im Kundenkonto angezeigt.

  • Über „Neue Revision jetzt erstellen“(9) wird die Revision veröffentlicht.

  • !Nach Veröffentlichung kann eine Revision nicht mehr geändert oder gelöscht werden.!

In der Revisionsübersicht (10) sehen Sie alle Versionen und können diese als PDF aufrufen.

Vertragsmanagement_allgemeine Vertragsinfos_3.png

4.4 Spezielle Kundenzuweisung

Wird angezeigt, wenn Sie unter 3.2. Neuen Vertrag erstellen > Einstellungen “Spezielle Kundenzuweisungen” aktiviert haben.

In der Kundenübersicht wählen Sie aus, welchen speziellen Kunden der Vertrag angezeigt werden soll.

  • Kunden können über Checkboxen aktiviert werden.

  • Über Listeneinstellungen lassen sich Spalten ein- und ausblenden.

  • Filter ermöglichen die gezielte Suche nach Kunden (z. B. Kundennummer, Name, Firma).

  • Speichern Sie Ihre Auswahl, um die Zuweisung zu übernehmen.

Vertragsmanagement_Spezielle Kundenzurodnung.png

4.5 PDF-Einstellungen

Allgemeine PDF-Einstellungen

  • PDF-Name

  • Geschäftslogo (wird im PDF ausgegeben)

  • Dateinamen-Präfix (Optionaler Text, der dem PDF-Dateinamen vorangestellt wird.)

  • Dateinamen-Suffix (Optionaler Text, der am Ende des Dateinamens ergänzt wird.)

Layout

  • Seitenausrichtung: Portrait

  • Seitenformat: A4

  • Dateiformat: PDF

  • Dokumententitel in der PDF anzeigen (Hierbei handelt es sich um den Vertragstitel, den Sie unter 4.1 vergeben haben.)

  • Kopf- / Fußzeile (optional)

  • Seitennummerierung (optional)

Geschäftsdaten im PDF

Die folgenden Angaben erscheinen in Kopf- bzw. Fußzeile des PDFs:

Straße, PLZ, Stadt, Land, Geschäftsname, E-Mail, Telefon, Webseite, Steuernummer, Finanzamt, USt-ID, Bank, IBAN, BIC, Geschäftsführer

Über die PDF-Vorschau kann der Vertrag jederzeit geprüft werden.

 

Vertragsmanagement_PDF_Einstellung_neu.jpg

5. Vertrag mit System-Benutzern (Interne Verträge)

Mit dem Plugin Vertragsmanagement können neben Verträgen für Shopkunden auch Verträge mit System-Benutzern (interne Verträge) verwaltet werden.
Diese Funktion ist z. B. für Mitarbeiterverträge, interne Vereinbarungen oder Richtlinien gedacht.
Verträge mit System-Benutzern werden ausschließlich im Admin-Bereich und im Dashboard der zugewiesenen Mitarbeiter angezeigt – nicht im Kundenkonto.


5.1 Vertrag mit System-Benutzern anlegen

Bei der Erstellung eines neuen Vertrags kann die Option „Vertrag mit mit System-Benutzer“ ausgewählt werden.

Ist diese Option aktiv:

  • wird der Vertrag als interner Vertrag behandelt

  • erscheint nicht im Shop-Frontend für Kunden

  • kann gezielt Mitarbeitern (Admin-Benutzern) zugewiesen werden
    Nach dem Speichern steht zusätzlich der Reiter „Mitarbeiter“ zur Verfügung.

Vertragsmanagement_interner Vertrag_allgemein.png
  1. Titel des Vertrags

  2. Aktivierung des Vertrags

  3. interne Notizen

  4. Vertragstext

  5. 5. Speichern der Einstellungen


5.2 Mitarbeiter einem Vertrag zuweisen

Im Reiter „Mitarbeiter“ legen Sie fest, welche Mitarbeiter diesen Vertrag erhalten sollen.
Es können einzelne oder mehrere Mitarbeiter ausgewählt werden.

Vertragsmanagement_interner Vertrag_Mitarbeiter.jpg


Zugewiesene Mitarbeiter sehen den Vertrag nach dem Login in ihrem Dashboard.
Der Vertrag kann dort eingesehen und als PDF heruntergeladen werden.

Vertragsmanagement_Dashboard_MA.png

5.3 Benutzer & Rechte – Voraussetzungen

Damit Mitarbeiter in der Vertragsverwaltung erscheinen und Verträge erhalten können, sind entsprechende Benutzer- und Rechte-Einstellungen erforderlich (Admin>Einstellungen>Benutzer&Rechte).
Voraussetzungen für Mitarbeiter:

  • Der Mitarbeiter muss als Benutzer im Shopware-Admin angelegt sein.

  • Der Benutzer darf kein Administrator sein.

  • Dem Benutzer muss eine der vom Plugin bereitgestellten Rollen zugewiesen werden.

Vertragsmanagement_Benutzer_Management2.png

5.4 Rollen für das Vertragsmanagement

5.4.1 Rollen


Das Plugin ergänzt die Basisinformationen in der Benutzerverwaltung (1) um zwei
spezielle Rollen (2):
SynCmViewer

  • darf Verträge ansehen

  • geeignet für Mitarbeiter, die Verträge nur lesen oder herunterladen sollen

SynCmEditor

  • darf Verträge ansehen, erstellen und bearbeiten

  • geeignet für Personalverantwortliche oder interne Administratoren

Diese Rollen können unter
Einstellungen → Benutzer & Rechte → Benutzer → Rollen
vergeben werden.


5.4.2 Zusatzangaben


Das Plugin erweitert die Basisinformationen in der Benutzerverwaltung (1) um zusätzliche Felder im Bereich „Zusatzangaben für das Vertragsmanagement“(3):

  • Straße und Hausnummer

  • Postleitzahl

  • Stadt


Diese Angaben werden verwendet, wenn im Vertrag der Platzhalter SYN_User eingesetzt wird.
Die Daten werden dann automatisch in den Vertrag übernommen, z. B. für Adressangaben in Mitarbeiterverträgen.

Vertragsmanagement_interner Vertrag_MA anlegen.png

 


6. Akzeptierte Verträge

Unter Inhalte → Akzeptierte Verträge sehen Sie alle von Kunden akzeptierten Verträge.

Über die Listeneinstellungen können u. a. folgende Spalten angezeigt werden:

  • Firma

  • Kundennummer

  • Vor- und Nachname

  • Vertrag / Revision


7.Anzeige im Frontend (Kundenkonto)

7.1 Vertragsübersicht

Im Kundenkonto steht der Menüpunkt „Verträge“ zur Verfügung.
Hier werden alle dem Kunden zugewiesenen Verträge angezeigt, inklusive:

  • Vertragstitel

  • aktueller Revision

  • Status (akzeptiert / nicht akzeptiert)

  • Zeitpunkt der letzten Ansicht

Verträge können jederzeit als PDF angezeigt oder heruntergeladen werden.


 

7.2 Vertrag akzeptieren

Ist eine Akzeptanz erforderlich, muss der Kunde den Vertrag aktiv bestätigen.

Mit einem Klick auf „Akzeptieren“ bestätigt der Kunde verbindlich die Vertragsbedingungen.
Der Vertrag wird anschließend als akzeptiert gekennzeichnet.

Kundenkonto_Vertrag akzeptieren.jpg

7.3 Hinweis bei neuen oder geänderten Verträgen

Bei Veröffentlichung einer neuen Revision erhält der Kunde einen deutlichen Hinweis im Kundenkonto.

  • Geänderte Verträge werden markiert

  • Solange die neue Revision nicht akzeptiert wurde, gilt der Vertrag als nicht bestätigt

  • Änderungen zur vorherigen Version werden angezeigt

Dies gewährleistet Transparenz und Nachvollziehbarkeit bei Vertragsänderungen.


8. FAQ

8.1 Warum können bestimmte Einstellungen eines Vertrags nachträglich nicht geändert werden?

Einstellungen bei der Anlage eines Vertrags (z. B. Vertrag mit Shopkunden, Akzeptieren erforderlich, Revisionen aktivieren, spezielle Kundenzuweisung) werden bei der Erstellung des Vertrags festgelegt und können anschließend nicht mehr geändert werden. Dies stellt sicher, dass Vertragsprozesse konsistent, nachvollziehbar und rechtssicher bleiben. Soll eine andere Konfiguration verwendet werden, muss ein neuer Vertrag angelegt werden.

8.2 Warum wird ein Vertrag im Kundenkonto noch nicht angezeigt?

Ein Vertrag wird im Kundenkonto nur angezeigt, wenn er aktiv ist und – bei Kundenverträgen mit Revisionen – mindestens eine veröffentlichte Revision besitzt.
Bitte prüfen Sie außerdem, ob der Vertrag Shopkunden betrifft und ggf. korrekt Kunden zugewiesen wurde.

8.3 Warum muss nach dem Erstellen eines Vertrags eine erste Revision veröffentlichen?

Nur relevant, wenn Revisionen aktiviert wurden (siehe 3.2).

Wenn beim Erstellen eines neuen Vertrags die Option „Revisionen aktivieren“ gewählt wurde, ist der Vertrag zunächst ein Entwurf. Erst durch das Veröffentlichen einer ersten Revision wird der Vertrag im Kundenkonto sichtbar.

Wurden Revisionen nicht aktiviert, ist keine Veröffentlichung einer Revision erforderlich.

8.4 Können veröffentlichte Revisionen nachträglich geändert oder gelöscht werden?

Nur relevant, wenn Revisionen aktiviert wurden (siehe 3.2).

Sind Revisionen aktiv, können veröffentlichte Revisionen nicht geändert oder gelöscht werden.
Dies dient der Nachvollziehbarkeit und rechtssicheren Dokumentation.

Änderungen an Vertragsinhalten erfolgen immer über eine neue Revision.

8.5 Warum werden Platzhalter wie SYN_User in der PDF-Vorschau nicht angezeigt?

In der PDF-Vorschau im Admin-Bereich werden Platzhalter nicht aufgelöst, da dort noch kein konkreter Empfänger (Kunde oder Mitarbeiter) zugeordnet ist.
Die Vorschau zeigt daher bewusst die Platzhalter selbst an. Platzhalter werden erst im Kundenkonto bzw. im Mitarbeiter-Dashboard ersetzt/ sichtbar, sobald der Vertrag einer konkreten Person zugewiesen ist. Das Plugin bezieht die Daten automatisch aus den jeweiligen Kunden- oder Benutzerdatenfeldern und setzt sie korrekt im Vertrag ein.

8.6 Warum erscheint der Hinweis „Fehlende PDF-Einstellungen“ beim Erstellen eines Vertrags?

Dieser Hinweis wird angezeigt, wenn erforderliche Angaben für die PDF-Erstellung fehlen (z. B. PDF-Name oder Geschäftsdaten). Die Angaben werden für die korrekte Darstellung der Vertrags-PDF benötigt.

Lösung:
Ergänzen Sie die fehlenden Felder in den PDF-Einstellungen des Plugins und speichern Sie die Konfiguration.

8.7 Muss ich den Vertragstext für jede Sprache separat speichern?

Ja. Auch wenn der Vertragstext identisch ist, muss er für jede Sprache einmal gespeichert werden.
Nur so erkennt Shopware die Übersetzung als vollständig und der Hinweis verschwindet.

8.8 Was passiert, wenn ein Kunde einen Vertrag nicht akzeptiert?

Solange ein Vertrag oder eine neue Revision nicht akzeptiert wurde, gilt der Vertrag als nicht akzeptiert. Der Kunde wird im Kundenkonto deutlich auf die Änderung hingewiesen und kann die neue Version einsehen und akzeptieren.

8.9 Können Verträge nur bestimmten Kunden zugewiesen werden?

Ja. Über die spezielle Kundenzuweisung können Verträge gezielt einzelnen Kunden zugeordnet werden. Ohne diese Option erhalten standardmäßig alle Shopkunden den Vertrag.



Foreword

We are pleased that you are interested in our Shopware 6 plugin Contract Management or have already decided to use it.
This plugin allows you to create, manage, and transparently provide contracts directly within the Shopware admin to your shop customers.

Through digital acceptance in the customer account, revision management, and flexible PDF configuration, your contract processes become more efficient and are documented in a traceable manner.

 

If you have suggestions for further development of the plugin or desire individual adjustments, do not hesitate to contact us. To do so, register https://www.synergy-networks.de/konto#show-registration and create a ticket for our development team. We will then get in touch with you promptly.

A step-by-step guide on how to create a ticket at SYNERGY NETWORKS can be found here Support-Ticket bei SYNERGY NETWORKS.



1. Installation and Update

The installation of the plugin is done via the Extensions Manager in the Shopware admin.

1.1 Install / Update Plugin

  1. Open Extensions → My Extensions in the Shopware administration.

  2. Install or update the plugin.

  3. Activate the plugin if this has not already been done.


2. Configuration

You can find the plugin configuration under
Extensions → My Extensions → Contract Management.

2.1 Basic Settings

  1. Select Sales Channel
    Choose the sales channel for which the configuration should apply.

  2. Contract Types
    Enter your contract types here (e.g. Membership Contract; Leasing Contract).
    These contract types will later be available when creating a contract
    (Content → Contract Management → Create New Contract → Type).
    Note: Separate multiple contract types with a semicolon (e.g. AVV; Leasing Contract; …).

  3. Default Sales Channel for PDF Document Creation
    Select the sales channel used for generating contract PDFs.

  4. Enable/Disable Logging
    If this option is enabled, internal log entries are created for relevant contract actions.
    Logging serves exclusively for internal traceability.

  5. Save Settings

Vertragsmanagement_Basiseinstellungen.png

3.Settings in the Shopware Administration

3.1 Contract Management – Overview

You can access contract management via Content → Contract Management.

  1. In the overview table, you can see all created contracts.

  2. Via the list settings you can show or hide the displayed columns (e.g., Active, Type, Title, Internal Note, Current Revision, Created, Last Updated) and adjust their order.

  3. By clicking the button “Create New Contract” you can create a new contract.


3.2 Create New Contract

Click on "Create New Contract" to create a new contract.

Vertragsmanagement_Vertrag erstellen_neu.png
  1. Title
    Assign a unique title for the contract.

  2. Type
    Select a contract type.
    The available types are defined in the plugin configuration under Contract Types (see section 2.1).

  3. Admin Settings
    Note: These settings cannot be changed after creation.

    • Contract with Shop Customers
      Defines whether the contract applies to shop customers. If enabled, it applies to all shop customers.

    • Acceptance Required
      Shop customers must actively accept the contract in their customer account. (Only available if “Contract with Shop Customers” is enabled).
      If only this option is enabled, the contract will be shown for acceptance to all customers in the customer account.

    • Enable Revisions
      Allows the creation of contract revisions. (Only available if “Contract with Shop Customers” is enabled).
      If this option is enabled, you must initially click the button “Create new revisions now” in the contract (General > Revisions) to publish the contract and make it visible in the customer account.

    • Special Customer Assignment
      By default, all shop customers receive the contract. If this option is enabled, the contract is shown only to selected customers. (Only available if “Contract with Shop Customers” is enabled)

    • Contract with System Users (more information available under Section 5)
      Enable this option if you want to create internal contracts with system users.

  4. Save
    After saving, the contract appears in the overview and can be further edited.

 


4. Settings for Created Contracts

4.1 Notice Box When Creating a New Contract

When creating a new contract, a notice box may appear indicating missing settings.
These notices help to correctly display and output the contract.

Vertragsmanagement_Fehleranzeige.jpg

Example here:

  1. Missing PDF settings

The notice appears when required information for PDF creation has not yet been fully provided (e.g., PDF name, business phone, business website).

Solution:
Open the PDF settings, add the missing details, and save the settings.

  1. Missing translations

The notice is displayed when no contract text is saved for certain languages or sales channels.

  • If no text is available in a language, the text of the source language (e.g., German) will be displayed automatically.

  • The contract text must still be saved once per language.

Solution:
Switch to the respective language using the language selector, enter a contract text (or copy the text from the source language), and save.

Alternatively, if you do not require the language, deactivate it under Settings > Languages. The message indicating that the translation is missing will then no longer be displayed.


4.2 General Contract Information

Vertragsmanagement_allgemeine Vertragsinfos_1.png

Note:
In this example, the options “Accept” (shop customers must accept the contract in their customer account) and “Special Customer Assignment” (see 3.2) were selected. The “Special Customer Assignment” tab is displayed. Customers can be selected here, and subsequently the contract will only be shown to these customers.

General Contract Information (1)

  • Title (2) – Contract designation

  • Type (3) – Contract type

  • Active (4) – Active status of the contract

  • Internal Note (5) – internal notes about the contract

Contract Text (6)

Insert the full contract text into the text field.

Helper Functions (Placeholders) (7)

  • SYN_Date
    Automatically sets the current date in the format dd.mm.yyyy.
    Note: The date is updated when the PDF is regenerated.

  • SYN_User
    Automatically inserts recipient data from the customer account (name, company, billing address).

Vertragsmanagement_allgemeine Vertragsinfos_2.png

Setting the helper functions: View set in Admin with SYN_User and SYN_Date:

Vertragsmanagement_Hilfsfunktionen_backend.png

View in the customer contract:

Vertragsmanagement_Hilfsfunktionen1.png

Note on PDF preview and placeholders

When using placeholders (e.g., for date or customer data), these are not resolved in the PDF preview in the admin area.

In the admin preview, the placeholders (e.g., SYN_User) are displayed unchanged because no specific recipient is assigned at this point.

The resolution of the placeholders only occurs in the customer account once the contract is assigned to a shop customer. The plugin automatically retrieves the required data from the corresponding customer and address fields and correctly replaces the placeholders there.


4.3 Revisionen

Displayed when you have enabled Revisions under 3.2. Create New Contract > Settings. When enabled, after creating the contract, you must initially click the button “Create New Revisions Now” (9) to publish the contract and make it visible in the customer account.

Changes to contract contents are made via revisions (8).

  • Enter the changes as bullet points in the revision field.
    This information will be displayed in the customer account.

  • The revision is published via "Create new revision now" (9).

  • !After publication, a revision can no longer be changed or deleted.!

In the revision overview (10) you can see all versions and access them as PDFs.

Vertragsmanagement_allgemeine Vertragsinfos_3.png

4.4 Special Customer Assignment

Displayed when you have enabled “Special Customer Assignments” under 3.2. Create New Contract > Settings.

In the customer overview, select which specific customer the contract should be displayed to.

  • Customers can be activated via checkboxes.

  • Columns can be shown or hidden through list settings.

  • Filters enable targeted searches for customers (e.g., customer number, name, company).

  • Save your selection to apply the assignment.

Vertragsmanagement_Spezielle Kundenzurodnung.png

4.5 PDF Settings

General PDF Settings

  • PDF Name

  • Business logo (will be displayed in the PDF)

  • Filename prefix (Optional text that is prepended to the PDF filename.)

  • Filename suffix (Optional text that is appended at the end of the filename.)

Layout

  • Page orientation: Portrait

  • Page size: A4

  • File format: PDF

  • Display document title in the PDF (This is the contract title you assigned under 4.1.)

  • Header / Footer (optional)

  • Page numbering (optional)

Business data in the PDF

The following information appears in the header or footer of the PDFs:

Street, ZIP code, city, country, business name, email, phone, website, tax number, tax office, VAT ID, bank, IBAN, BIC, managing director

The PDF preview allows the contract to be reviewed at any time.

 

Vertragsmanagement_PDF_Einstellung_neu.jpg

5. Contract with System Users (Internal Contracts)

With the Contract Management plugin, in addition to contracts for shop customers, contracts with system users (internal contracts) can also be managed. This function is intended, for example, for employee contracts, internal agreements, or policies.
Contracts with system users are displayed exclusively in the admin area and in the dashboard of the assigned employees – not in the customer account.


5.1 Create Contract with System Users

When creating a new contract, the option "Contract with System User" can be selected.

If this option is active:

  • the contract is treated as an internal contract

  • does not appear in the shop frontend for customers

  • can be specifically assigned to employees (admin users)
    After saving, the "Employees" tab is additionally available.

Vertragsmanagement_interner Vertrag_allgemein.png
  1. Title of the Contract

  2. Activation of the Contract

  3. Internal Notes

  4. Contract Text

  5. 5. Saving the Settings


5.2 Assign Employees to a Contract

In the "Employees" tab, you specify which employees should receive this contract.
You can select one or multiple employees.

Vertragsmanagement_interner Vertrag_Mitarbeiter.jpg

 

Assigned employees see the contract in their dashboard after logging in.
The contract can be viewed there and downloaded as a PDF.

Vertragsmanagement_Dashboard_MA.png

5.3 Users & Permissions – Requirements

For employees to appear in contract management and be able to receive contracts, appropriate user and permission settings are required (Admin>Settings>Users & Permissions).
Requirements for employees:

  • The employee must be created as a user in the Shopware admin.

  • The user must not be an administrator.

  • The user must be assigned one of the roles provided by the plugin.

Vertragsmanagement_Benutzer_Management2.png

5.4 Roles for Contract Management

5.4.1 Roles

 

The plugin extends the basic information in user management (1) by two
special roles (2):
SynCmViewer

  • allowed to view contracts

  • suitable for employees who should only read or download contracts

SynCmEditor

  • allowed to view, create, and edit contracts

  • suitable for HR personnel or internal administrators

These roles can be assigned under Settings → Users & Rights → Users → Roles.


5.4.2 Additional Information

 

The plugin extends the basic information in user management (1) with additional fields in the section "Additional information for contract management" (3):

  • Street and house number

  • Postal code

  • City

 

This information is used when the placeholder SYN_User is inserted in the contract.
The data is then automatically transferred into the contract, e.g., for address information in employee contracts.

Vertragsmanagement_interner Vertrag_MA anlegen.png

 


6. Accepted Contracts

Under Content → Accepted Contracts you can see all contracts accepted by customers.

The list settings allow you to display, among others, the following columns:

  • Company

  • Customer Number

  • First and Last Name

  • Contract / Revision


7.Display in Frontend (Customer Account)

7.1 Contract Overview

In the customer account, the menu item “Contracts” is available.
Here, all contracts assigned to the customer are displayed, including:

  • Contract title

  • current revision

  • status (accepted / not accepted)

  • time of last view

Contracts can be viewed or downloaded as PDFs at any time.


 

7.2 Accept Contract

If acceptance is required, the customer must actively confirm the contract.

By clicking "Accept" the customer bindingly confirms the contract terms.
The contract is then marked as accepted.

Kundenkonto_Vertrag akzeptieren.jpg

7.3 Notice for New or Changed Contracts

When a new revision is published, the customer receives a clear notice in the customer account.

  • Changed contracts are marked

  • As long as the new revision has not been accepted, the contract is considered unconfirmed

  • Changes compared to the previous version are displayed

This ensures transparency and traceability in contract changes.


8. FAQ

8.1 Why can't certain contract settings be changed afterwards?

Settings made when creating a contract (e.g., contract with shop customers, acceptance required, enable revisions, special customer assignment) are set during contract creation and cannot be changed afterwards. This ensures that contract processes remain consistent, traceable, and legally secure. If a different configuration is needed, a new contract must be created.

8.2 Why is a contract not yet displayed in the customer account?

A contract is only displayed in the customer account if it is active and – for customer contracts with revisions – has at least one published revision.
Please also check whether the contract concerns shop customers and, if applicable, whether customers have been correctly assigned.

8.3 Why must the first revision be published after creating a contract?

Only relevant if revisions have been enabled (see 3.2).

If the option “Enable revisions” was selected when creating a new contract, the contract is initially a draft. The contract becomes visible in the customer account only after publishing the first revision.

If revisions were not enabled, publishing a revision is not required.

8.4 Can published revisions be changed or deleted afterwards?

Only relevant if revisions have been enabled (see 3.2).

If revisions are active, published revisions cannot be changed or deleted.
This ensures traceability and legally secure documentation.

Changes to contract content are always made via a new revision.

8.5 Why are placeholders like SYN_User not displayed in the PDF preview?

In the PDF preview in the admin area, placeholders are not resolved because no specific recipient (customer or employee) is assigned yet.
Therefore, the preview deliberately shows the placeholders themselves. Placeholders are only replaced/visible in the customer account or employee dashboard once the contract is assigned to a specific person. The plugin automatically retrieves the data from the respective customer or user data fields and correctly inserts them into the contract.

8.6 Why does the message “Missing PDF settings” appear when creating a contract?

This message appears when required information for PDF creation is missing (e.g., PDF name or business data). This information is needed for the correct display of the contract PDF.

Solution:
Complete the missing fields in the PDF settings of the plugin and save the configuration.

8.7 Do I have to save the contract text separately for each language?

Yes. Even if the contract text is identical, it must be saved once for each language.
Only then does Shopware recognize the translation as complete and the message disappears.

8.8 What happens if a customer does not accept a contract?

As long as a contract or a new revision has not been accepted, the contract is considered not accepted. The customer is clearly informed of the change in the customer account and can view and accept the new version.

8.9 Can contracts be assigned only to specific customers?

Yes. Through special customer assignment, contracts can be specifically assigned to individual customers. Without this option, all shop customers receive the contract by default.