Zum Inhalt

WebConnector SOAP API

Note

The SOAP interface to Business Central has been deprecated by Microsoft. learn.microsoft.com Deprecated Features. It is therefore recommended to use the rest interface of the WebConnector. REST API

Introduction

Web Connector services are tailored within the framework of Microsoft Dynamics 365 Business Central, leveraging the SOAP API. A subset of these services adheres to the standard Create, Read, Update, and Delete (CRUD) pattern, providing a comprehensive means to govern data across Business Central with simple configurations. Nevertheless, there are instances where customizing the inherent Business Central web services, particularly through the SOAP API, becomes not just preferable but essential. This strategic customization leads to refined and user-friendly workflows. In the subsequent sections, we present detailed message structures, practical examples, and fundamental accessibility features that facilitate seamless integration and operation with the WebConnector SOAP API.

Determine services and schema of your Business Central environment

The examples of the SOAP Api and the SoapUI project described in this documentation are not be seen as a complete specification and may not contain all available fields. It therefore makes sense to determine the existing services and schemas based on your own environment. Microsoft has documented the best way to do this here

Performance Hints ⚡

Response time is primarily depending on the Business Central hosting system. For this it's mandatory to know the framework conditions of the web connector interface. Despite there can be various factors that affect system performance we recommend to generally consider the following points: Real time price and item availability calculations should be done for 50 positions max (up to 150 in exceptional cases).

  • For pure data queries response data should not overexceed 500 results as this can cause time outs. Use data paging instead.
  • Cache data and raise item availability the moment data is needed at best. Weigh this with the performance of other processes.
  • Filter fields with keys set up in Business Central only. Do not filter text fields that do not have any keys. (i.e. "Smith" in contact data is very insufficient)

General Services

These services provide subsidiary data for interacting with Dynamics Business Central. This section shows how to get, update or create these data from or in the ERP.