Aktuelle Version: 27.1.0.1ab Business Central 27. AppSource-Name: NAVAX Recurring Contracts Interface
Handbuch
Erstellungsdatum: 2026/05/22 Die aktuelle Version dieses Handbuchs finden Sie unter:
☰ 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...
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. NAVAXRecurring Contracts Interface.
Berechtigungssätze
Für NAVAX Wiederkehrende Verträge Interface stehen folgende Berechtigungssätze zur Verfügung:
Name
Beschreibung
NVXRCI
NAVAX Wiederk. Ver. Interface
Diese Berechtigungen benötigen Sie, um NAVAX Wiederkehrende Verträge Interface zu benutzen.
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 deaktivieren
Gibt 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.
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)
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.
Gehe zur Seite Web Services
Klicke auf + Neu
Verwende die folgenden Einstellungen:
Objekttyp: Codeunit
Objekt-ID: 70161950
Service Name: NVXRCIInterfaceMgt
Der Endpunkt wird veröffentlicht, indem das Flag Veröffentlicht aktiviert wird.
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.
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:
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:
Feld
Beschreibung
Description
Bezeichnung des Vertrags
Starting Date
Startdatum des Vertrags (Format: YYYY-MM-DD)
Ending Date
Enddatum des Vertrags (Format: YYYY-MM-DD)
Source Type
Quelltyp, z. B. Customer
Source No.
Nummer des Quell-Datensatzes (z. B. Kundennummer)
Billing Type
Abrechnungsart des Vertrags
Day of Period Start
Tag, an dem die Abrechnungsperiode beginnt
Tipp
Es können beliebig weitere Felder des Vertragskopfes im Payload übergeben werden.
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:
Feld
Beschreibung
Contract No.
Nummer des Vertrags
Contract Line No.
Zeilennummer der Vertragszeile
New Price
Neuer Preis (leer lassen, falls unverändert)
New Quantity
Neue Menge (leer lassen, falls unverändert)
Date For Change
Datum, ab dem die Änderung wirksam wird (Format: YYYY-MM-DD)
Posting Date
Buchungsdatum für Korrekturdokumente (Format: YYYY-MM-DD)
Combine Periods
Perioden 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:
Feld
Beschreibung
Contract No.
Nummer des zu stornierenden Vertrags
Cancel Reason
Stornierungsgrund
Cancellation Received At
Datum des Eingangs der Kündigung (Format: YYYY-MM-DD)
Die Seite NAVAX Lizenzverwaltung (in älteren Versionen "NAVAX Lizenzübersicht" oder "NCEX Lizenzübersicht") zeigt den aktuellen Lizenzstatus der NAVAX-Erweiterungen an.
Felder
Name
Zeigt den Namen der Erweiterung an.
Lizenzstatus
Zeigt den aktuellen Lizenzstatus der Erweiterung an.
Seriennr.
Zeigt die Seriennr. der Erweiterung an.
Version
Zeigt 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.
Ü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.
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
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.