Save manual as PDF or print  


NAVAX Recurring Contracts Interface


API functions for NAVAX Recurring Contracts.

Current Version: 27.1.0.1 as of Business Central 27.
AppSource Name: NAVAX Recurring Contracts Interface

Manual


Creation date: 2026/05/22
The current version of this manual can be found at:

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


☰ Contents



General

  • NAVAX Recurring Contracts Interface
    NAVAX Recurring Contracts Interface extends Microsoft Dynamics 365 Business Central and provides the ability to manage NAVAX Recurring Contracts automatically via API endpoints...

Setup

  • Recurring Contracts Interface Setup
    Setting up NAVAX Recurring Contracts Interface requires two steps...

Working with the App

  • Endpoint Definition
    The NAVAX Recurring Contracts Interface web service provides two endpoints through which external systems can execute contract operations in Business Central and query the available operations...
  • Available Operations
    This section describes all available operations of the NAVAX Recurring Contracts Interface web service...

Appendix

  • NAVAX License Management
    The NAVAX License Management page (in older versions NAVAX License Overview or NCEX License Overview) displays the current license status of the NAVAX extensions...
  • Installation Notes
  • Release Notes

Docs  /  App  /  NAVAX Recurring Contracts Interface  /  General
 NAVAX Recurring Contracts Interface

NAVAX Recurring Contracts Interface extends Microsoft Dynamics 365 Business Central and provides the ability to manage NAVAX Recurring Contracts automatically via API endpoints.

Navigation

Fields, actions, pages, and reports that originate from the NAVAX Recurring Contracts Interface extension are identified by the abbreviation NCRCI. This additional label allows them to be clearly distinguished from other extensions (which may use similar names and descriptions). The search terms "nvxrci", "ncrci" and "navax" are also recognized by "Tell me what you want to do". This allows quick access to the individual areas of NAVAX Recurring Contracts Interface.

Note

NAVAX Recurring Contracts Interface was developed with the prefix NCRCI resp. NVXRCI. NCRCI resp. NVXRCI stands for NAVAX Consulting resp. NAVAX Recurring Contracts Interface.

Permission Sets

The following permission sets are available for NAVAX Recurring Contracts Interface:
NameDescription
NVXRCINAVAX Rec. Cont. Interface You need these permissions to use NAVAX Recurring Contracts Interface.
NVXRCI, SETUPNAVAX Rec. Cont. Interface Setup You need these permissions to set up NAVAX Recurring Contracts Interface. For more information, see Setup, Recurring Contracts Interface Setup.

Installation Notes

For more information, see Appendix, Installation Notes.

Docs  /  App  /  NAVAX Recurring Contracts Interface  /  Setup
 Recurring Contracts Interface Setup

Setting up NAVAX Recurring Contracts Interface requires two steps. Before any configuration can be done in Business Central, the necessary settings must first be made in Azure to enable communication via web service with Business Central. All relevant Business Central setup steps can be performed directly on the NAVAX Recurring Contracts Interface Setup page.

General, Fields
Disable API AccessSpecifies whether API access should be disabled.

Setup in Azure

Microsoft Entra Application

To make requests to Business Central via the API, an additional Entra application is required that has all permissions for API automation.
  1. Create an Entra Application in Azure
  2. After the Entra application has been created in Azure, it is also necessary to create the Entra application in Business Central. (also described in the link above)
  3. Important: For NAVAX Recurring Contracts Interface, it is important to add the permission sets NVXRCI, NVXRC, and D365 READ.

Add API Function Codeunit to Web Services

To publish the API endpoint for API automation, the NVXRCIInterfaceMgt codeunit must be added to the web services.
  1. Go to the Web Services page
  2. Click + New
  3. Use the following settings:
    • Object Type: Codeunit
    • Object ID: 70161950
    • Service Name: NVXRCIInterfaceMgt
  4. The endpoint is published by enabling the Published flag.
  5. The newly created web service should look as follows:

Docs  /  App  /  NAVAX Recurring Contracts Interface  /  Working with the App
 Endpoint Definition

The NAVAX Recurring Contracts Interface web service provides two endpoints through which external systems can execute contract operations in Business Central and query the available operations.

Prerequisites

The codeunit NVXRCIInterfaceMgt must be published as a web service in Business Central. Detailed setup steps are described in the Setup help page.

Base URL

https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{Enviroment}}/ODataV4/InterfaceMgt_{{Endpoint}}?company={{CompanyName}}
The following placeholders must be replaced:
  • {{TenantID}} – The tenant ID of the BC environment
  • {{Environment}} – The name of the Business Central environment (e.g. Production)
  • {{CompanyName}} – The name of the Business Central company (from Companies)
  • {{Endpoint}} – The name of the endpoint, either CallWebservice or readMe

