Docs  /  App  /  NAVAX Wiederkehrende Verträge Interface  /  Arbeiten mit der App

 Endpunkt Definition

2026/04/13 • 3 Min. Lesedauer

In diesem Thema

• Voraussetzungen
• Basis-URL
• Endpunkte
• CallWebservice
• ReadMe
• Fehlerbehandlung
• Weitere Informationen

Der NAVAX Recurring Contracts Interface Webservice stellt zwei Endpunkte zur Verfügung, über die externe Systeme Vertragsoperationen in Business Central ausführen und die verfügbaren Operationen abfragen können.

Voraussetzungen

Die Codeunit NVXRCIInterfaceMgt muss als Webdienst in Business Central veröffentlicht sein. Detaillierte Einrichtungsschritte sind in der Hilfeseite Einrichtung beschrieben.

Basis-URL

https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{Enviroment}}/ODataV4/InterfaceMgt_{{Endpoint}}?company={{CompanyName}}

Folgende Platzhalter müssen ersetzt werden:

• {{TenantID}} – Die Tenant-ID der BC-Umgebung
• {{Environment}} – Der Name der Business Central Umgebung (z. B. Production)
• {{CompanyName}} – Der Name des Business Central Mandanten (aus Mandanten)
• {{Endpoint}} – Der Name des Endpunkts, entweder CallWebservice oder readMe

Endpunkte

CallWebservice

Führt eine Vertragsoperation aus. Der Aufrufer übergibt den Operationsnamen und einen JSON-Payload mit den erforderlichen Feldern. Parameter: Rückgabewert: Bestätigungstext, z. B. „Operation CreateContract has been executed successfully." Beispiel-Aufruf (Body):

{
    "operation": "CreateContract",
    "payload":'{
        "Description": "Interface Contract",
        "Starting Date": "2026-01-01",
        "Ending Date": "2026-12-31",
        "Source Type": "Customer",
        "Source No.": "10000",
        "Billing Type": "1M",
        "Day of Period Start": "1"
    }'
}

Eine vollständige Liste aller verfügbaren Operationen und ihrer Pflichtfelder ist in der Hilfeseite Verfügbare Operationen beschrieben.

ReadMe

Gibt ein JSON-Array zurück, das alle verfügbaren Operationen mit ihren jeweiligen Pflichtfeldern beschreibt. Dieser Endpunkt eignet sich ideal zur Dokumentation und zur automatischen Erkennung der unterstützten Operationen durch externe Systeme. Parameter: Keine Rückgabewert: JSON-Array mit einem Objekt je Operation. Jedes Objekt enthält den Operationsnamen als Schlüssel und ein JSON-Objekt mit den Pflichtfeldern (mit leerem Wert als Platzhalter) als Wert. Beispiel-Antwort:

[{
        "CreateContract": {
            "Description": "Required",
            "Starting Date": "Required",
            "Ending Date": "Required",
            "Source Type": "Required",
            "Source No.": "Required",
            "Billing Type": "Required",
            "Day of Period Start": "Required"
        }
    }, {
        "CreateContractLine": {
            "Contract No.": "Required",
            "Bundle Type": "Required",
            "Type": "Required",
            "No.": "Required",
            "Quantity": "Required",
            "Unit Price": "Required"
        }
    }, {
        "ScheduledPriceQtyChange": {
            "Contract No.": "Required",
            "Contract Line No.": "Required",
            "New Price": "Required",
            "New Quantity": "Required",
            "Date For Change": "Required",
            "Posting Date": "Required",
            "Combine Periods": "Required"
        }
    }, {
        "CancelContract": {
            "Contract No.": "Required",
            "Cancel Reason": "Required",
            "Cancellation Received At": "Required",
            "Cancellation Date": "Required"
        }
    }, {
        "CancelContractLine": {
            "Contract No.": "Required",
            "Contract Line No.": "Required",
            "Cancel Reason": "Required",
            "Cancellation Received At": "Required",
            "Cancellation Date": "Required"
        }
    }, {
        "UpdateCustomer": {
            "Customer No.": "Required"
        }
    }, {
        "ExtendContractLine": {
            "Contract No.": "Required",
            "Contract Line No.": "Required"
        }
    }, {
        "IndexingContractLine": {
            "Contract No.": "Required",
            "Contract Line No.": "Required",
            "Document Date": "Required",
            "Posting Date": "Required",
            "Combine Periods": "Required"
        }
    }
]

Fehlerbehandlung

Wenn ein unbekannter Operationsname übergeben wird, gibt CallWebservice einen SOAP-Fault mit der Meldung „No Operation found!" zurück. Fehlen im Payload Pflichtfelder, wird ebenfalls ein Fehler zurückgegeben. Mit dem ReadMe-Endpunkt können die Pflichtfelder vorab abgefragt werden.

Weitere Informationen

• Arbeiten mit der App, Verfügbare Operationen
  Dieser Abschnitt beschreibt alle verfügbaren Operationen des NAVAX Recurring Contracts Interface Webservice...