WebAuftrag API#

Mit der WebAuftrag API besteht die Möglichkeit, Daten aus verschiedenen Quellen (beispielsweise aus der tillhub-Kassenlösung) an KUMAVISION healthcare365 zu übertragen und dort weiterzuverarbeiten.

Über die WebAuftrag API können Kopf- und Zeileninformationen zu Kassenaufträgen als JSON-Struktur übermittelt werden. Die an die API gesendeten Daten werden in KUMAVISION healthcare365 als Web-Aufträge gespeichert und können über die eBox angezeigt, bearbeitet und weiterverarbeitet werden.

Einrichtung#

API Partner Übersicht#

Über die "API Partner Übersicht" können Sie einen API-Kommunikationspartner einrichten. Hierzu rufen Sie zunächst die Seite über die Anwendersuche auf. Über "Neu" im Menüband können Sie mit Hilfe der u.a. Tabelle einen Kommunikationspartner definieren.

Zahlungsform Mapping#

Über das Menüband steht Ihnen die Seite "WebAuftrag Zahlungsform Mapping" zur Verfügung. Dort können Sie für jeden API-Partner ein Mapping der Zahlungsformen festlegen. Dieses Mapping wird verwendet, wenn der WebAuftrag in die Schnellerfassung übernommen wird.

Definition WebAuftrag API#

Nachfolgend werden Ihnen die Felder der WebAuftrag API und ihre Definition näher erläutert:

Zeilen#

JSON Struktur#

Nachfolgend wird Ihnen ein Beispiel einer JSON Struktur für die Übermittlung von WebAufträgen an KUMAVISION healthcare365 aufgezeigt:

{
    "partnerID": "TILLHUB",
    "insurantCustomerNo": "10001733",
    "transactionID": "extCJo332267",
    "webshopOrderId": "MixWO4715",
    "orderDate": "2024-02-19",
    "processDate": "2024-02-19",
    "requestedDeliveryDate": "2024-02-25",
    "webOrderLines": [
        {
            "lineType": "item",
            "no": "3230025", 
            "quantity": 1,
            "unitOfMeasureCode": "STÜCK",
            "unitPrice": 1234.56,
            "priceInclVAT": false,
            "lineAmount": 1234.56,
            "directSaleWithoutProcess": true
        },
        {
            "itemInfoType": "Appliance No.",
            "itemInfoNo": "0336071003",
            "quantity": 2,
            "unitOfMeasureCode": "STÜCK",
            "unitPrice": 45.78,
            "priceInclVAT": false,
            "lineAmount": 91.56,
            "directSaleWithoutProcess": true
        },  
                {
            "lineType": "item",
            "no": "ART0000070", 
            "quantity": 1,
            "unitOfMeasureCode": "STÜCK",
            "directSaleWithoutProcess": false,
            "coPayment": 5,
            "requestedDeliveryDateOnce": "2024-02-28"
        },
        {
            "lineType": "item",
            "no": "ART0000071", 
            "quantity": 2,
            "unitOfMeasureCode": "STÜCK",
            "directSaleWithoutProcess": false,
            "coPayment": 0,
            "personalShare": 10,
            "economicPersonalShare": 0,
            "processTypeCode": "H-STOMA",
            "processNo": "VG00000612",
            "processPeriodNo": 1,
            "contractNo": "VS0000000",
            "contractPeriod": "E1",
            "deliveryTypeNewProcess": "By Call",
            "requestedDeliveryDateOnce": "2024-02-28"
        }
    ]    
}

Prozess#

Die über die API übermittelten Daten werden auf der Seite "WebAufträge" angelegt und können über die eBox angezeigt, bearbeitet und weiterverarbeitet werden. Hierzu rufen Sie die eBox über die Anwendersuche auf.

In der eBox stehen Ihnen folgende Funktionen zur Verfügung:

Während der Weiterverarbeitung werden die Daten der WebAufträge an die Schnellerfassung (Marketing Cockpit > Vorgang > Schnellerfassung) übermittelt. Sobald ein WebAuftrag vollständig an die Schnellerfassung übertragen wurde, gilt er als abgeschlossen, wird archiviert (WebAufträge Archiv) und aus der eBox entfernt.

Aus der Schnellerfassung können Vorgänge und Handelsaufträge erstellt werden.

Durch eine Bounded-Action der API kann der Verkauf von Artikeln, die als "Direkt Verkauf" gekennzeichnet sind, automatisch angelegt werden. Falls ein WebAuftrag ausschließlich Zeilen mit der Markierung "Direkt Verkauf" enthält, kann dieser Auftrag vollständig bearbeitet und anschließend archiviert werden.

Aufruf: https://{servername}/BC/api/kumavision/kvsmed/v1.0/companies({companyid})/webOrders({weborderid}))/Microsoft.NAV.createDirectOrder