Handbuch als PDF speichern oder drucken  


NAVAX Wiederkehrende Verträge Interface


API Funktionen für NAVAX Wiederkehrende Verträge.

Aktuelle Version: 27.1.0.1 ab Business Central 27.
AppSource-Name: NAVAX Recurring Contracts Interface

Handbuch


Erstellungsdatum: 2026/05/22
Die aktuelle Version dieses Handbuchs finden Sie unter:

https://www.navax.app/help.php?AppID=NCRCI&L=de


☰ Inhaltsverzeichnis



Allgemein

  • NAVAX Wiederkehrende Verträge Interface
    NAVAX Wiederkehrende Verträge Interface erweitert Microsoft Dynamics 365 Business Central und bietet die Möglichkeit, NAVAX Wiederkehrende Verträge automatisiert via API Endpunkte zu verwalten...

Einrichtung

  • Wiederkehrende Verträge Interface Einrichtung
    Zur Einrichtung der NAVAX Wiederkehrende Verträge Interface sind zwei Schritte erforderlich...

Arbeiten mit der App

  • Endpunkt Definition
    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...
  • Verfügbare Operationen
    Dieser Abschnitt beschreibt alle verfügbaren Operationen des NAVAX Recurring Contracts Interface Webservice...

Anhang

  • NAVAX Lizenzverwaltung
    Die Seite NAVAX Lizenzverwaltung (in älteren Versionen NAVAX Lizenzübersicht oder NCEX Lizenzübersicht) zeigt den aktuellen Lizenzstatus der NAVAX-Erweiterungen an...
  • Installationshinweise
  • Versionshinweise

Docs  /  App  /  NAVAX Wiederkehrende Verträge Interface  /  Allgemein
 NAVAX Wiederkehrende Verträge Interface

NAVAX Wiederkehrende Verträge Interface erweitert Microsoft Dynamics 365 Business Central und bietet die Möglichkeit, NAVAX Wiederkehrende Verträge automatisiert via API Endpunkte zu verwalten.

Navigation

Felder, Aktionen, Seiten und Berichte, die aus der Erweiterung NAVAX Wiederkehrende Verträge Interface stammen, sind durch das Kürzel NCRCI gekennzeichnet. Durch diese zusätzliche Kennzeichnung können sie eindeutig von anderen Erweiterungen (die ähnliche Namen und Bezeichnungen verwenden können) unterschieden werden. Die Suchbegriffe "nvxrci", "ncrci" und "navax" werden auch von "Wie möchten Sie weiter verfahren" erkannt. Dadurch kann sehr schnell auf die einzelnen Bereiche der NAVAX Wiederkehrende Verträge Interface zugegriffen werden.

Hinweis

NAVAX Wiederkehrende Verträge Interface wurde mit dem Präfix NCRCI bzw. NVXRCI entwickelt. NCRCI bzw. NVXRCI steht für NAVAX Consulting bzw. NAVAX Recurring Contracts Interface.

Berechtigungssätze

Für NAVAX Wiederkehrende Verträge Interface stehen folgende Berechtigungssätze zur Verfügung:
NameBeschreibung
NVXRCINAVAX Wiederk. Ver. Interface Diese Berechtigungen benötigen Sie, um NAVAX Wiederkehrende Verträge Interface zu benutzen.
NVXRCI, SETUPNAVAX Wiederk. Ver. Int. einr. Diese Berechtigungen benötigen Sie, um NAVAX Wiederkehrende Verträge Interface einzurichten. Weitere Informationen dazu finden Sie unter Einrichtung, Wiederkehrende Verträge Interface Einrichtung.

Installationshinweise

Weitere Informationen dazu finden Sie unter Anhang, Installationshinweise.

Docs  /  App  /  NAVAX Wiederkehrende Verträge Interface  /  Einrichtung
 Wiederkehrende Verträge Interface Einrichtung

Zur Einrichtung der NAVAX Wiederkehrende Verträge Interface sind zwei Schritte erforderlich. Bevor die Konfigurationen in Business Central vorgenommen werden können, müssen zunächst in Azure die notwendigen Einstellungen erfolgen, um die Kommunikation per Webservice mit Business Central zu ermöglichen. Alle relevanten Business Central Einrichtungen können direkt über die Seite NAVAX Wiederkehrende Verträge Interface Einrichtung vorgenommen werden.

Allgemein, Felder

API-Zugriff deaktivierenGibt an, ob der API-Zugriff deaktiviert werden soll.

Einrichtung in Azure

Microsoft Entra Application

