belegFuchs Logo
belegFuchs Redaktion
08.02.2024 - Zul. bearbeitet: 08.02.2024

Buchhaltungssoftware für Ihre Webseite: Eine belegFuchs PHP-Integration

Sie haben eine Webseite bspw. einen Online-Shop und möchten eine Buchhaltungssoftware mit automatischer Rechnungsstellung integrieren? Oder Sie möchten einfach Rechnungen in PHP erstellen und verwalten? Dann ist belegFuchs genau das Richtige für Sie. belegFuchs ist eine Buchhaltungssoftware, die für die Integration in andere Systeme optimiert wurde.

Einführung

In diesem Artikel bekommen Sie eine Schritt für Schritt Anleitung, wie Sie belegFuchs in Ihre PHP-Webseite integrieren können. Das einzige, was Sie benötigen, ist ein kostenloses belegFuchs Konto und ein wenig PHP-Kenntnisse.

Diese Anleitung ist absichtlich einfach gehalten, um Ihnen einen schnellen Einstieg zu ermöglichen. Sie können die Anleitung natürlich an Ihre Bedürfnisse anpassen und erweitern. Wenn Sie die Technische Dokumentation suchen, finden Sie diese in der belegFuchs API-Dokumentation.

Programmiersprache

Zur Demonstration verwenden wir in diesem Beispiel PHP. Sie können die Integration aber auch in einer anderen Programmiersprache umsetzen.

1. Die belegFuchs API

Um Ihre Webseite mit belegFuchs zu verbinden, benötigen Sie einen API-Schlüssel. Folgen Sie diesen Schritten, um einen zu generieren:

API-Schlüssel generieren

  1. Melden Sie sich in Ihrem belegFuchs Konto an.
  2. Wählen Sie im linken Menü „Einstellungen“ und navigieren Sie zum Reiter „API“.
  3. Erstellen Sie einen API-Key, indem Sie auf „API-Key erstellen“ klicken.

API-Key erstellen

Mit Ihrem API-Schlüssel können Sie die belegFuchs API nutzen, um Ihre Webseite zu integrieren.

2. Kunden anlegen

Bevor Sie Rechnungen erstellen, ist das Anlegen eines Kunden in belegFuchs erforderlich. Es ist sinnvoll, Ihre Webseite-Kunden mit belegFuchs zu synchronisieren, indem Sie bei jeder Neuregistrierung einen entsprechenden Kunden in belegFuchs anlegen. Folgende Kundendaten sollten übertragen werden: Vor- und Nachname, vollständige Adresse, eine eindeutige Kundennummer, das Geschlecht und die Länderkennung.

Kunden über die API anlegen

Verwenden Sie den API-Schlüssel, um Kunden in belegFuchs über eine API-Anfrage anzulegen. Hier ist ein Beispielcode, der die PHP-Bibliothek Guzzle nutzt, aber Sie können auch jede andere Bibliothek oder cURL verwenden:

<?php

// ... Ihre Registrations-Logik

// Nachdem der Kunde sich auf Ihrer Webseite registriert hat, legen Sie den Kunden in belegFuchs an.

// Für die eindeutige Kundennummer können Sie bspw. die Kundennummer aus Ihrer Datenbank verwenden.
$customId = "Eine eindeutige Kundennummer";

$api_key = "Ihr API-Schlüssel";
$api_url = "https://api.belegfuchs.de/v1/contacts";

$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'api-key' => $api_key
];
$body = '{
  "number": "auto",
  "customId": "' . $customId . '",
  "contactType": "Customer",
  "isbusiness": 0,
  "firstname": "Anna",
  "lastname": "Müller",
  "gender": 0,
  "countryCode": "de",
  "postalCode": "53757",
  "city": "Sankt Augustin",
  "street": "Musterstraße",
  "houseNumber": "12a"
}';
$request = new Request('POST', $api_url, $headers, $body);
$res = $client->sendAsync($request)->wait();