Endpoints

CallWebservice

Executes a contract operation. The caller passes the operation name and a JSON payload with the required fields. Parameters:
ParameterTypeDescription
OperationTextName of the operation to execute (e.g. CreateContract)
PayloadText (JSON)JSON object with the fields required for the operation, as text.
Return value: Confirmation text, e.g. "Operation CreateContract has been executed successfully." Example call (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"
    }'
}
A complete list of all available operations and their required fields is described in the Available Operations help page.

ReadMe

Returns a JSON array describing all available operations with their respective required fields. This endpoint is ideal for documentation and for automatic discovery of supported operations by external systems. Parameters: None Return value: JSON array with one object per operation. Each object contains the operation name as the key and a JSON object with the required fields (with empty values as placeholders) as the value. 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"
        }
    }
]

Error Handling

If an unknown operation name is passed, CallWebservice returns a SOAP fault with the message "No Operation found!". If required fields are missing from the payload, an error is also returned. The ReadMe endpoint can be used to query the required fields in advance.

Docs  /  App  /  NAVAX Recurring Contracts Interface  /  Working with the App
 Available Operations

This section describes all available operations of the NAVAX Recurring Contracts Interface web service. Each operation is called via the CallWebservice endpoint by passing the operation name in the Operation parameter and the required fields as a JSON object in the Payload parameter. The required fields of each operation can also be queried at runtime via the ReadMe endpoint.

CreateContract

Creates a new contract header in Business Central. Required fields:
FieldDescription
DescriptionName of the contract
Starting DateStart date of the contract (Format: YYYY-MM-DD)
Ending DateEnd date of the contract (Format: YYYY-MM-DD)
Source TypeSource type, e.g. Customer
Source No.Number of the source record (e.g. customer number)
Billing TypeBilling type of the contract
Day of Period StartDay on which the billing period starts

Tip