Um Anfragen an Business Central über die API zu stellen, wird eine weitere Entra-Anwendung benötigt, die über alle Berechtigungen für die API-Automatisierung verfügt.
  1. Entra-Anwendung in Azure erstellen
  2. Nachdem die Entra-Anwendung in Azure erstellt wurde, ist es auch notwendig, die Entra-Anwendung in Business Central zu erstellen. (wird ebenfalls im Link beschrieben)
  3. Wichtig: Für NAVAX Wiederkehrende Verträge Interface ist es wichtig, das Berechtigungsset NVXRCI, NVXRC sowie D365 READ hinzuzufügen.

API-Funktion Codeunit zu Web Services hinzufügen

Um den API-Endpunkt der API-Automatisierung zu veröffentlichen, muss die NVXRCIInterfaceMgt Codeunit zu den Webdiensten hinzugefügt werden.
  1. Gehe zur Seite Web Services
  2. Klicke auf + Neu
  3. Verwende die folgenden Einstellungen:
    • Objekttyp: Codeunit
    • Objekt-ID: 70161950
    • Service Name: NVXRCIInterfaceMgt
  4. Der Endpunkt wird veröffentlicht, indem das Flag Veröffentlicht aktiviert wird.
  5. Der neu erstellte Webservice sollte wie folgt aussehen:

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

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:
ParameterTypBeschreibung
OperationTextName der auszuführenden Operation (z. B. CreateContract)
PayloadText (JSON)JSON-Objekt mit den für die Operation erforderlichen Feldern, als Text.
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.

Docs  /  App  /  NAVAX Wiederkehrende Verträge Interface  /  Arbeiten mit der App
 Verfügbare Operationen

Dieser Abschnitt beschreibt alle verfügbaren Operationen des NAVAX Recurring Contracts Interface Webservice. Jede Operation wird über den Endpunkt CallWebservice aufgerufen, indem der Operationsname im Parameter Operation und die erforderlichen Felder als JSON-Objekt im Parameter Payload übergeben werden. Die Pflichtfelder jeder Operation können auch zur Laufzeit über den Endpunkt ReadMe abgefragt werden.

CreateContract

Erstellt einen neuen Vertragskopf in Business Central. Pflichtfelder:
FeldBeschreibung
DescriptionBezeichnung des Vertrags
Starting DateStartdatum des Vertrags (Format: YYYY-MM-DD)
Ending DateEnddatum des Vertrags (Format: YYYY-MM-DD)
Source TypeQuelltyp, z. B. Customer
Source No.Nummer des Quell-Datensatzes (z. B. Kundennummer)
Billing TypeAbrechnungsart des Vertrags
Day of Period StartTag, an dem die Abrechnungsperiode beginnt

Tipp

Es können beliebig weitere Felder des Vertragskopfes im Payload übergeben werden.
Beispiel-Payload:
{
    "Description": "Wartungsvertrag 2026",
    "Starting Date": "2026-01-01",
    "Ending Date": "2026-12-31",
    "Source Type": "Customer",
    "Source No.": "10000",
    "Billing Type": "Monthly",
    "Day of Period Start": "1"
}

CreateContractLine

Fügt eine neue Vertragszeile zu einem bestehenden Vertrag hinzu. Pflichtfelder:
FeldBeschreibung
Contract No.Nummer des übergeordneten Vertrags
Bundle TypeBundletype der Vertragszeile
TypeTyp der Zeile (z. B. Item, G/L Account)
No.Nummer des Artikels oder Sachkontos
QuantityMenge
Unit PriceStückpreis

Tipp

Es können beliebig weitere Felder der Vertragszeile im Payload übergeben werden.
Beispiel-Payload:
{
    "Contract No.": "KONT-00001",
    "Bundle Type": " ",
    "Type": "Item",
    "No.": "1000",
    "Quantity": "2",
    "Unit Price": "49"
}

CreateContractLine - Bundles

Um Bundles anzulegen, kann die Operation CreateContractLine verwendet werden. Zuerst muss der Bundle-Kopf angelegt werden, indem das Feld Bundle Type mit Bundle befüllt wird und der Type mit einem Leerzeichen befüllt wird ( ). Für die Komponenten des Bundles muss dann erneut die Operation CreateContractLine aufgerufen werden, wobei das Feld Bundle Type mit Component befüllt wird und zusätzlich im Feld Assigned To Bundle die Zeilennummer der Bundle-Kopfzeile übergeben wird (Diese kann aus dem Response entnommen werden).

ScheduledPriceQtyChange

Plant eine Preis- oder Mengenänderung für eine bestehende Vertragszeile zu einem definierten Datum. Pflichtfelder:
FeldBeschreibung
Contract No.Nummer des Vertrags
Contract Line No.Zeilennummer der Vertragszeile
New PriceNeuer Preis (leer lassen, falls unverändert)
New QuantityNeue Menge (leer lassen, falls unverändert)
Date For ChangeDatum, ab dem die Änderung wirksam wird (Format: YYYY-MM-DD)
Posting DateBuchungsdatum für Korrekturdokumente (Format: YYYY-MM-DD)
Combine PeriodsPerioden zusammenfassen: true oder false
Beispiel-Payload:
{
    "Contract No.": "KONT-00001",
    "Contract Line No.": "10000",
    "New Price": "59",
    "New Quantity": "",
    "Date For Change": "2026-04-01",
    "Posting Date": "2026-04-01",
    "Combine Periods": "false"
}