// Wenn die Anfrage erfolgreich war, erhalten Sie den Kontakt als Antwort.
// Wir empfehlen Ihnen, die Kontakt-`id` in Ihrer Datenbank zu speichern, um den Kontakt identifizieren zu können.
// Denn nur mithilfe der Kontakt-`id` können Sie später Rechnungen für den Kunden erstellen.

Weitere Informationen über die Erstellung und Verwaltung von Kunden/Kontakten finden Sie in der belegFuchs API-Dokumentation.

3. Rechnung erstellen

Nachdem der Kunde angelegt wurde, können Sie für diesen Kunden Rechnungen erstellen. Benötigt wird die Kontakt-id des Kunden.

Rechnung über die API erstellen

<?php

// ... Ihre Bestelllogik

$contactId = 0; // Die Kontakt-`id` des Kunden, den Sie zuvor angelegt haben
$api_key = "Ihr API-Schlüssel";
$api_url = "https://api.belegfuchs.de/v1/invoices";

// Das Datum muss im Format "YYYY-MM-DDTHH:MM:SS.000Z" sein.
// Die Zeitangabe ist immer 00:00:00.000Z.
$date = (new DateTime('now'))->setTime(0, 0)->format('Y-m-d\TH:i:s') . '.000Z';

$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'api-key' => $api_key
];
$body = '{
    "numberPrefix": "RE-",
    "number": "auto",
    "contactId": ' . $contactId . ',
    "headText": "Vielen Dank für Ihren Einkauf!",
    "footerText": "Wir freuen uns auf Ihren nächsten Besuch.",
    "vatType": 0,
    "invoiceDate": "' . $date . '",
    "serviceDate": "' . $date . '",
    "positions": [
        {
            "description": "Testprodukt",
            "amount": 1,
            "itemPrice": 99.99,
            "tax": 19,
            "discount": 7.5,
            "unit": 1
        }
    ]
}';
$request = new Request('POST', $api_url, $headers, $body);
$res = $client->sendAsync($request)->wait();

// Wenn die Anfrage erfolgreich war, erhalten Sie die Rechnung als Antwort.
alert circle icon

Beachten Sie, dass der itemPrice der Nettopreis ist. Der Bruttopreis wird automatisch berechnet. Der Rabatt wird als Prozentsatz angegeben.

Rechnung als PDF herunterladen

Um die Rechnung Ihrem Kunden z.B. per E-Mail zuzusenden, können Sie die Rechnung als PDF herunterladen.

annotation info icon

Wir empfehlen Ihnen, die Rechnung außerhalb der Bestelllogik herunterzuladen, um sicherzustellen, dass die Bestelllogik nicht durch eine langsame API-Anfrage verzögert wird. Sie können die Rechnung aber auch im oben gezeigten Schritt herunterladen und Ihrem Kunden sofort zusenden.

<?php

$invoiceId = 0; // Die `id` der Rechnung, die Sie zuvor erstellt haben
$api_key = "Ihr API-Schlüssel";
$api_url = "https://api.belegfuchs.de/v1/invoices/" . $invoiceId . "/pdf/download";

$client = new Client();
$headers = [
  'api-key' => $api_key
];
$request = new Request('GET', $api_url, $headers);
$res = $client->sendAsync($request)->wait();

// Wenn die Anfrage erfolgreich war, erhalten Sie die Rechnung als PDF.

Weitere Informationen über die Erstellung und Verwaltung von Rechnungen finden Sie in der belegFuchs API-Dokumentation.

Fazit

Diese Anleitung zeigt die Grundlagen, wie Sie belegFuchs zur Rechnungserstellung auf Ihrer PHP-Webseite nutzen können. Die Vorgehensweise lässt sich an Ihre spezifischen Anforderungen anpassen. belegFuchs bietet darüber hinaus vielfältige Funktionen zur Verwaltung von Kunden, Produkten und Angeboten, die alle über die API zugänglich sind und im belegFuchs Konto verwaltet werden können.