API

2026/06/29 • 3 min. to read

In this topic

Endpoint
List of XML Schemas
Create and retrieve file
Set Filters
Permission Set
Related information

Files can also be generated externally using the XML Builder via an API. The created file is returned in Base64 format. For a schema to be visible in the API resp. for the file to be created via the API, the Allow API Access field must be specified for the XML Schema. For more information, see Working with the App, XML Builder Schemas.

Note

If necessary, you can also completely disable API access at any time in the XML Builder Setup. For more information, see Setup, XML Builder Setup.

Endpoint

To access the XML Builder via the API, use the following information:

Publisher	navax
Group	xmlBuilder
Version	v2.0
Endpoint	xmlSchemas

List of XML Schemas

A list of all XML schemas for which API access is permitted can be retrieved via a GET request. URL structure

https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/xmlBuilder/v2.0/companies({id})/xmlSchemas

Example

https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas

Result

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/$metadata#companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzMxMDQ5Njc5Nzc5MjgyNzY5NDIxOzAwOyc=\"",
            "type":"General",
            "code": "CUST",
            "description": "Customers incl. Entries",
            "comments": "API Test",
            "filter": "{ \"No.\": \"Code\", \"Salesperson Code\": \"Code\" }"
        },
        {
            "@odata.etag": "W/\"JzE3Ozc2NTU2NDM4NTIxNjcwNjE3MTswMDsn\"",
            "type":"General",
            "code": "SINV",
            "description": "Sales Invoice",
            "comments": "API Test",
            "filter": "{ \"No.\": \"Code\" }"
        }
    ]
}

Create and retrieve file

The file for a schema can be created and retrieved via a POST request. The resulting file is returned in Base64 format. URL structure

https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/xmlBuilder/v2.0/companies({id})/xmlSchemas('{type,code}')/Microsoft.NAV.GetFileAsBase64

Example

https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/xmlSchemas('General','CUST')/Microsoft.NAV.GetFileAsBase64

Result

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/xmlBuilder/v2.0/$metadata#Edm.String",
    "value": "UEsDBBQAAAAIADo7h1xFpqSDDAUAAFgZAAAYAAAAeGwvd29ya3NoZWV0cy9zaGVldDEueG1...gAAAAAA=="
}

Set Filters

More information will follow soon.

Permission Set
The following permission set is available for the API:
NVXXML, API	XML Builder API To enable files to be created via the API, this permission set must be added to the Microsoft Entra Application or, in the case of an on-premises installation, to the API user.