Eine der besten Eigenschaften bei Haufe X360 (ehemals lexbizz) ist die benutzerfreundliche API, mit der Sie eine Vielzahl weiterer Software-Lösungen wie beispielsweise HubSpot anbinden können. In diesem Beitrag zeigen wir Ihnen, wie Sie einen Webservice-Endpunkt erweitern und benutzerdefinierte Entitäten zu einem Objekt hinzufügen können.

Was ist eine API:

Die Abkürzung API steht für Application Programming Interface und bezeichnet eine Programmierschnittstelle. Neben dem Zugriff auf Datenbanken oder Hardware kann eine Programmierschnittstelle auch das Erstellen von Komponenten der grafischen Benutzeroberfläche ermöglichen oder vereinfachen. Heutzutage stellen viele Cloud-Dienstleister wie Haufe X360 Programmierschnittstellen zur Verfügung; diese heißen dann Webservice.

The Da Vinci CODE – So erweitern Sie Webservice-Endpunkte in der Haufe X360 API (ehemals lexbizz)

Um die Webservice-Endpunkte in Haufe X360 (ehemals lexbizz) zu erweitern, müssen Sie einige Schritte befolgen, die wir Ihnen im Folgenden zeigen. In einigen Fällen müssen dabei Berichtstransaktionen aus einem anderen System wie beispielsweise Barverkaufsbelege aus Lightspeed in Haufe X360 eingegeben werden, ohne sie neu zu berechnen. Wir möchten dabei Diskrepanzen bei den Dezimalwerten aufgrund von Neuberechnungen in einem anderen System vermeiden. Das Ziel ist es, die Steuersätze und steuerpflichtigen Beträge aus Lightspeed unverändert in Haufe X360 zu übernehmen. Das Ergebnis dieser Arbeit sehen Sie in der Abbildung unten, die folgenden Schritte führen Sie dorthin.

The Da Vinci CODE – So erweitern Sie Webservice-Endpunkte in der lexbizz API

Es gibt einen Abschnitt mit Steuerdetails im Barverkaufsdokument, der jedoch nicht über die API zugänglich ist.

Wenn Sie Haufe X360 2020R2 oder höher verwenden, müssen Sie den Standard-Endpunkt in Version 20.200.001 nehmen und ihn erweitern. Geben Sie dem Endpunkt einen Namen und eine Versionsnummer. In der Regel übernehmen wir hierfür die Versionsnummer des Endpunkts und erweitern diesen, wie Sie im Beispiel unten in Endpunktversion 20.200.001 sehen können.

The Da Vinci CODE – So erweitern Sie Webservice-Endpunkte in der lexbizz API

Aus Gründen der Konsistenz gleichen wir an dieser Stelle die Versionsnummer des Endpunkts mit derjenigen ab, die wir erweitern möchten:

Webservice-Endpunkte lexbizz

Nachdem wir den Endpunkt erweitert haben, gehen Sie auf die oberste Ebene des Objekts (Barverkäufe) und klicken auf EINFÜGEN. Sie sehen dann das folgende Eingabebild:

Nachdem wir den Endpunkt erweitert haben, gehen Sie auf die oberste Ebene des Objekts (Barverkäufe) und klicken auf EINFÜGEN. Sie sehen dann das folgende Eingabebild:

An dieser Stelle füllen wir die Informationen aus, die zur Erstellung eines Steuerdetailobjekts auf der Detailebene erforderlich sind:

Webservice-Endpunkte lexbizz

Von dort aus fügen wir die erforderlichen Felder zu dem neu definierten Detailobjekt hinzu, das bereits in Haufe X360 vorhanden ist.

Webservice-Endpunkte lexbizz

Um die erweiterte API zu testen, nutzen wir anschließend das Dienstprogramm Postman, das in der Integrationszertifizierung von Haufe X360 verwendet wird. Mit Postman können wir bestätigen, dass das TaxDetails-Objekt wie erwartet funktioniert.

Webservice-Endpunkte lexbizz

Und hier ist der Code, auf den Sie in Github zugreifen können, alternativ finden Sie ihn auch in GIST.

"TaxDetails": [
            {
                "id": "bc0fc7b0-ce58-47eb-a1cf-dba9eee671aa",
                "rowNumber": 1,
                "note": null,
                "TaxableAmount": {
                    "value": 0.0000
                },
                "TaxAmount": {
                    "value": 0.0000
                },
                "TaxID": {
                    "value": "BCPSTAR"
                },
                "TaxRate": {
                    "value": 7.000000
                },
                "custom": {}
            },
            {
                "id": "1232325c-45d0-48ed-8a9f-8c32fffe0a69",
                "rowNumber": 2,
                "note": null,
                "TaxableAmount": {
                    "value": 0.0000
                },
                "TaxAmount": {
                    "value": 0.0000
                },
                "TaxID": {
                    "value": "EXEMPT"
                },
                "TaxRate": {
                    "value": 0.000000
                },
                "custom": {}
            },
            {
                "id": "812cb152-04ec-404d-ade1-665c95a4b032",
                "rowNumber": 3,
                "note": null,
                "TaxableAmount": {
                    "value": 4.6000
                },
                "TaxAmount": {
                    "value": 0.2300
                },
                "TaxID": {
                    "value": "GST"
                },
                "TaxRate": {
                    "value": 5.000000
                },
                "custom": {}
            }
        ]

Fazit

Wie Sie sehen können, ist dies ein ziemlich einfacher und unkomplizierter Prozess, der durch den Low-Code/No-Code-Ansatz der Haufe X360-Plattform für triviale Entwickleraufgaben, sehr effizient ist. All die Vorzüge einer robusten REST-API mit der Flexibilität, sie mit benutzerdefinierten Objekten zu erweitern und vorhandene Felder einzubinden.

Viel Spaß beim Coden!