Skip to content

Knowledge Base

Business Process Automation Platform

Microsoft Dynamics 365 Business Central Connector v1.1

Table of Contents

What is the Microsoft Dynamics 365 Business Central Connector v1.1

Use the Microsoft Dynamics 365 Business Central Connector to send and retrieve data between BPA Platform and your Dynamics 365 Business Central installation. This allows for data to be synchronised between Dynamics 365 Business Central and third-party systems that it does not normally connect with.

All communication uses XML; BPA Platform recordsets cannot be used as data inputs unless converted to XML first (using the Convert Recordset to XML tool, for example). You use the Connector to map BPA Platform data to Dynamics 365 Business Central objects and operations. Standard operations of READ, ADD, UPDATE, and DELETE are supported as well as custom operations for specific objects. All objects available from the Dynamics 365 Business Central API are supported, including codeunits, pages, and queries.

XML responses received back from the Dynamics 365 Business Central API can be saved and used by other BPA Platform tools for further processing

The Microsoft Dynamics 365 Business Central Connector Tool Pack

The tool pack consists of:

  • Microsoft Dynamics 365 Business Central Agent — The Agent communicates directly with the Dynamics 365 Business Central API. It can be installed on any computer that has access to both the BPA Platform server and the Dynamics 365 Business Central company database, local to the BPA Platform server, or the onpremise server instance hosting the Dynamics 365 Business Central company database
  • Microsoft Dynamics 365 Business Central Connector — The Connector communicates with the Microsoft Dynamics 365 Business Central Agent instead of interacting directly with the Dynamics 365 Business Central company database. It must be installed on the BPA Platform server and any remote BPA Platform client machines which run Microsoft Dynamics 365 Business Central Connector tasks.

System Requirements

The following prerequisite software must be in place before installing the Microsoft Dynamics 365 Business Central Connector.

Minimum BPA Platform Version

The Microsoft Dynamics 365 Business Central Connector requires BPA Platform 2020 Update 1 or above.

Minimum Dynamics 365 Business Central Version

The Microsoft Dynamics 365 Business Central Connector supports Dynamics 365 Business Central 2018 or higher.

Microsoft Dynamics 365 Business Central Connector Video Overview

White Paper - Microsoft Dynamics 365 Business Central Connector 1.1

White Paper - Microsoft Dynamics 365 Business Central Connector 1.1

The Microsoft Dynamics 365 Business Central Connector v1.1 Technical Overview introduces you to the tool. Installed as an add-on to BPA Platform, this tool provides direct communication between BPA Platform and Dynamics 365 Business Central.

Download White Paper

Microsoft Dynamics 365 Business Central Connector Architecture

The following diagrams provide example architectural layouts of the Connector with Dynamics 365 Business Central deployed on-premise or in the cloud. Whether Dynamics 365 Business Central has been deployed in the cloud or onpremises, you can choose to locate the Microsoft Dynamics 365 Business Central Agent on any machine accessible by the BPA Platform server or on the server itself.

Cloud Architecture

Example architecture:

Dynamics 365 Business Central connector cloud based

On-Premise Architecture

Example architecture:

Dynamics 365 Business Central connector on-premises

Download Whitepaper

Microsoft Dynamics 365 Business Central Connector – Working with Other Tools

The Microsoft Dynamics 365 Business Central Connector tool can directly interact with the following tools:

Consuming from Other Tools

The Microsoft Dynamics 365 Business Central Connector can consume output from the following tools:

IconTool NameTool Category
Microsoft Dynamics 365 Business Central Connector v1.1Import XML DocumentInput
Microsoft Dynamics 365 Business Central Connector v1.1Retrieve Text MessageInput
Microsoft Dynamics 365 Business Central Connector v1.1Convert Recordset to XMLFormat
Microsoft Dynamics 365 Business Central Connector v1.1Transform DataFormat
Microsoft Dynamics 365 Business Central Connector v1.1Call Task ToolExecute
Microsoft Dynamics 365 Business Central Connector v1.1Applications Platform ConnectorData Connectors
Dynamics 365 Business Central connectorMicrosoft Dynamics 365 Business Central ConnectorData Connectors

Objects Consumed

