Microsoft Dynamics 365 Business Central “Custom API” is a feature of the Business Central ERP system developed by Microsoft, which allows organizations to create tailor-made API endpoints to expose specific business data and logic. It is part of the Business Central extensibility framework and is typically used to integrate external applications or systems with Business Central in a secure and structured way.
Custom APIs are ideal for automating workflows, syncing data, and tailoring integrations. They support versioning, controlled access, and data shaping, making them a powerful tool for building flexible and secure connections to Business Central.
This article provides an overview to get started with the MS Business Central “Custom API” connector in Peliqan. Please contact support if you have any additional questions or remarks.
Content
- Content
- Connect to Microsoft Dynamics 365 Business Central using a “Custom API”
- Add connection
- Prerequisites
- Configuration Steps
- 1. Connection Setup
- 2. Business Central Credentials
- 3. API Configuration
- 4. Entity Selection
- 5. Replication Settings
- MS Business Central data sync to a data warehouse
- Support
Connect to Microsoft Dynamics 365 Business Central using a “Custom API”
Peliqan has 2 connectors to work with a Custom API in Business Central:
- MS Business Central Custom API
- MS Business Central Custom API (Private app)
The steps below are without using a Private app. If you want to use a Private app, make sure to create the app in Azure first. See the general documentation of Business Central for more information on how to create a Private app in Azure:
Add connection
In Peliqan, go to Connections, click on “Add Connection” and search for Business Central Custom API. Choose one of the connectors:
Prerequisites
- Access to your Microsoft Business Central environment with admin privileges
- Valid API permissions set up in Business Central
Configuration Steps
1. Connection Setup
Connection Name
Enter a descriptive name for this connection
2. Business Central Credentials
Tenant ID
To find your Tenant ID:
- Log in to Business Central and navigate to the Dashboard
- Click the Settings icon (⚙) in the top toolbar
- Select "Admin Center"
- Copy the Tenant ID from the URL (it appears as
https://businesscentral.dynamics.com/{TENANT_ID}/admin
)
Environment Name
To locate your Environment Name:
- In the Admin Center, select "Environments"
- Choose your environment from the list (or create one if needed)
- Enter the exact environment name as shown
Company Name
To find your Company Name:
- On the Business Central Dashboard
- Click the Building icon in the top toolbar
- Select the company you want to connect to from the list
- Enter the exact company name as shown
3. API Configuration
API Category Route
Enter the API route in the format: publisher/group/version
Example: zy/zygroup/v2.0
4. Entity Selection
List of Entities
- Enter a comma-separated list of custom tables you want to access
- By default, the primary key is assumed to be "id"
- To specify a different primary key:
entityName|primaryKey
(e.g.,customer|systemId
) - For composite primary keys:
entityName|key1+key2
(e.g.,order|orderId+lineNumber
)
5. Replication Settings
Replication Key
(Optional) Specify which field should be used for incremental refreshes:
- Enter the field name that tracks record changes (typically a timestamp or version field)
- Leave blank if you don't need incremental refresh
- Provided primary key works for all the Entities provided in connect form.
Incremental/Non-incremental
- Select "Incremental" if all your selected entities have the replication key available
- Select "Non-incremental" for full refreshes each time
Once done, click on Connect MS Business Central Custom API to initiate an OAuth Flow.
MS Business Central data sync to a data warehouse
Peliqan offers an out of the box data warehouse. Optionally you can choose to sync MS Business Central data to your own data warehouse such as Snowflake, Google BigQuery, MS SQL etc.
Data will be synced to the chosen data warehouse and made available through the Peliqan UI for exploration:
With the Peliqan federated query engine, queries on the MS Business Central data can be written and data can be transformed and combined with other sources.
Support
If you encounter issues or don't see the tables you need:
- Contact support at support@peliqan.io
- Include your Business Central version and any error messages received