Skip to main content

​
Extra information

System documentation: https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/

​
Connector package documentation

​
Table of Contents

  • 1. Setting up HTTP Client D365 Business Central
    • 1.1 Steps
  • 2. Subscribing to entities from D365 Business Central
    • 2.1 Steps
    • 2.2 General concept
  • 3. Publishing entity to D365 Business Central
    • 3.1 Steps
    • 3.2 General concept

​
1. Setting up HTTP Client D365 Business Central

1.1 Steps
  1. Before we begin please enable the APIs for Dynamics 365 Business Central base on this guide https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/enabling-apis-for-dynamics-nav.
  2. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select D365 Business Central HTTP Client as the HTTP Client.
  3. Fill in the Base URL,Tenant ID, Client ID, Client Secret, and Scopes.
  4. You can optionally enable logging of request to get the log of the authentication.
  5. Press “Grant access to Microsoft D365 Business Central”.
  6. The Key will show up and you can save the HTTP Client for use.
Microsoft Dynamics 365 NAV/Business connector screenshot 1

​
2. Subscribing to Entities from D365 Business Central

2.1 Steps
  1. Go to Connections -> Incoming and create a new incoming configuration and select “D365 Business Central” Subscriber as the subscriber.
  2. Select the module you want to subscribe from D365 Business Central.
  3. Fill in the “Company ID” you want to use on the request.
  4. Add any request parameters needed to subscribe to the entity (optional).
  5. You can optionally add a transformer to transform the request parameters into something you need.
  6. Select the D365 Business Central HTTP Client to use
  7. You can add a pagination feature to allow Alumio to fetch a paginated entity.
2.2 General Concept We follow D365 Business Central documentation on building this connector, so you can easily use the connector based on D365 Business Central API Reference. Module It’s the list of end points you can subscribe from D365 Business Central. Please refer the end points from https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/dynamics-open-api. Company ID It’s the Company ID in D365 Business Central that you want to request to. Request Parameters These are the parameters you can provide to get the needed entity based on D365 Business Central API Reference. Please look at the example below on how to fill Request Parameters field when subscribing “Details of employee”. Microsoft Dynamics 365 NAV/Business connector screenshot 2 The end point in D365 is using oData input, so for the end point /employees({{employee_id}}) we need to provide the ID inside the odata key as an array. Alumio will transform it into /employees(555) Another example is when we want to filter a certain phone number from the end point of “Returns a list of employees”. We can add the filter at the query like Microsoft Dynamics 365 NAV/Business connector screenshot 3
  • Odata is the odata data of the url. For example the (id).
  • Query is defined set of data attached to the end of a url.
    Example: www.url.com?type=true&start=0
D365 Business Central will filter with the field phoneNumber equal 4567. Input Transformer Any transformer’s set here will be executed before the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. HTTP Client It’s the HTTP Client configuration or prototype you will use to access Business Central.

​
3. Publishing entity to D365 Business Central

3.1 Steps
  1. Go to Connections -> Outgoing, create a new outgoing configuration and select “D365 Business Central” Publisher as the publisher.
  2. Select the action that you want the publisher to do with the data.
  3. Select the “D365 Business Central” entity you want the data to be published to.
  4. You can optionally add any query parameters to the request.
  5. You can also optionally add any transformers to transform the data into anything you need before submitting it to D365 Business Central.
  6. Select the HTTP Client to use.
3.2 General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. Action Currently we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method). Entity We support publishing to most D365 Business Central endpoints. Please refer to the entities in Management APIs from D365 Business Central API Reference page. Based on the documentation, some endpoints may need one or more odata parameters. For endpoints that require object as the request payload, please look at the example below. For example, we want to use “Create customerReturnReasons”. You will need to make sure there is a payload key inside the data like Microsoft Dynamics 365 NAV/Business connector screenshot 4 Another example, when we need to use “Update vendorPaymentJournals”. We need to add the ID inside the key odata as an array and make the update data inside the payload key like Microsoft Dynamics 365 NAV/Business connector screenshot 5
  • Odata is the odata data of the url. For example the (id).
  • Query is defined set of data attached to the end of a url.
    Example: www.url.com?type=true&start=0
  • Payload is the data contained within a request.
Company ID It’s the Company ID in D365 Business Central that you want to process. HTTP Client It’s the HTTP Client configuration or prototype you will use to access D365 Business Central.