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

 Endpoint Definition

2026/04/13 • 3 min. to read

In this topic

• Prerequisites
• Base URL
• Endpoints
• CallWebservice
• ReadMe
• Error Handling
• Related information

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: 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.

Related information

• Working with the App, Available Operations
  This section describes all available operations of the NAVAX Recurring Contracts Interface web service...