CancelContract

Storniert einen bestehenden Vertrag. Pflichtfelder:
FeldBeschreibung
Contract No.Nummer des zu stornierenden Vertrags
Cancel ReasonStornierungsgrund
Cancellation Received AtDatum des Eingangs der Kündigung (Format: YYYY-MM-DD)
Cancellation DateWirksames Stornierungsdatum (Format: YYYY-MM-DD)
Beispiel-Payload:
{
    "Contract No.": "KONT-00001",
    "Cancel Reason": "Kundenwunsch",
    "Cancellation Received At": "2026-03-01",
    "Cancellation Date": "2026-06-30"
}

CancelContractLine

Storniert eine einzelne Zeile eines bestehenden Vertrags. Pflichtfelder:
FeldBeschreibung
Contract No.Nummer des Vertrags
Contract Line No.Zeilennummer der zu stornierenden Vertragszeile
Cancel ReasonStornierungsgrund
Cancellation Received AtDatum des Eingangs der Kündigung (Format: YYYY-MM-DD)
Cancellation DateWirksames Stornierungsdatum (Format: YYYY-MM-DD)
Beispiel-Payload:
{
    "Contract No.": "KONT-00001",
    "Contract Line No.": "10000",
    "Cancel Reason": "Artikelwechsel",
    "Cancellation Received At": "2026-03-01",
    "Cancellation Date": "2026-06-30"
}

UpdateCustomer

Aktualisiert die Adress- und Stammdaten eines Kunden und überträgt die Änderungen auf alle zugehörigen Verträge. Pflichtfelder:
FeldBeschreibung
Customer No.Nummer des zu aktualisierenden Kunden

Tipp

Zusätzlich können beliebige weitere Felder des Debitors im Payload übergeben werden.
Beispiel-Payload:
{
    "Customer No.": "10000",
    "Name": "Adatum Corporation New",
    "Address": "Musterstraße 1",
    "City": "Wien",
    "Post Code": "1010"
}

ExtendLine

Verlängert eine bestehende Vertragszeile. Pflichtfelder:
FeldBeschreibung
Contract No.Nummer des zu aktualisierenden Vertrags
Contract Line No.Nummer der zu aktualisierenden Vertragszeile
Beispiel-Payload:
{
    "Contract No.": "KONT-00001",
    "Contract Line No.": "10000"
}

IndexingContractLine

Führt die Indexierungslogik für eine Vertragszeile aus. Pflichtfelder:
FeldBeschreibung
Contract No.Nummer des Vertrags
Contract Line No.Zeilennummer der Vertragszeile
Document DateBelegdatum für die Korrekturdokumente (Format: YYYY-MM-DD)
Posting DateBuchungsdatum für Korrekturdokumente (Format: YYYY-MM-DD)
Combine PeriodsPerioden zusammenfassen: true oder false
Beispiel-Payload:
{
    "Contract No.": "KONT-00001",
    "Contract Line No.": "10000",
    "Document Date": "2026-04-01",
    "Posting Date": "2026-04-01",
    "Combine Periods": "false"
}

Docs  /  App  /  NAVAX Wiederkehrende Verträge Interface  /  Anhang
 NAVAX Lizenzverwaltung

Die Seite NAVAX Lizenzverwaltung (in älteren Versionen "NAVAX Lizenzübersicht" oder "NCEX Lizenzübersicht") zeigt den aktuellen Lizenzstatus der NAVAX-Erweiterungen an.

Felder

NameZeigt den Namen der Erweiterung an.
LizenzstatusZeigt den aktuellen Lizenzstatus der Erweiterung an.
Seriennr.Zeigt die Seriennr. der Erweiterung an.
VersionZeigt die aktuell installierte Version der Erweiterung an.

Testversion

Eine NAVAX-Erweiterung kann nach der Installation 30 Tage lang kostenlos getestet bzw. genutzt werden. Danach kann die Erweiterung nur mehr mit einer gültigen Lizenz verwendet werden.

Lizenz beantragen

Die Lizenz kann über die Aktion Aktueller Status beantragt bzw. überprüft werden. Dabei wird eine neue Seite geöffnet. Das nachfolgende Beispiel zeigt die NAVAX-Erweiterung Excel Report Builder. Füllen Sie die Felder auf der Seite aus und klicken Sie anschließend auf Lizenzanfrage senden. Beachten Sie, dass der Lizenzierungsprozess einige Zeit dauern kann. In den nächsten Tagen erhalten Sie eine E-Mail mit weiteren Informationen.

