Dokumentation

Inhalt

1. Voraussetzungen

Für die Verwendung des helloCash x WooCommerce Plugins müssen die folgenden Voraussetzungen erfüllt werden:

  • helloCash Account (HINWEIS: die erforderliche API-Schnittstelle ist erst ab dem “Premium”-Paket enthalten)
  • WordPress (ab der Version 6.4)
  • WooCommerce (ab der Version 8.4)
  • PHP (ab der Version 8.0)
  • Optional: Ist das Plugin Germanized oder German Market installiert, wird das UID-Feld im Checkout ebenfalls zur Rechnungslegung verwendet.
  • Andere Plugins (wie zum Beispiel Bundles oder dergleichen) werden aktuell nicht separat unterstüzt, bei Bedarf bieten wir aber gerne eine individuelle Lösung an (siehe dazu den Punkt 8. Änderungswünsche)

2. Lizenz

Um das helloCash x WooCommerce Plugin verwenden zu können, ist es erforderlich eine Lizenz online zu kaufen. Diese Lizenz kann in unserem Online-Shop erworben werden und ist für ein Jahr ab dem Kaufdatum gültig. Um die Lizenz einer Installation zuweisen zu können, muss beim Kauf im Online-Shop die Domain (Webadresse) eingegeben werden, bei der das Plugin in Zukunft arbeiten soll. Zusätzlich dazu kann auch eine “Staging”-Domain eingetragen werden. Diese ist ebenfalls gültig und kann dazu verwendet werden, um das Plugin in einer Testinstallation zu testen, bevor die Webseite live geschalten wird.

Rechtzeitig vor Ablauf der Gültigkeit wird automatisch eine E-Mail versendet mit der Möglichkeit die Lizenz um ein weiteres Jahr zu verlängern. Außerdem wird im WordPress Backend ein entsprechender Hinweis angezeigt. Wird die Lizenz über einen dieser Links verlängert, muss die Domain nicht erneut eingetragen werden und der Lizenzcode verändert sich nicht. Wird stattdessen eine neue Lizenz gekauft, ändert sich beim Kauf der Lizenzcode, welcher in diesem Fall dann auch in den Einstellungen des Plugins angepasst werden muss.

3. Installation

Die aktuellste Version des Plugins kann jeweils über diesen Link heruntergeladen werden. Das heruntergeladene Plugin (zip-Datei) muss dann im WordPress-Backend unter “Plugins” -> “Neues Plugin hinzufügen” -> “Plugin hochladen” installiert werden. Nach der Installation muss das Plugin über die entsprechende Schaltfläche im Bereich “Installierte Plugins” noch aktiviert werden.

4. Konfiguration

Nach der ersten Installation müssen einige Einstellungen des Plugins geändert bzw. ausgefüllt werden, damit es korrekt funktionieren kann. Dies erfolgt im Bereich “WooCommerce” -> “Einstellungen” -> “helloCash”.

Zunächst muss hier der per E-Mail empfangene Lizenzcode eingegeben werden. Nach einem Klick auf “Änderungen Speichern” wird der Code validiert und schaltet die weiteren Einstellungsmöglichkeiten frei.

Als nächstes muss der helloCash API Token eingetragen werden. Durch diesen Token wird das Plugin berechtigt, auf das helloCash Konto zuzugreifen. Dieser Token kann in der helloCash Oberfläche unter “Kassensystem” -> “Einstellungen” -> “Allgemein” -> “helloCash API” generiert werden. Nach dem Einfügen dieses Tokens in die Plugin-Einstellungen muss dieser ebenfalls über die Schaltfläche “Änderungen speichern” übernommen werden.

5. Einstellungen

Nach der initalen Konfiguration können noch weitere Einstellungen betreffend der Funktionsweise des Plugins getroffen werden. Im Folgenden werden alle möglichen Einstellungen aufgelistet und erklärt:

  • helloCash Mitarbeiter: Mit dieser Einstellung kann definiert werden, mit welchem Mitarbeiter die Rechnungen in helloCash angelegt werden sollen. Im Dropdown erscheinen dazu alle bereits erstellten Mitarbeiter von helloCash auf.
  • helloCash Testmodus: Im Testmodus werden Rechnungen im “Testmodus” angelegt, sie erscheinen nur dann auch in helloCash, wenn sich der helloCash Account im Testmodus befindet (Diese Einstellung kann in den helloCash Einstellungen unter “Registrierkasse” -> “Einstellungen” -> “Allgemein” -> “Allgemein” aktiviert werden).
  • Rechnungserstellung im Status abgeschlossen: Standardmäßig wird die helloCash Rechnung erstellt, sobald eine neue Bestellung im WooCommerce Webshop den Status “In Bearbeitung” erreicht. Alternativ kann durch Aktivieren dieser Einstellung die Rechnung erst erstellt werden, wenn die Bestellung den Status “Abgeschlossen” erreicht. (HINWEIS: Wurde bei den E-Mail-Einstellungen von WooCommerce aktiviert, das helloCash-Rechnungs-PDF als Anhang mitzusenden, kann es passieren, dass die Rechnung auch schon vor dem Status “Abgeschlossen” angelegt wird, um sie an das jeweilige E-Mail anhängen zu können).
  • Region: Mit der Auswahl der Region wird unter anderem die Sprache der Rechnung eingestellt, sowie weitere regionale Anpassungen durchgeführt (wie zum Beispiel das Datums- oder Zahlenformat).
  • Storno-Erstellung deaktivieren: Im Normalfall wird bei der Änderung des Status einer WooCommerce-Bestellung auf “Rückerstattet” automatisch eine eventuell bereits erstellte helloCash Rechnung storniert. Mit dem Aktivieren dieser Option kann dies deaktiviert werden – Stornierungen der helloCash Rechnungen müssen dann manuell in der helloCash Oberfläche erfolgen.
  • Zahlungsmethoden: Um auf der helloCash-Rechnung jeweils die richtige Zahlungsmethode der WooCommerce-Bestellung anzeigen zu können, müssen die einzelnen Zahlungsmethoden zunächst in der helloCash Oberfläche unter “Registrierkasse” -> “Einstellungen” -> “Allgemein” -> “Zahlungsarten” angelegt werden. Danach kann zu jeder WooCommerce Zahlungsmethode die entsprechende helloCash Zahlungsart im Dropdown ausgewählt werden.
  • Lagerstand synchronisieren: Wird diese Option aktiviert, wird der Lagerstand von verknüpften Artikeln automatisch synchronisiert. Bestandsführendes System ist in diesem Fall helloCash, d. h. der WooCommerce Lagerstand wird immer so angepasst, dass er dem helloCash Lagerstand entspricht. Wichtig hierfür ist auch, dass bei den verknüpften Artikeln die WooCommerce Option “Lagerstand verwalten” aktiviert ist. Die Synchronisierung erfolgt durch einen WordPress Cron Job ca. im 15-Minuten-Takt.
  • Preis synchronisieren: Mit der Aktivierung dieser Option wird der Preis von Verknüpften Artikeln automatisch von helloCash nach WooCommerce synchronisiert. Die Synchronisierung erfolgt durch einen WordPress Cron Job ca. im 15-Minuten-Takt.