The Microsoft Dynamics 365 Business Central Connector consumes the following objects exposed by other steps:

  • XML — XML data from any BPA Platform tool capable of exposing such data (see above)

Exposing to Other Tools

The following tools can directly consume output form the Microsoft Dynamics 365 Business Central Connector:

IconTool NameTool Category
Microsoft Dynamics 365 Business Central Connector v1.1Retrieve Text MessageInput
Convert XML to Recordset ToolConvert XML to RecordsetFormat
Run Microsoft Reporting Services ToolRun Microsoft Reporting ServicesFormat
Microsoft Dynamics 365 Business Central Connector v1.1Transform DataFormat
Microsoft Dynamics 365 Business Central Connector v1.1Save FileOutput
Microsoft Dynamics 365 Business Central Connector v1.1Call TaskExecute
Microsoft Dynamics 365 Business Central Connector v1.1Applications Platform ConnectorData Connectors
Microsoft Dynamics 365 Business Central Connector v1.1Web Service ConnectorData Connectors
Dynamics 365 Business Central connectorMicrosoft Dynamics 365 Business Central ConnectorData Connectors

Objects Exposed

The Microsoft Dynamics 365 Business Central Connector tool outputs the following objects which can be consumed by other tools:

Microsoft Dynamics 365 Business Central Connector v1.1

  • InputData
    This document contains the input XML received by the Microsoft Dynamics 365 Business Central Connector
    tool. It is only available if a task step has been selected as the Data Source.
  • OutputData
    The OutputData object contains two sub-objects:

    • XmlString — This is the XML document produced by the tool, containing data returned from Dynamics 365 Business Central for all operations. Also included are the key fields for the mapped elements affected by the used operation — for example, if using an ADD operation, the key fields for the top-level object instances that are created are returned — and a SupplementaryReference field for task auditing purposes. The mapped fields in the Mapping tab (see About the Mapping Tab) define the structure of this XML document.
    • XmlSchema — This contains the output schema in XSD format.
  • ErrorData
    The ErrorData object also contains two sub-objects:

    • XmlString — This contains any error data reported by Dynamics 365 Business Central
      <Error> — All errors are created as an <Error> node, with the following sub-nodes:
      <Object /> — The name of the requested object
      <CODE /> — The error code returned by Dynamics 365 Business Central
      <MESSAGE /> — The corresponding error message
      <EXTENDEDINFO /> — A string containing additional information about the error
      <INPUTDATA /> — The header input data (excluding child nodes) mapped for the object, plus all data contained in SupplementaryReference
      </Error>
    • XmlSchema — This contains the output schema in XSD format.
  • Step Properties
    Standard step properties are also available allowing you to use statistical data of the Microsoft Dynamics 365 Business Central Connector step.

Where Can the XML Output be Used?

The incoming XML is translated into the XML format for the object and operation selected in the configuration. The data for the linked fields is brought across into the output XML — only those fields that are linked are brought across. The XML is passed to the Connector, which then:

  • Processes the data
  • Performs the operation requested
  • Recieves an XML document containing the response

Both the OutputData and ErrorData documents can be directly used by succeeding task steps that can consume XML data, as part of an application integration or synchronisation process. To use the documents in a non-XML consuming tool, use a Convert XML to Recordset step first to create a recordset copy of the XML data.

The XML documents are also available as consumable objects from the BPA Platform Browser (XmlString). When used in a task step, such as Format as Text or Save File, this exposes the actual XML string.

Error Handling

Errors are written to the BPA Platform Event Log (Tasks toolbar > Event Log ). You define how errors are
handled in the Options tab of the tool (see About the Options Tab).

Reasons for the errors could include:

  • Web service connection errors
  • User privilege errors
  • Errors from the API
  • Warnings and messages from the API

Download Whitepaper

Microsoft Dynamics 365 Business Central Connector – Global Configuration

The global configuration for the Microsoft Dynamics 365 Business Central Connector is used to create connections to the Dynamics 365 Business Central Agent.

You open this interface from the resources tree — expand System > Tools > Data Connectors and double-click Microsoft Dynamics 365 Business Central Connector in the items list.

Microsoft Dynamics 365 Business Central Connector v1.1

When a connection is created, the available objects and fields of your Dynamics 365 Business Central installation are retrieved.

