Build Power BI reports for displaying Dynamics 365 Business Central data

You can make your Dynamics 365 Business Central data available as a data source in Power BI Desktop and build powerful reports about the state of your business.

This article describes how to start using Power BI Desktop to create reports that display Dynamics 365 Business Central data. After you create reports, you can publish them to your Power BI service or share them with all users in your organization. When the reports are in the Power BI service, users with access can view the reports in Dynamics 365 Business Central.

Prepare to build Power BI reports

Note

You could get the data from various companies in a single report with OData web services. However, starting with Business Central 2021 release wave 2, only ODataV4 is supported. ODataV4 doesn't export data from multiple companies. The $expand function in Power BI that you might think would be an alternative way to create a multi-company report can't be used either. It creates a column with the company name but doesn't populate it with the company data after a refresh.

Add Business Central as a data source in Power BI Desktop

The first task in creating reports is to add Business Central as a data source in Power BI Desktop. Once connected, you can start to build the report. The following steps use the new Get Data experience in Power BI Desktop. Learn more about the new experience in Get data in Power BI Desktop.

  1. Start Power BI Desktop.

  2. Select Get data or Get data from other sources. If you don't see Get data, select the File menu, then Get data.

    If you're prompted to sign in, sign in using the same work account that you use to sign in to Business Central.

    Note

    The first time you connect to Business Central, you might be prompted to sign in. After you connect, you won't be prompted again unless you change or clear the account used for the connection. How do I change or clear the account I'm currently using to connect to Business Central from Power BI Desktop?.

  3. On the Choose data source page, search for Business Central, and then select Dynamics 365 Business Central.

  4. On the Connect to data source page, select Next to connect to Business Central.

  5. On the Choose data page, expand the environment and company that contain the data you want to use in your report.

    The available data sources are grouped by environment and company as follows:

    • Environment name

      • Company name

        • Advanced APIs

          Lists advanced APIs published by Microsoft, such as the Business Central automation APIs, and APIs published by other organizations, also known as custom APIs. Custom APIs are further grouped according to the APIPublisher/APIGroup properties of the API source code.

        • Standard APIs v2.0

          Lists the standard data APIs exposed by Business Central API V2.0. These APIs provide access to Business Central data, such as customers, vendors, items, general ledger entries, dimensions, payment methods, and units of measure.

        • Web services (legacy)

          Lists pages and queries published as OData web services in Business Central. Codeunits aren't available as OData data sources. We recommend using APIs instead of OData web services when possible.

  6. Select the data source or sources that you want to add to your data model, and then select Load.

  7. To add more Business Central data later, repeat the previous steps.

After the data is loaded, it appears in the Data pane on the right side of Power BI Desktop. You're now connected to your Business Central data and can start building your Power BI Desktop report.

Create accessible reports

It's important to make your reports usable for as many people as possible. Try to design reports so that they don't require any special adaptation to meet the specific needs of different users. Make sure the design lets users take advantage of assistive technologies, like screen readers. Power BI includes various accessibility features, tools, and guidelines to help. Learn more in Design Power BI reports for accessibility in the Power BI documentation.

Create reports to display data associated with a list in Business Central

You can create reports that display in a FactBox on a Business Central list page, and change when different rows are selected in the list. Creating these reports is similar to other reports, except there are a few things to do to make sure the reports display as expected. Learn more in Creating Power BI Reports for Displaying List Data in Business Central.

Using the Business Central report theme (optional)

Before building your report, we recommend that you download and import the Business Central theme file. The theme file creates a color palette so you can build reports with the same color styling as the Business Central apps, without requiring you to define custom colors for each visual.

Note

This task is optional. You can always create your reports and then download and apply the style template later.

Download the theme

The theme file is available as a json file on Microsoft Power BI Community Themes Gallery. To download the theme file, do the following steps:

  1. Visit Microsoft Power BI Community Themes Gallery for Microsoft Dynamics 365 Business Central.
  2. Select the download attachment Microsoft Dynamics Business Central.json.

Import the theme on a report

After you download the Business Central report theme, import it to your reports. In the ribbon, select Design > Import theme, and then browse for the Microsoft Dynamics Business Central.json file. Learn more in Power BI Desktop - Import custom report themes.

Publish reports to Power BI

After you create or modify a report, you can publish the report to your Power BI service and also share it with others in your organization. After you publish a report, it's available in Business Central. The report also becomes available for selection in Business Central.

To publish a report, select Publish on the Home tab of the ribbon or from the File menu. If you're signed into the Power BI service, the report is published to this service. Otherwise, you're prompted to sign in.

Distribute or share a report