Any additional fields of the contract header can be passed in the payload.
Example payload: 
{
    "Description": "Maintenance Contract 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

Adds a new contract line to an existing contract. Required fields:
FieldDescription
Contract No.Number of the parent contract
Bundle TypeBundle type of the contract line
TypeType of the line (e.g. Item, G/L Account)
No.Number of the item or G/L account
QuantityQuantity
Unit PriceUnit price

Tip

Any additional fields of the contract line can be passed in the payload.
Example payload: 
{
    "Contract No.": "KONT-00001",
    "Bundle Type": " ",
    "Type": "Item",
    "No.": "1000",
    "Quantity": "2",
    "Unit Price": "49"
}

CreateContractLine - Bundles

To create bundles, the CreateContractLine operation can be used. First, the bundle header must be created by setting the Bundle Type field to Bundle and the Type field to a space ( ). For the bundle components, the CreateContractLine operation must then be called again, with the Bundle Type field set to Component and the line number of the bundle header line passed in the Assigned To Bundle field (this can be retrieved from the response).

ScheduledPriceQtyChange

Schedules a price or quantity change for an existing contract line at a defined date. Required fields:
FieldDescription
Contract No.Number of the contract
Contract Line No.Line number of the contract line
New PriceNew price (leave blank if unchanged)
New QuantityNew quantity (leave blank if unchanged)
Date For ChangeDate from which the change takes effect (Format: YYYY-MM-DD)
Posting DatePosting date for correction documents (Format: YYYY-MM-DD)
Combine PeriodsCombine periods: true or false
Example 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

Cancels an existing contract. Required fields:
FieldDescription
Contract No.Number of the contract to cancel
Cancel ReasonReason for cancellation
Cancellation Received AtDate the cancellation was received (Format: YYYY-MM-DD)
Cancellation DateEffective cancellation date (Format: YYYY-MM-DD)
Example payload: 
{
    "Contract No.": "KONT-00001",
    "Cancel Reason": "Customer request",
    "Cancellation Received At": "2026-03-01",
    "Cancellation Date": "2026-06-30"
}

CancelContractLine

Cancels an individual line of an existing contract. Required fields:
FieldDescription
Contract No.Number of the contract
Contract Line No.Line number of the contract line to cancel
Cancel ReasonReason for cancellation
Cancellation Received AtDate the cancellation was received (Format: YYYY-MM-DD)
Cancellation DateEffective cancellation date (Format: YYYY-MM-DD)
Example payload: 
{
    "Contract No.": "KONT-00001",
    "Contract Line No.": "10000",
    "Cancel Reason": "Item change",
    "Cancellation Received At": "2026-03-01",
    "Cancellation Date": "2026-06-30"
}

UpdateCustomer

Updates the address and master data of a customer and transfers the changes to all associated contracts. Required fields:
FieldDescription
Customer No.Number of the customer to update

Tip

Any additional fields of the customer can also be passed in the payload.
Example payload: 
{
    "Customer No.": "10000",
    "Name": "Adatum Corporation New",
    "Address": "Sample Street 1",
    "City": "Vienna",
    "Post Code": "1010"
}

ExtendLine

Extends an existing contract line. Required fields:
FieldDescription
Contract No.Number of the contract to update
Contract Line No.Number of the contract line to update
Example payload: 
{
    "Contract No.": "KONT-00001",
    "Contract Line No.": "10000"
}

IndexingContractLine

Executes the indexing logic for a contract line. Required fields:
FieldDescription
Contract No.Number of the contract
Contract Line No.Line number of the contract line
Document DateDocument date for correction documents (Format: YYYY-MM-DD)
Posting DatePosting date for correction documents (Format: YYYY-MM-DD)
Combine PeriodsCombine periods: true or false
Example 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 Recurring Contracts Interface  /  Appendix
 NAVAX License Management

The NAVAX License Management page (in older versions "NAVAX License Overview" or "NCEX License Overview") displays the current license status of the NAVAX extensions.

Fields
NameSpecifies the name of the Extension.
License StatusSpecifies the current license status of the Extension.
Serial No.Specifies the serial number of the Extension.
VersionSpecifies the currently installed version of the Extension.

Trial Version

A NAVAX extension can be tested or used free of charge for 30 days after installation. After that, the extension can only be used with a valid license.

Request License

The license can be requested or checked via the Current Status action. This opens a new page. The following example shows the NAVAX extension Excel Report Builder. Fill in the fields in the page and then click Send License Request. Please note that the licensing process may take some time. In the next few days you will receive an email with further information.

Note

For licensing, calling the online help and performing some actions, access to https://www.navax.app must be granted.

Public IP from www.navax.app for setting firewall access:
94.136.22.236, Port: TCP/443

Checking the connection to https://www.navax.app using PS:
Test-NetConnection navax.app -port 443
(PS must be performed with the M-Tier service user)

CRL Servers
In addition, the following CRL Servers must also be accessible for the certificate check:
https://certificates.godaddy.com/*
http://crl.godaddy.com/*
or their IP: 192.124.249.36

Activate/Update License

As soon as the licensing has been completed, you will receive an email and the license can be activated via the Update License action. The license is company independent. So it does not matter in which company the action is called.

Note

  • The licence must be updated once a year via the Update License action.
  • The update is only possible or necessary within the last 30 days before the license expires, or afterwards. Within the last 30 days before the license expires, notes are displayed.
  • If the Automatic License Renewal is enabled, the Update License action is called automatically before the license expires. During this process, all licenses for which automatic license renewal is enabled are checked and updated if necessary. If automatic renewal is not successful, notifications will be displayed within the last 15 days before the license expires. Note that the setting is only active after the license has been activated.

Terms & Conditions

For more information, see https://www.navax.app/EULA.php?L=en

Data Security

For more information, see https://www.navax.app/privacyStatement.php?L=en

Submit Rating

This action can be used to open the Microsoft AppSource ratings page for the extension. We would be very happy if you submit your rating and let us know about your experience with the Extension.

Docs  /  App  /  NAVAX Recurring Contracts Interface  /  Appendix
 Installation Notes

Publish and Install the Extension


All necessary steps are described here:
[Microsoft Learn] Business Central - Publishing and Installing an Extension

Dependencies

On-Premises

The following Granules are required for an On-Premises installation:
  • 70714865 NAVAX Recurring Contracts Interface
  • 70714830 NAVAX Recurring Contracts
  • 1010860 NAVAX Extension Base

External Addresses

  • https://www.navax.app

    For licensing, calling the online help and performing some actions, access to https://www.navax.app must be granted.

    Public IP from www.navax.app for setting firewall access:
    94.136.22.236, Port: TCP/443

    Checking the connection to https://www.navax.app using PS:
    Test-NetConnection navax.app -port 443
    (PS must be performed with the M-Tier service user)

    CRL Servers
    In addition, the following CRL Servers must also be accessible for the certificate check:
    https://certificates.godaddy.com/*
    http://crl.godaddy.com/*
    or their IP: 192.124.249.36

Docs  /  App  /  NAVAX Recurring Contracts Interface  /  Appendix
 Release Notes

Would you like to know what has changed in the extension?
Below you'll find an overview of the new features and changes made in the updates.

Version 27.1.0.1

as of Business Central 27
2026/04/28

  • Corrections

    • An issue during opening the Setup-Page was fixed.

Version 27.1.0.0

as of Business Central 27
2026/04/21

  • Initial Version

  Save manual as PDF or print  
DE|EN Imprint