Click Add to create a connection to Dynamics 365 Business Central.

Using Extended Logging

Enabling this option exposes the XML parsed between the Connector and Dynamics 365 Business Central.

Without extended logging, the Event Log only contains start and end of transaction messages, plus any error messages encountered at runtime.

You can view the extended log in the BPA Platform Event Log (Tasks toolbar > Event Log).

About the General Node

You must name each connection you create to a Dynamics 365 Business Central database.

Microsoft Dynamics 365 Business Central Connector v1.1

Provide a unique Connection Name. If your Dynamics 365 Business Central installation makes use of a number of separate databases, it is recommended you add such details to the name. This is useful later when creating task steps.

Updating Objects and Operations

Enabling Update Objects and Operations allows the Dynamics 365 Business Central schema in BPA Platform to be refreshed every time an update is made in the API itself.

Should you also upgrade Dynamics 365 Business Central to a newer, compatible version, all related schemas within BPA Platform must be refreshed. To do this, select this option and save the changes. You must repeat this for each existing connection you have defined.

About the Agent Connection Node

The Agent Connection node provides a brief summary of any configured Dynamics 365 Business Central Agents.

About the General Node

Use the General node to determine which Dynamics 365 Business Central Agent this global connection is for.

Microsoft Dynamics 365 Business Central Connector v1.1

In Connection Agent Server, enter the IP address or hostname of the machine where the Dynamics 365 Business Central Agent is installed. If the Agent is on the same machine as this instance of BPA Platform, enable Use Localhost.

By default, the connection is over HTTP and port 4212. If the Agent has been set up to use HTTPS or a different port, enable Show Advanced Options.

Use Test Connection to ensure the Microsoft Dynamics 365 Business Central Connector can communicate to the Agent successfully.

About the Advanced Node

Use the Advanced node to change the communication defaults for the Dynamics 365 Business Central Agent this global connection is for. This node is hidden until Show Advanced Options in the Agent Connection > General node is selected.

Microsoft Dynamics 365 Business Central Connector v1.1

By default, the connection is over HTTP and port 4212.

To change the port used to communicate over, enable Set Custom Port Number and enter the required number in the box provided.

To use HTTPS communication, enable Use HTTPS.

About the Business Central Connection Node

The Business Central Connection node provides a brief summary of the configured connection to Dynamics 365 Business Central.

About the Deployment Type Node

Use the Deployment Type node to determine whether this connection is for Dynamics 365 Business Central in the Cloud or On-Premise.

Microsoft Dynamics 365 Business Central Connector v1.1

About the Cloud Connection Node

The Cloud Connection node provides a brief summary of the configured connection Dynamics 365 Business Central in the cloud.

About the General Node

The General tab is only available when Cloud is selected as the Deployment Type.

Microsoft Dynamics 365 Business Central Connector v1.1

For standard cloud deployments, click Authorise and enter the database user credentials required to access the company database for this connection.

When deploying Dynamics 365 Business Central to the cloud, you can choose to create separate environments, for example, for production and “live” purposes (for more information, refer to your Microsoft documentation). To connect to such an environment, select Specify Environment and enter the environment name in the box below — Connection URL shows the URL the Agent uses to connect to this environment and API. Then click Authorise and enter the database user credentials required to access the company database for this connection.

Use Test Connection to ensure the Dynamics 365 Business Central Agent can connect to the database successfully.

Use Log Out to disconnect the Agent from the API.

About the On-Premise Connection Node

The On-Premise Connection node provides a brief summary of the configured connection Dynamics 365 Business Central when on-premise.

About the General Node

The General tab is only available when On-Premise is selected in the Deployment Type node.

Microsoft Dynamics 365 Business Central Connector v1.1

Use the parameters in this node to create a connection to the Dynamics 365 Business Central server instance hosting the company database you want to run tasks against.

Specifying the Server Instance

Provide the Hostname or IP address of the machine hosting the Dynamics 365 Business Central client.

In Server Instance, enter the configured name for this instance.

By default, the connection is over HTTP and port 7048. If the server instance has been set up to use HTTPS or a different port, enable Show Advanced Options. A new node appears under On-Premise Connection — Advanced.