There are a couple of ways to share reports:

  • Share a report from your Power BI service (recommended)

    You need a Power BI Pro or Premium Per User (PPU) license to share reports from the Power BI service. Recipients also need Pro or PPU unless both the report and its semantic model are hosted in Premium capacity or Fabric F64 or larger capacity. Content in a PPU workspace requires PPU licenses for recipients. Learn more in Share a dashboard or report.

  • Distribute reports as .pbix files.

    Reports are stored on your computer as .pbix files. You can distribute the .pbix file to users, like any other file. Then, the people you shared the file with can upload it to their Power BI service. Learn more in Upload reports from files.

    Note

    Distributing reports in this way means that refreshing data for reports is done individually by each user. This situation might impact Business Central performance.

How to develop cross-company or cross-environment Power BI reports

The Business Central API endpoints all have the prefix https://api.businesscentral.dynamics.com/v2.0/<environment_name>/api/v2.0 followed by /companies({company_id})/accounts({id}) (here we use the accounts API as an illustration). You can use this structure to create PowerQuery queries that load data for multiple companies or multiple environments if the user who is reading data can access them.

To set up a query to load data for multiple companies, follow these steps:

  1. Take the PowerQuery query that loads data for a single company. Convert it to a custom Power Query function that takes the company ID (or maybe the environment name) as parameters. Learn more in Using custom Power Query functions.
  2. Now use the new custom function in a PowerQuery query, where you map the function over a list of companies and then merge the datasets using the Table.Combine Power Query function.

Customize the Power Query code that connects to your Business Central data source

In most cases, using the navigation experience in the Power BI Desktop user interface is enough to get you started with building reports based on Business Central data. However, more complex scenario might require you to manually edit the Power Query code responsible to get your data.

To do that, follow these steps:

  1. Start Power BI Desktop.

  2. Complete the step that suits your scenario:

    Edit existing report

    1. Select File > Open.
    2. Browse for and select the report (.pbix).
    3. In the ribbon, select Transform Data to open the Power Query Editor.

    Create new report

    1. In the ribbon, select Get Data. If you don't see Get Data, select the File menu, then Get Data.
    2. On the Get Data page, select Online Services > Dynamics 365 Business Central > Connect.
    3. In the Navigator window, select the API endpoint that you want to load data from.
    4. Select Transform Data instead of Load as you might normally do. This step opens Power Query Editor.

  3. In Power Query Editor, select Advanced Editor from the ribbon.

This displays the Power Query code that the system autogenerated when you made your selections in the navigator. For example, let's assume you selected the Business Central environment named Production, the company called CRONUS USA, Inc., the API folder called Standard APIs v2.0, and the table called customers. Navigating to the Advanced Editor would show a query similar to this one:

let
  Source = Dynamics365BusinessCentral.ApiContentsWithOptions(null, null, null, null),
  PRODUCTION = Source{[Name="PRODUCTION"]}[Data],
  #"CRONUS USA, Inc." = PRODUCTION{[Name="CRONUS USA, Inc."]}[Data],
  v2.0 = #"CRONUS USA, Inc."{[Name="v2.0"]}[Data],
  customers_table = v2.0{[Name="customers",Signature="table"]}[Data]
in
  customers_table

You can now manually edit this query to make the changes that suite your needs.

Connect with the ApiContentsWithOptions function

In the query above, the function Dynamics365BusinessCentral.ApiContentsWithOptions is responsible for connecting to Business Central and retrieve the data. This function has 4 optional parameters that aren't provided in the default query.

Here's a breakdown of the different parameters:

ParameterExamplesDescription
Environment"Production"This parameter allows you to specify the Business Central environment to connect to. If not specified, the function returns a list of all environments, and you need to select the appropriate environment in the subsequent steps of your Power Query code
Company"CRONUS USA, Inc."This parameter allows you to specify the Business Central company to connect to, inside your selected environment. This parameter is ignored if the Environment parameter isn't specified. If not specified, the function returns a list of all companies in your selected environent (or environments), and you need to select the appropriate company in the subsequent steps of your Power Query code
API category (or API route)"microsoft/runtime/beta", "v2.0"This parameter allows you to specify the API route connect to in Business Central, inside your selected environment and company. This parameter is ignored if the Environment and Company parameters aren't specified. If not specified, the function returns a list of all API categories (also called API routes) in your selected environment/environments and company/companies, and you need to select the appropriate API category in the subsequent steps of your Power Query code
Advanced OptionsThis parameter allows you to specify some advanced options to connect to your Business Central data source. Notice that in the vast majority of cases, the default values are optimized and don't need to be changed. Consult the following section for more information about these parameters.

For example, the query shown above in this section is completely equivalent to the following query:

 let
   Source = Dynamics365BusinessCentral.ApiContentsWithOptions("PRODUCTION", "CRONUS USA, Inc.", "v2.0", null),
   customers_table = Source{[Name="customers",Signature="table"]}[Data]
 in
   customers_table

