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

 Verfügbare Operationen


2026/04/13 • 5 Min. Lesedauer
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"
}


Feedback senden für
DE|EN Impressum