The URL to the Dynamics 365 Business Central on-premise API is automatically built from the configuration you enter above — see underneath Server Instance.

Specifying Database Credentials

You must provide the Username and Password allocated to the Dynamics 365 Business Central Agent. They must allow full access to the company database. Domain credentials can be used if required.

Use Test Connection to ensure the Dynamics 365 Business Central Agent can connect to the database successfully.

About the Advanced Node

Use the Advanced node to change the communication defaults to the on-premise API. This node is hidden until enable Show Advanced Options in the On-Premise Connection > General node is selected.

Microsoft Dynamics 365 Business Central Connector v1.1

By default, the connection is over HTTP and port 7048.

To change the port used to communicate over, enable Set Custom Port Number and enter the required number in the box provided.

To use HTTPS communication, enable Use HTTPS.

About the Select Company Node

Use the Select Company node to choose the Dynamics 365 Business Central database this Agent is specifically monitoring.

Microsoft Dynamics 365 Business Central Connector v1.1

If your Dynamics 365 Business Central Agent is installed on a machine hosting more than one company database, you must create a separate global connection for each database you want tasks to access.

Download Whitepaper

Microsoft Dynamics 365 Business Central Connector – Step Configuration

When creating new tasks, the Microsoft Dynamics 365 Business Central Connector tool is located under Data Connectors of the Task Browser.

To add a new Microsoft Dynamics 365 Business Central Connector step to an existing task, do the following:
From the relevant task, either:

  • Click and drag the Microsoft Dynamics 365 Business Central Connector icon from the Task Browser to the task Design area.
  • From the task’s Design tab, right-click on empty space and select New > Data Connectors > Microsoft Dynamics 365 Business Central Connector.

For a detailed description of how to create new tasks, refer to the product help.

About the General Tab

Use the General tab to choose the BPA Platform data source to be mapped to the Dynamics 365 Business Central objects. The data source must be in XML form. To map BPA Platform recordsets, configure a Convert Recordset to XML or Transform Data step in the task before the Microsoft Dynamics 365 Business Central Connector step, then select this as Task step (see below).

Microsoft Dynamics 365 Business Central Connector v1.1

Provide a meaningful Name and Description for this step.

Data source can either be:

  • No data source — If you don’t make use of a dedicated XML input source, select this option to use BPA Platform variables in place of the XML or recordset objects’ fields.
    For example, you can extract various bits of information from an email and store them in BPA Platform variables. The variables are mapped to Dynamics 365 Business Central operational objects and fields to store in the database for later use.
  • Task step — The data source can be set to an available BPA Platform XML data source.
    Only those steps that are capable of natively exposing an XML document at runtime are listed. This may be another Microsoft Dynamics 365 Business Central Connector step, or a tool such as Convert Recordset to XML or Transform Data.
  • Custom schema — An XML schema defines the structure of the parsed XML: what tags are present, and the nesting of the tags. You Define the schema of the XML that is used as the input data source for this step. The Microsoft Dynamics 365 Business Central Connector tool uses the industry standard XSD format. Any XML processed by this step must conform to this schema else an error will be reported. If the XSD schema is available, either import it into the Custom Schema Configuration (use the Import XSD/XML File button), or copy and paste it into the configuration box.
    Microsoft Dynamics 365 Business Central Connector v1.1
    If the XSD schema is not available, you can import an example of the runtime XML (Import XSD/XML File), or copy and paste it into the configuration box. Use the Parse button to create the schema.

    • Input source variable — As well as defining the schema, specify the BPA Platform variable that contains the XML data at runtime.

About the Connection Tab

You must specify the Dynamics 365 Business Central connection (see Global Configuration) this task step must use.

Microsoft Dynamics 365 Business Central Connector v1.1

All connections created in the global configuration window are presented here.

Alternatively, you can use a BPA Platform variable or formula to create a dynamic connection, where the connection used is determined by runtime circumstances. At runtime, the contents of the variable must match the name of one of the global connections — this is case-sensitive. To do this, you must install a Microsoft Dynamics 365 Business Central Agent for each individual company database you want to monitor (even though access is through the same API). All Agents must be registered with the BPA Platform server and a separate global connection created for each Agent.

About the Mapping Tab