Advanced: Customize language, timeout, database replica, or page size for your Business Central data source

The Power BI connector for Business Central supports several advanced properties for connecting to a Business Central data source that you can set in your Power Query queries. The following table describes the parameters.

Advanced OptionDescriptionDefaultLearn more at
AcceptLanguageThis parameter allows you to specify preferred languages for responses, ensuring users receive messages and translatable strings in their desired language. It sets the language in which the Business Central API session runs. It influences the language of error messages, formatted values in AL, and other values that depend on language or culture.

This option doesn't select the display language of the Power BI report.
not specifiedAccept-Language HTTP header.
ODataMaxPageSizeThis parameter limits the number of entities per results page, which allows for more flexibility when connecting to large datasets or using complex queries. It sets the maximum number of records to return for each page when calling an API. For example, if your table Customers has 13,000 records and ODataMaxPageSize is set to 5000, Power BI makes 3 API calls to get your customers. The first call gets 5,000 records, the next one gets 5000 more, and the last call gets the remaining 3000. This option can't be higher than the maximum page size enforced by Business Central, which is 20000.

Setting this parameter ensures efficient and responsive data retrieval, leading to faster insights and decision-making. You can't exceed the maximum page size defined on the service.
5000ODataPreferenceHeader.MaxPageSize Property
TimeoutThis parameter defines the maximum duration for a request before cancellation. It sets the timeout for each single API call to Business Central. Increasing this value doesn't extend the OData request timeout enforced by Business Central online, which is 8 minutes (00:08:00).

Setting this parameter helps manage system resources effectively and prevents long-running queries from impacting overall system performance. Users experience minimal delays and interruptions, ensuring a smoother workflow.
00:08:00OData.Feed and Business Central online service limits
UseReadOnlyReplicaThis parameter determines whether requests target the primary database or a read-only replica. Offloading read operations from the primary database can significantly boost performance.

Setting this property leads to faster data retrieval and improved system stability, especially during peak usage times.
true

Configure the advanced options

  1. Follow the steps to view the Power Query code from Power BI Advanced Editor

  2. In Advanced Editor, locate the line that starts with Source =.

    Source = Dynamics365BusinessCentral.ApiContentsWithOptions(null, null, null, null),
  3. In the line, replace the fourth parameter of Dynamics365BusinessCentral.ApiContentsWithOptions with a Power Query record of properties and values you want to set, for example:

    Source = Dynamics365BusinessCentral.ApiContentsWithOptions(null, null, null, [UseReadOnlyReplica = true, Timeout = Duration.From("00:07:00"), ODataMaxPageSize = 10000, AcceptLanguage = "it-it"]),
  4. Select Done to close Advanced Editor.

  5. Select Close & Apply to save the changes and close Power Query Editor.

Troubleshoot Power BI connections

"Expression.Error: The environment 'Production' doesn't exist." error when specifying a Business Central environment

APPLIES TO: Business Central online

When you connect to Business Central online from Power BI, or when you install a Power BI Desktop app from Microsoft Marketplace that uses Business Central data, you might be prompted to input the Business Central environment you want to connect to.

If you get an error similar to "Expression.Error: The environment 'Production' doesn't exist.", follow these steps to troubleshoot:

  1. Make sure you're using the right credentials to access Business Central. These credentials might not be the same credentials you use to access Power BI. How do I change or clear the account I'm currently using to connect to Business Central from Power BI Desktop?
  2. If your environment is an embedded ISV environment, you need to specify the embedded ISV name in parenthesis as part of the environment name. For example, if you want to connect to an environment named Production from the embedded ISV named Fabrikam, you must specify "PRODUCTION (fabrikam)" as environment name.

"Can't insert a record. Current connection intent is Read-Only." error connecting to custom API page

APPLIES TO: Business Central online

By default, reports that use Business Central data connect to a read-only replica of the Business Central database. In rare cases, depending on the API design, you might get an error when you try to connect to and get data from the API. The error looks like this:

Dynamics365BusinessCentral: Request failed: The remote server returned an error: (400) Bad Request. (Can't insert a record. Current connection intent is Read-Only. CorrelationId: [...])".

If you're using a custom API, we recommend you rework the AL code to make sure it doesn't make database modifications when it's just reading data. But in case your scenario requires it, you can configure the connector to use a read-write connection instead.

Enable Your Business Data for Power BI
Business Intelligence
Get Ready for Doing Business
Import Business Data from Other Finance Systems
Set Up Business Central
Finance
Quickstart: Connect to data in Power BI Desktop

Find free e-learning modules for Business Central here