Needing to automate repetitive, high-volume data processes, while improving accuracy and efficiency? Recurring Integrations API in Dynamics 365 is the answer!
With recurring integrations, you can send large volumes of sales invoices from Dynamics 365 Finance & Operations (D365 F&O) to an external system, send employee information to an external payroll system, or automate the import of regulatory data from government systems to ensure ongoing compliance.
In a previous OneByte article, we outlined the steps for asynchronous integration API for large volumes of data management. In part 2, we will cover recurring integrations API to manage data projects that require imports and exports from external systems.
There are two types of asynchronous integration application programming interface (API):
- Data Management Package API (covered in part 1, and ideal when you don’t need real-time data updates and want to avoid system slowdowns)
- Recurring Integration API
Recurring integration does the following:
- Builds on data entities and the data management framework
- Facilitates document and file exchanges between finance operations and third-party applications or services. Supports several document formats, source mapping, Extensible Stylesheet Language Transformations (XSLT), and filters
- Uses secure REST APIs and authorization mechanisms for data exchange with integration systems. The following points should be considered when choosing Recurring Integrations API.
- Used when exchanging large volumes of data between D365 F&O and third-party applications.
- Can be used when scheduling has to be performed in finance and operations apps.
| Decision | Data Management Package API | Recurring integrations API |
| Scheduling | Scheduling outside finance and operations apps | Scheduling in finance and operations apps |
| Format | Only data packages | Files and data packages |
| Transformation | Transformations that are external to the system | Support for Extensible Stylesheet Language Transformations (XSLT) if the data file is in XML format |
| Supported Protocols | REST | Simple Object Access Protocol (SOAP) and Representational State Transfer (REST) |
| Service Type | Open Data Protocol (OData) action | Custom service |
Authorization
The data management framework’s API uses OAuth 2.0 to authorize access. The API must be called by using a valid OAuth access token.
Recurring Integration – Import
Create the import project in Microsoft Dynamics 365 Finance and Operations.
Click on Create Recurring Data Job and enter details. Note the id.
Set processing recurrence.
Enable the batch job.
This batch job can be seen under System Administration à Data Management IT à Recurring data jobs.
Import (enqueue) – The third-party app has requested to be added to queue before processing starts in D365 F&O. This action is used to add to the queue and initiate an import file or data package.
Get Status – is used to retrieve the status of the API.
Check to ensure that a new record is created under Inbound messages in Finance and Operations.
Recurring Integration – Export
Create the export project in Finance and Operations and select create recurring data job.
Export (dequeue) – The third-party app has requested data from D365 F&O and has added to the queue for the data to be exported. This action is used to initiate export of the data.
Other useful APIs
Job Status – GET Method
This API will provide information regarding the execution details of the job.
{{FOBaseURL}}/api/connector/JobStatus/<ActivityId>?JobId=<MessageId>
Execution Errors – POST Method
This API will provide information regarding the execution errors for the job.
{{FOBaseURL}}/data/DataManagementDefinitionGroups/Microsoft.Dynamics.DataEntities.GetExecutionErrors
Request Body
{
”executionId”: “<Execution Id>”
}
With the recurring integrations API set up, you’ll be able manage your data projects easily and retrieve information quickly from external systems for a seamless technology ecosystem of data.
About the expert
 |
Chirag Sethi, Senior Consultant, OnActuate
Chirag is a D365F&Sc Microsoft Dynamics certified technical lead with 13 years of experience in application designing, development, integration of D365 F&Sc and D365 BC and NAV implementations. He has led teams in multiple E2E implementations in both D365 F&Sc and NAV. He has assisted businesses in addressing their requirements, providing solution/functional design documents, guiding development, testing, deployment teams in delivering final solutions. Chirag’s certifications include the MB-700 Microsoft Exam for Microsoft Dynamics 365: Finance and Operations Solution Architect and MB-800 Microsoft exam for Microsoft Dynamics 365 Business Central Functional Consultants. |
The “OneByte” blog series are technical how-to articles by OnActuate’s expert consultants covering Microsoft Business Applications (Microsoft Dynamics, Power Platform) and related technologies. Have a topic you’d like to learn more about? Email us at info@onactuate.com!