Use the Mapping tab to define links between the data source XML (see About the General Tab) and those required by Dynamics 365 Business Central. This defines how, at runtime, the incoming XML is to be translated into the XML required for the relevant object and operation.

Microsoft Dynamics 365 Business Central Connector v1.1

The Object drop-down shows the Dynamics 365 Business Central objects. The Operations drop-down shows the operations available for the selected Object
Further down, the left-hand XML tree structure shows those data source fields available for mapping . The right-hand XML tree structure displays those input fields for the selected Object and Operation.

Creating Mappings

Create links by dragging and dropping a data source field (left) onto its corresponding Microsoft Dynamics 365 Business Central Connector input field (right). Only linked fields are used in the output XML.

BPA Platform formulas and variables can be included in the source data even when using a Task step or Custom schema — drag them from the BPA Platform Browser to the data source’s XML; these can then be linked to the relevant input fields. BPA Platform recordsets must first be converted to XML using either the Convert Recordset to XML or Transform Data tool before they can be used here.

Each operation has an additional field, SupplementaryReference, which allows for traceability when transferring data from one place to another. When mapped, the data resides locally at runtime. It is added to the output, and creates a record for reference purposes only — you can choose to map any field to SupplementaryReference to assist with checking where the data originated from or at what time the data transfer occurred, for example.

The Microsoft Dynamics 365 Business Central Connector tool uses eXtensible Stylesheet Language Transformations (XSLT) to translate the received XML. The Advanced Translations (XSLT) tab shows the XSLT generated for the links created for the object and operation. Use Enable Free Type Mode to directly edit the XSLT — this is particularly useful when translating a non-standard requirement.

Refreshing the Dynamics 365 Business Central Schema

If new fields, objects, and operations have been added to your Dynamics 365 Business Central instance after this task step was originally created, use Schema Refresh to make the latest API metadata available for use.

Using Filters with Objects

When using SEARCH operations, you can make use of filters to limit the data involved. At runtime, these fields are treated as “where clauses”. Available filter conditions are:

FilterDescription
=Equal to
<>Not equal to
<Less than
>Greater than
<=Less than or equal to
>=More than or equal to
STARTSWITHStarts with
ENDSWITHEnds with
CONTAINS

The presence of multiple filter fields implies that all conditions must be met.

Nominated fields must be mapped to be included in the output XML. You add filter conditions by right-clicking the output XML field, and selecting Set as Filter. By default, all filters are set to “equal to”. To change the filter condition, right-click the field again, and select Set Filter Condition. Change the filter condition as required.

Microsoft Dynamics 365 Business Central Connector v1.1

Supported Objects

The following objects and operations are supported in this release of the Microsoft Dynamics 365 Business Central Connector:

Object Operations
 READADDUPDATEDELETESEARCHAdditional Supported
