| Docs Help
  AppSource  
Print this pageEntire manual (printable version)
Docs  /  NVXAPIA API Automation  /  Working with the App

Endpoint Definition


2025/06/30 • 6 min. to read
On this page, you will find an overview of the various API endpoints for API Automation. These endpoints enable access to and interaction with data from Microsoft Dynamics 365 Business Central.

API Pages

In this section, you will find an overview of the available API pages. These endpoints allow you to retrieve structured data from Business Central in a standardized format. They serve as the foundation for more advanced queries by providing key information about tables and fields required for configuring and filtering further data requests.

All Objects with Caption

With the endpoint allObjWithCaptions, you can query records from the All Objects with Caption table in Business Central.

Endpoint: GET /api/navax/apia/v1.0/companies({{CompanyID}})/allObjWithCaptions
HTTP MethodGET
URL
https://api.businesscentral.dynamics.com/v2.0/{{EnviromentName}}/api/navax/apia/v1.0/companies({{CompanyID}})/allObjWithCaptions
Example Call
GET https://api.businesscentral.dynamics.com/v2.0/TEST/api/navax/apia/v1.0/companies(00000000-0000-0000-0000-000000000000)/allObjWithCaptions
ResponseThe endpoint returns the details of the requested record in JSON format.

Fields

With the endpoint fields, you can query records from the Fields table in Business Central.

Endpoint: GET /api/navax/apia/v1.0/companies({{CompanyID}})/fields
HTTP MethodGET
URL
https://api.businesscentral.dynamics.com/v2.0/{{EnviromentName}}/api/navax/apia/v1.0/companies({{CompanyID}})/fields
Example Call
GET https://api.businesscentral.dynamics.com/v2.0/TEST/api/navax/apia/v1.0/companies(00000000-0000-0000-0000-000000000000)/fields
ResponseThe endpoint returns the details of the requested record in JSON format.

Tip

The endpoints for All Objects with Caption and Fields can be used as a basis for pre-storing certain data for subsequent queries. Field IDs and table IDs are used in functions to filter records.

API Functions

The following functions offer advanced options for interacting with data in Business Central. Unlike the basic page endpoints, these functions allow targeted queries of complex structures, filtering based on specific criteria, and retrieving data across multiple tenants simultaneously. The functions can be flexibly adapted and are particularly well-suited for dynamic scenarios or analyses in external systems such as Power BI.

Important

The example URLs in the individual requests assume that the required Codeunit 64812 APIAFunctionsNVX has been set up with the name APIAFunctionsNVX during the configuration process. For more information, see Setup, API Automation Hub.

Read Table Structure from BC

With the endpoint GetTableStructure, you can query the structure of tables from Business Central.

Endpoint: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableStructure?company={{CompanyName}}
HTTP MethodPOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableStructure?company={{CompanyName}}
Required Parameters
  • tableID: The ID of the table to be queried.
Example Call
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableStructure?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "18"
}
ResponseThe endpoint returns the details of the queried table in JSON string format.
Example Response (converted to JSON) 
{
    "table": 18,
    "values": [
        {
            "No.": {
                "no": 1,
                "type": "",
                "length": 20,
                "typeName": "Code20",
                "optionString": "",
                "IsPartOfPrimaryKey": true
            },
            "Name": {
                "no": 2,
                "type": "",
                "length": 100,
                "typeName": "Text100",
                "optionString": "",
                "IsPartOfPrimaryKey": false
            },
            ...
        }
    ]
}

Read Data from BC

With the endpoint GetTableData, you can query data from Business Central without table filters.

Endpoint: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableData?company={{CompanyName}}
HTTP MethodPOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableData?company={{CompanyName}}
Required Parameters
  • tableID: The ID of the table to be queried.
  • fieldFilter: A filter for the required field IDs from the table.
Example Call
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableData?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "18",
    "fieldFilter": "1|2|5..10"
}
ResponseThe endpoint returns the details of the queried table in JSON string format.
Example Response (converted to JSON) 
{
    "table": 18,
    "values": [
        {
            "company": "",
            "No.": "10000",
            "Name": "Adatum Corporation",
            "Address": "Station Road, 21",
            "Address 2": "",
            "City": "Vienna",
            "Contact": "",
            "Phone No.": "",
            "Telex No.": ""
        },
        {
            "company": "",
            "No.": "20000",
            "Name": "Trey Research",
            "Address": "Southwark Bridge Rd, 91-95",
            "Address 2": "",
            "City": "Dürnstein",
            "Contact": "Leonie Fischer",
            "Phone No.": "",
            "Telex No.": ""
        }
    ]
}

Read Data from BC with Table Filter

With the endpoint GetTableDataWithFilter, you can query data from Business Central with a table filter.

Endpoint: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataWithFilter?company={{CompanyName}}
HTTP MethodPOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataWithFilter?company={{CompanyName}}
Required Parameters
  • tableID: The ID of the table to be queried.
  • fieldFilter: A filter for the required field IDs from the table.
  • tableFilter: Defines the filtering of the table.
Example Call
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableDataWithFilter?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "18",
    "fieldFilter": "1|2|3|4",
    "tableFilter": "Sorting(No.) Order(Ascending) Where(No.=Filter(10000))"
}
ResponseThe endpoint returns the details of the queried table in JSON string format.
Example Response (converted to JSON) 
{
    "table": 18,
    "values": [
        {
            "company": "",
            "No.": "10000",
            "Name": "Adatum Corporation",
            "Search Name": "ADATUM CORPORATION",
            "Name 2": ""
        }
    ]
}

Important

Each query can return a maximum of 10,000 records. If more data is included in the query, pagination must be used. To perform pagination, an additional attribute nextPageLink is returned. This attribute provides the Primary Key of the next record and can thus be used for filtering.

Read Data from BC with BC Mapping

With the endpoint GetTableDataFromMapping, you can query data from Business Central that has been set up in the BC mappings.

Endpoint: POST /v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataFromMapping?company={{CompanyName}}
HTTP MethodPOST
URL
https://api.businesscentral.dynamics.com/v2.0/{{TenantID}}/{{EnviromentName}}/ODataV4/APIAFunctionsNVX_GetTableDataFromMapping?company={{CompanyName}}
Required Parameters
  • tableID: The ID of the table to be queried.
Example Call
POST https://api.businesscentral.dynamics.com/v2.0/00000000-0000-0000-0000-000000000000/TEST/ODataV4/APIAFunctionsNVX_GetTableDataFromMapping?company='CRONUS AT'
Body (JSON) 
{
    "tableID": "18"
}
ResponseThe endpoint returns the details of the queried table in JSON string format.
Example Response (converted to JSON) 
{
    "table": 18,
    "values": [
        {
            "company": "",
            "No.": "10000",
            "Name": "Adatum Corporation",
            "Search Name": "ADATUM CORPORATION",
            "Name 2": ""
        }
    ]
}

Related information



Submit feedback for
DE|EN Imprint
◀☰▶
△