Zusätzlich zu diesen Einstellungen kann bei den E-Mail Einstellungen von WooCommerce (zu finden unter “WooCommerce” -> “Einstellungen” -> “E-Mails”) für die E-Mails “Bestellung in Bearbeitung” sowie “Bestellung abgeschlossen” die Option “helloCash-Rechnungs-PDF anhängen” aktiviert werden. In diesem Fall wird an die jeweilige E-Mail an den Kunden das helloCash PDF der Rechnung angehängt.

6. Produkte verknüpfen

Damit der Lagerstand und die Preise zwischen helloCash und WooCommerce synchronisiert werden können, müssen die WooCommerce Produkte einem helloCash Artikel zugewiesen werden. Sollen nur die Rechnungen in helloCash erstellt werden, ist eine Verknüpfung der Artikeln nicht notwendig.

Die Verknüpfung kann auf zwei Arten erfolgen:

  1. Direkt beim WooCommerce Produkt. Dazu im WooCommerce Backend das enstprechende Produkt über den “Bearbeiten” Link öffnen. Danach kann bei den Produkteinstellungen unter “Allgemein” nach dem helloCash Artikel gesucht werden und dieser ausgewählt werden. Über die Schaltfläche “Aktualisieren” wird diese Verknüpfung dann für die Zukunft gespeichert. Bei Produkten mit mehreren Varianten befindet sich für jede Variation ein entsprechendes Einstellungsfeld im Reiter “Varianten”.
  2. Unter “WooCommerce” -> “helloCash” findet sich eine tabellarische Übersicht über alle in WooCommerce angelegten Produkte (inkl. ihrer Variationen). In dieser Tabelle kann ebenfalls über das Dropdown der entsprechende helloCash Artikel ausgewählt werden und im Anschluss über die Schaltfläche “Zuweisung speichern” gespeichert werden.

7. Funktionsweise des Plugins

Das Plugin gliedert sich im Wesentlichen in zwei Teilbereiche.

Der erste Teilbereich ist das Erstellen von helloCash-Rechnungen nachdem WooCommerce Bestellungen den entsprechenden Status erreicht haben. Dafür werden die gesamten Rechnungsdaten (Kunden, Artikel, Preise, etc.) an helloCash übertragen. Wurden die gekauften Produkte auch verknüpft, wird auch der Lagerstand in helloCash automatisch angepasst. Sofern aktiviert, werden rückerstattete WooCommerce Bestellungen ebenfalls an helloCash übertragen und die enstsprechende Rechnung storniert. Falls gewünscht, wird das PDF der Rechnung auch automatisch an den Kunden per E-Mail übermittelt.

Der zweite Teilbereich ist die Synchronisierung von Lagerständen sowie Preisinformationen von helloCash in den WooCommerce Webshop. Dazu müssen zuvor die WooCommerce Produkte mit ihren helloCash Artikeln verknüpft werden. Dann werden im 15-Minuten-Takt Lagerstände sowie Preise synchronisiert.

8. Hilfe / Änderungswünsche

Sollten bei der Verwendung des Plugins Fragen oder Fehler auftreten stehen wir gerne zur Seite. Um unseren Support-Prozess möglichst einfach und effizient gestalten zu können, bitten wir dabei um eine E-Mail an office@elephants5.com. Bei Problemen mit dem Plugin bitten wir außerdem darum die Debug-Nachrichten (zu finden in WordPress unter “WooCommerce” -> “Einstellungen” -> “helloCash” am Seitenende) herunterzuladen und als Anhang mitzusenden.

Sollte das Plugin noch nicht den Wünschen oder Anforderungen entsprechen, freuen wir uns ebenso über eine entsprechende Anfrage. Gerne können wir auch individuelle Lösungen (zum Beispiel Anpassungen an Drittanbieter-Plugins) anbieten.