Hinweis

Für die Lizenzierung, den Aufruf der Onlinehilfe und das Ausführen einiger Aktionen muss der Zugriff auf https://www.navax.app erlaubt sein.

Public IP von www.navax.app für die Freischaltung an der Firewall:
94.136.22.236, Port: TCP/443

Prüfung der Verbindung zu https://www.navax.app mittels PS:
Test-NetConnection navax.app -port 443
(PS muss mit dem M-Tier Service-User ausgeführt werden)

CRL-Server
Zusätzlich müssen für die Zertifikatsprüfung auch folgende CRL-Server erreichbar sein:
https://certificates.godaddy.com/*
http://crl.godaddy.com/*
oder deren IP: 192.124.249.36

Lizenz aktivieren/aktualisieren

Sobald die Lizenzierung abgeschlossen ist, erhalten Sie eine E-Mail und die Lizenz kann über die Aktion Lizenz aktualisieren aktiviert werden. Die Lizenz ist mandantenunabhängig. Es spielt also keine Rolle in welchem Mandanten die Aktion aufgerufen wird.

Hinweis

  • Die Lizenz muss einmal im Jahr über die Aktion Lizenz aktualisieren aktualisiert werden.
  • Die Aktualisierung ist erst innerhalb der letzten 30 Tage vor Ablauf der Lizenz (oder danach) möglich bzw. notwendig. Innerhalb der letzten 30 Tage vor Ablauf der Lizenz werden Hinweise angezeigt.
  • Ist die Automatische Lizenzverlängerung aktiviert, wird die Aktion Lizenz aktualisieren automatisch aufgerufen, bevor die Lizenz abläuft. Dabei werden alle Lizenzen, für die die automatische Lizenzverlängerung aktiviert ist, geprüft und bei Bedarf aktualisiert. Ist die automatische Verlängerung nicht erfolgreich, werden innerhalb der letzten 15 Tage vor Ablauf der Lizenz werden Hinweise angezeigt. Beachten Sie, dass die Einstellung erst aktiv ist, nachdem die Lizenz aktiviert wurde.

AGB & EULA

Weitere Informationen dazu finden Sie unter https://www.navax.app/EULA.php?L=de

Datenschutz

Weitere Informationen dazu finden Sie unter https://www.navax.app/privacyStatement.php?L=de

Bewertung abgeben

Über diese Aktion kann für die Erweiterung die Bewertungen-Seite der Microsoft AppSource geöffnet werden. Wir würden uns sehr freuen, wenn Sie hier Ihre Bewertung abgeben und uns über Ihre Erfahrungen mit der Erweiterung berichten.

Docs  /  App  /  NAVAX Wiederkehrende Verträge Interface  /  Anhang
 Installationshinweise

Veröffentlichen und Installieren der Erweiterung


Alle notwendigen Schritte werden hier beschrieben:
[Microsoft Learn] Business Central - Publishing and Installing an Extension

Abhängigkeiten

On-Premises

Folgende Granules werden bei einer On-Premises Installation benötigt:
  • 70714865 NAVAX Recurring Contracts Interface
  • 70714830 NAVAX Recurring Contracts
  • 1010860 NAVAX Extension Base

Externe Adressen

  • https://www.navax.app

    Für die Lizenzierung, den Aufruf der Onlinehilfe und das Ausführen einiger Aktionen muss der Zugriff auf https://www.navax.app erlaubt sein.

    Public IP von www.navax.app für die Freischaltung an der Firewall:
    94.136.22.236, Port: TCP/443

    Prüfung der Verbindung zu https://www.navax.app mittels PS:
    Test-NetConnection navax.app -port 443
    (PS muss mit dem M-Tier Service-User ausgeführt werden)

    CRL-Server
    Zusätzlich müssen für die Zertifikatsprüfung auch folgende CRL-Server erreichbar sein:
    https://certificates.godaddy.com/*
    http://crl.godaddy.com/*
    oder deren IP: 192.124.249.36

Docs  /  App  /  NAVAX Wiederkehrende Verträge Interface  /  Anhang
 Versionshinweise

Möchten Sie wissen, was sich in der Erweiterung geändert hat?
Nachfolgend finden Sie eine Übersicht über die neuen Funktionen und Änderungen, die in den Updates vorgenommen wurden.

Version 27.1.0.1

ab Business Central 27
2026/04/28
  • Fehlerbehebungen

    • Ein Fehler beim Öffnen der Einrichtung wurde behoben.

Version 27.1.0.0

ab Business Central 27
2026/04/21
  • Ursprungsversion

  Handbuch als PDF speichern oder drucken  
DE|EN Impressum