Integration with Finance and Operations - From Basics (Part 1)

-

Introduction

Finance and Operations provides two major ways to interact with tables (or data entities) for external system using APIs; namely Custom Services and Data Entities.

Data entities in D365 Finance and Operations simplify data management by grouping data from multiple tables.
They make it easier to import, export, and integrate data with other systems.

Custom services in D365 Finance and Operations allow developers to create web services for specific business needs.
They enable external systems to interact with D365 F&O by exposing custom logic and operations.
This helps in integrating and automating processes with other applications.

Feature Data Entities Custom Services
Purpose  Simplify data management tasks like import, export, and integration.  Expose custom business logic and operations as web services.
Functionality  Provide structured access to data from multiple tables in a unified format.  Allow external systems to perform actions or retrieve data via API calls.
Usage  Used for bulk data operations, data migration, and integration with external systems.  Used for real-time integration, extending functionality, and custom business process automation.
Typical Use Cases  Data import/export, data synchronization, and data migration.  Integrating with external applications, custom business processes, and real-time data access.
Data Handling  Focuses on data in bulk.  Focuses on specific operations or business logic.

Pre-requisites

  • A Finance and Operations Environment
  • Postman connected to FnO Enviroment (If you want to do this follow the blog here)

References

Data Entities Overview - Finance and Operations

Build and consume data entities - Finance and Operations

Exposing an X++ class as a Data Contract

Configuration

Here, to understand creation of APIs in either cases, we'll expose the same table using both Data Entities and Custom Services.

Data Entity:

Right click on the project and click on "Add" and then "New Item"

Click on Finance and Operations > Dynamic 365 Items > Data Model and then select "Data Entity"


Select the table that you want to expose in the "Primary Data Source" field, appropirate "Entity Category", "Public Entity Name" and "Public Entity Set Name" (which is what the endpoint will be), and the Staging Table name.


Select the necessary fields from the primary data source.


You can add related tables by clicking on the small arrow next to the table name, which displays the list of all associated tables.


Then you can select the relevant fields from the associated tables.




Once done, you'll get one data entity, two security privileges and one staging table created.


If you want to add new data sources then you can right click on the Primary Data Source's "Data Sources" tab and add new data source.


You can drag fields from any of the data sources into the "Fields" section of the data entity to make them available on the API.

Calling the Data Entity 

You can call <base url>/data url to get a list of all the data entities available in the system.



From here, if I call a "GET" request on my Data Entity (the "Public Collection Name" property of the data entity, which we set in the Data Entity wizard), I'll get the following response.
Please note that this "Public Collection Name" is case sensitive.


Now, if I need to create a "Customer" record then I can simply pass the same keys into a "POST" request.


And we can see the same in FnO.


If we want to update  a record then we make the PUT request with the syntax - 

{{base_url}}/data/TestCustomers(dataAreaId='<Company Name>',CustomerId='<Customer Id>')

It will include all the Entity Keys defined on the Data Entity as we only have one field then we are simply passing that.
Passing it without the DataAreaId will throw errors.


You can delete the record using the same syntax but with the "Delete" request.

Conclusion:

Thus we saw how to create APIs using Data Entities in Finance and Operations.
We'll see how to create APIs using Custom Services in the next blog.

Comments

Post a Comment

Popular posts from this blog

Using Notifications in Business Central via AL

-
Image
Introduction Notifications in Business Central are alerts that appears in the Notification bar based on User actions. Notifications stack up from top to bottom, lasting until the user dismisses them, including those from sub-pages.  Validation errors are prioritized and shown before other notifications. We can use this to alert the user regarding something without taking all the user's notification towards it, in the way messages or errors do. They also have the option to allow Users to make a corrective action by embedding the action button directly into the notification. Let's see how it works. Source Code Pre-requisites Business Central OnPrem/Cloud. References Notification - Business Central Docs Configuration Here, for an example, I've created one simple page which takes two inputs. 1. The message that is to be shown in the notification. 2. The message to be shown after the User clicks on the action embedded in the notification.     And I have two actions which I'l...
Read more

Actionable Error Messages in Business Central

-
Image
Introduction Error handling is an important concept in every technical field.  It helps programs deal with unexpected problems and mistakes smoothly.  It makes sure software works reliably and doesn't crash unexpectedly.  Error handling also helps developers find and fix issues quickly, making the software better for users. Plus, it gives users clear messages when something goes wrong, making their experience smoother. It shows that the team has considered the scenario and has measures in place for it indicating a well designed solution. Microsoft has an amazing document which lists the things to keep in mind for writing resilient code. In Business Central, we have try functions to handle errors and error function to show those errors to the Users.  In this blog, we'll learn how we can enhance the error messages so that the Users can resolve the errors themselves or at the very least we can point them towards where the error is. Pre-requisites Business Central OnPrem...
Read more

Configure Gmail SMTP service in Business Central without "Allow Less Secure" setting

-
Image
 Introduction Business Central has great email features like sending email, editing it with Rich Text, adding attachments, etc, but to send emails, you'll need to connect it with services like Outlook or Gmail. There is no outlook side configuration that is to be done if you are using Microsoft Outlook however if you are using Google's Gmail then there's a litte change that has happened on the configuration end. Starting May, 2022, Google has removed the "Allow Less Secure Apps" settings from the Google Accounts, which was essential is using Gmail to send emails from Business Central. However, to replace that we have "App Passwords" which we can use instead. Also, just something to keep in mind, Google is going to remove this from the "Google Workspace" accounts as well by Sept, 2024 so it would be wise for you to migrate your configurations to use app passwords. Reference 1.  How to Setup Email in Business Central 2.  Google Support - Less sec...
Read more