Docs  /  App  /  Excel Report Builder  /  Information for Developers

 API

2026/04/07 • 3 min. to read

In this topic

• Endpoint
• Evaluation list
• Create and retrieve evaluation
• Permission Set
• Related information

Evaluations can also be generated externally via an API using the Excel Report Builder. The created Excel file is returned in Base64 format. For an evaluation to be visible in the API and to be executed via the API, the Allow API Access field must be specified on the Excel Evaluation Card. For more information, see Edit Evaluations, General, Edit Excel Evaluation.

Endpoint

To access the Excel Report Builder via the API, use the following information:

Evaluation list

A list of all Excel evaluations 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/excelReportBuilder/v2.0/companies({id})/excelEvaluations Example https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/excelReportBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/excelEvaluations Result

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/excelReportBuilder/v2.0/$metadata#companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/excelEvaluations",
    "value": [
        {
            "@odata.etag": "W/\"JzE5OzMxMDQ5Njc5Nzc5MjgyNzY5NDIxOzAwOyc=\"",
            "code": "TEST",
            "description": "Test Evaluation",
            "comments": "API Test"
        },
        {
            "@odata.etag": "W/\"JzE3Ozc2NTU2NDM4NTIxNjcwNjE3MTswMDsn\"",
            "code": "TEST2",
            "description": "Test Evaluation 2",
            "comments": "API Test"
        }
    ]
}

Create and retrieve evaluation

An Excel evaluation can be created and retrieved via a POST request. The resulting Excel file is returned in Base64 format. URL structure https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environment}/api/navax/excelReportBuilder/v2.0/companies({id})/excelEvaluations('{code}')/Microsoft.NAV.GetFileAsBase64 Example https://api.businesscentral.dynamics.com/v2.0/0e12x34c-e5le-678x-c912-34567890e12l/NAVAXAppsSandbox/api/navax/excelReportBuilder/v2.0/companies(c2d9d41e-19ab-ec11-bb8f-000d3a231900)/excelEvaluations('TEST')/Microsoft.NAV.GetFileAsBase64 Result

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

Related information

• Setup, Excel Report Builder Setup
• Edit Evaluations, General, Edit Excel Evaluation