AccountID    No mandatory fields for the SEARCH operation. 
Aged Accounts PayableVendorID    No mandatory fields for the SEARCH operation. 
Aged Accounts ReceivableCustomerID    No mandatory fields for the SEARCH operation. 
AttachmentsID ParentIDNo mandatory fields for the ADD operation; the keys are auto-generated if not mapped.ID ParentIDID ParentIDNo mandatory fields for the SEARCH operation. 
Balance SheetLineNumber    No mandatory fields for the SEARCH operation. 
Bank AccountIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.IDIDNo mandatory fields for the SEARCH operation. 
Cash Flow StatementLineNumber    No mandatory fields for the SEARCH operation. 
Company InformationID ID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.  No mandatory fields for the SEARCH operation. 
Country RegionIDCodeIDIDNo mandatory fields for the SEARCH operation. 
CurrencyIDCodeIDIDNo mandatory fields for the SEARCH operation. 
Customer Financial DetailID    No mandatory fields for the SEARCH operation. 
Customer Payment JournalIDCodeIDIDNo mandatory fields for the SEARCH operation. 
Customer PaymentIDAlthough this operation is available, you cannot add a Customer Payment record in isolation. It must be done as part of the new Customer Payment Journal record or as an update to Customer Payment Journal.IDIDNo mandatory fields for the SEARCH operation. 
Customer SaleCustomerID CustomerNumber Name   No mandatory fields for the SEARCH operation. 
CustomerIDDisplayNameID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.IDNo mandatory fields for the SEARCH operation. 
Default DimensionsDimensionID ParentIDNo mandatory fields for the ADD operation; the keys are auto-generated if not mapped. DimensionID ParentIDDimensionID ParentIDNo mandatory fields for the SEARCH operation. 
Dimension Line ID ParentID No mandatory fields for the ADD operation; the keys are auto-generated if not mapped. ID ParentID ID ParentID No mandatory fields for the SEARCH operation. 
Dimension ValueID    No mandatory fields for the SEARCH operation. 
DimensionID    No mandatory fields for the SEARCH operation. 
EmployeeIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.ID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.IDNo mandatory fields for the SEARCH operation. 
General Ledger EntryID   No mandatory fields for the SEARCH operation. 
General Ledger Entry AttachmentsGeneralLedger EntryNumber IDNo mandatory fields for the ADD operation; the keys are auto-generated if not mapped.GeneralLedger EntryNumber IDGeneralLedger EntryNumber IDNo mandatory fields for the SEARCH operation. 
Income StatementLineNumber    No mandatory fields for the SEARCH operation. 
Item CategoryID CodeIDIDNo mandatory fields for the SEARCH operation. 
ItemIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.IDIDNo mandatory fields for the SEARCH operation. 
Journal LineIDAlthough this operation is available, you cannot add a Journal Line record in isolation. It must be done as part of the new Journal record or as an update to Journal.IDIDNo mandatory fields for the SEARCH operation. 
JournalIDCodeIDIDNo mandatory fields for the SEARCH operation.POST – ID
Payment MethodIDCodeIDIDNo mandatory fields for the SEARCH operation. 
Payment TermIDCodeIDIDNo mandatory fields for the SEARCH operation. 
PDF DocumentID   No mandatory fields for the SEARCH operation. 
PictureID IDID No mandatory fields for the SEARCH operation. 
ProjectIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.IDIDNo mandatory fields for the SEARCH operation.
Purchase Invoice LineIDAlthough this operation is available, you cannot add a Purchase Invoice Line record in isolation. It must be done as part of the new Purchase Invoice record or as an update to Purchase Invoice.IDIDNo mandatory fields for the SEARCH operation. 
Purchase InvoiceIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.ID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.IDNo mandatory fields for the SEARCH operation.POST ID
Retained Earning StatementLineNumber   No mandatory fields for the SEARCH operation. 
Sales Credit Memo LineIDAlthough this operation is available, you cannot add a Sales Credit Memo Line record in isolation. It must be done as part of the new Sales Credit Memo record or as an update to Sales Credit Memo.IDIDNo mandatory fields for the SEARCH operation. 
Sales Credit MemoID NOTE: The child object Pdf Document is not returned unless a POST operation has been performed for the Sales Credit Memo record which includes the PDF Document.No mandatory fields for the ADD operation; the key is auto- generated if not mapped.ID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.IDNo mandatory fields for the SEARCH operation.CANCEL AND SENDID CANCELID POST AND SENDID POSTID SENDID
Sales Invoice LineIDAlthough this operation is available, you cannot add a Sale Invoice Lines record in isolation. It must be done as part of the new Sales Invoice record or as an update to Sales Invoice.IDIDNo mandatory fields for the SEARCH operation. 
Sales InvoiceIDNo mandatory fields for the ADD operation; the key is auto- generated if not mappedID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.IDNo mandatory fields for the SEARCH operation.CANCEL AND SENDID CANCELID POST AND SENDID POSTID SENDID MAKE CORRECTIVE CREDIT MEMOID
Sales Order LineIDAlthough this operation is available, you cannot add a Sales Order Line record in isolation. It must be done as part of the new Sales Order record or as an update to Sales Order.IDIDNo mandatory fields for the SEARCH operation. 
Sales OrderIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.ID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.IDNo mandatory fields for the SEARCH operation.SHIP AND INVOICEID
Sales Quote LineIDAlthough this operation is available, you cannot add a Sales Quote Line record in isolation. It must be done as part of the new Sales Quote record or as an update to Sales Quote.IDIDNo mandatory fields for the SEARCH operation. 
Sales QuoteIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.ID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.IDNo mandatory fields for the SEARCH operation.MAKE INVOICEID SENDID MAKE ORDERID
Shipment MethodIDCodeIDIDNo mandatory fields for the SEARCH operation. 
Tax AreaID  No mandatory fields for the ADD operation; the key is auto- generated if not mapped. ID ID No mandatory fields for the SEARCH operation. 
Tax GroupIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.IDIDNo mandatory fields for the SEARCH operation. 
Time Registration EntryIDNo mandatory fields for the ADD operation; the key is auto- generated if not mapped.IDIDNo mandatory fields for the SEARCH operation. 
Trial BalanceNumber   No mandatory fields for the SEARCH operation.  
Unit of MeasureID Code ID ID No mandatory fields for the SEARCH operation. 
Vendor PurchaseName VendorID VendorNumber   No mandatory fields for the SEARCH operation. 
VendorIDNo mandatory fields for the ADD operation; the key is auto- generated if not mappedID NOTE: If updating the address for a record, you must send through all lines of the address not just the affected line. Sending a partial address may cause the address to be deleted, leaving only the updated lines.ID No mandatory fields for the SEARCH operation. 

A Note About Updating Child Objects From Parent Objects

If performing an UPDATE on an object that has child objects where you are updating parent-level and child-level fields, how you map the child-level fields determines whether a new child record is added or an existing child record updated:

  • If a child object has all &lsqb;Key&rsqb; fields mapped, this is treated as an UPDATE operation — The mapped keys are used to find the relevant record.
  • If a child-level &lsqb;Key&rsqb; field is not mapped but a child-level field is, this is treated as an ADD operation — A new child record is added with the relevant keys auto-generated.
    For example, this mapping adds a new Picture child record against the mapped Employee ID.
  • If a child object has more than one &lsqb;Key&rsqb; field but only one is mapped, again this is treated as an ADD operation — A new child record is added with the unmapped keys auto-generated.
    For example, the child object, DefaultDimensions, has two &lsqb;Key&rsqb; fields but only one is mapped. For this scenario, a new DefaultDimensions record is added with the ParentID being auto-generated.
  • Some objects have more than one child objects. Those child objects that are not involved in the mapping are not affected by the UPDATE operation at task runtime. For example, the Employee object has three child objects: Picture, DefaultDimensions, and TimeRegistrationEntries. This mapping does not affect any existing child records for DefaultDimensions or TimeRegistrationEntries.

The following table indicates those objects with child-level objects and their &lsqb;Key&rsqb; fields:

ObjectChild Object&lsqb;Key&rsqb; Field
Customer Payment JournalCustomerPaymentsID
CustomerCustomerFinancialDetailsID
PictureID
DefaultDimensionsParentID
DimensionID
EmployeePictureID
DefaultDimensionsParentID
DimensionID
TimeRegistrationEntriesID
ItemPictureID
DefaultDimensionsParentID
DimensionID
DefaultDimensionsParentID
DimensionID
Journal LineAttachmentsParentID
ID
JournalJournalLinesParentID
ID
Attachments
(as child of JournalLines, therefore grandchild)
ParentID
ID
PurchaseInvoicePurchaseInvoiceLinesID
PdfDocumentID
Sales InvoiceSalesInvoiceLinesID
PdfDocumentID
Sales OrderSalesOrderLinesID
Sales QuoteSalesQuoteLinesID
PdfDocumentID
VendorPictureID
DefaultDimensionsParentID
DimensionID

About the Options Tab

The Options tab allows you to define how errors in this step are handled at task runtime.

Microsoft Dynamics 365 Business Central Connector v1.1

If an error occurs, you can decide whether the step should Continue processing, or terminate the step immediately
(Abort Step).

If the step is aborted, you can choose to Continue processing onto the next step in the task, or terminate the whole task immediately (Abort Task). By allowing the task to Continue, you can use the error XML received back in a Save File step for investigation purposes, for example.

White Paper - Microsoft Dynamics 365 Business Central Connector 1.1

White Paper - Microsoft Dynamics 365 Business Central Connector 1.1

The Microsoft Dynamics 365 Business Central Connector v1.1 Technical Overview introduces you to the tool. Installed as an add-on to BPA Platform, this tool provides direct communication between BPA Platform and Dynamics 365 Business Central.