Dynamics 365 Business Central

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the connection.

OAuth 2.0 - Client credentials connection type

Access key connection type

For information about how to create a Dynamics 365 Business Central Workspace, see Welcome to Dynamics 365 Business Central.

For information about the Dynamics 365 Business Central API, see Dynamics365BusinessCentral API Reference.

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all sales orders

1. In the Configure connector task dialog, click Entities.
2. Select salesOrders from the Entity list.
3. Select the List operation, and then click Done.
4. In the Task Input section of the Connectors task, you can set the filterClause.

You must use single quotes (') to enclose the value for a filter clause. You can use the filter clause to filter records based on the columns.

Example - Get a sales order

1. In the Configure connector task dialog, click Entities.
2. Select salesOrders from the Entity list.
3. Select the Get operation, and then click Done.
4. Set the entity ID to "841c04f9-3391-ef11-8a6b-002248d4e29e", which is the key to be passed. To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "841c04f9-3391-ef11-8a6b-002248d4e29e" in the Input Value field and choose the EntityId as the local variable.

   Value for Entity Id should be passed directly, such as "841c04f9-3391-ef11-8a6b-002248d4e29e". Here, "841c04f9-3391-ef11-8a6b-002248d4e29e" is the unique primary key value.

   If passing a single Entity ID throws an error due to the presence of two composite keys, you can use the filter clause to pass the value.

Example - Delete a sales order

1. In the Configure connector task dialog, click Entities.
2. Select salesOrders from the Entity list.
3. Select the DELETE operation, and then click Done.
4. Set the entity ID to "841c04f9-3391-ef11-8a6b-002248d4e29e", which is the key to be passed. To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "841c04f9-3391-ef11-8a6b-002248d4e29e" in the Input Value field and choose the EntityId as the local variable.

   If the entity has two composite business or primary keys instead of specifying the entityId, you can also set the filterClause to id='841c04f9-3391-ef11-8a6b-002248d4e29e'.

Example - Create a sales order

1. In the Configure connector task dialog, click Entities.
2. Select salesOrders from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as the local variable.

   {
        "orderDate": "2024-10-30",
        "customerNumber": "10000",
        "currencyCode": "INR",
        "paymentTermsId": "590d75c5-f26e-ef11-a678-6045bdc89b07"
        }
        

   If the integration is successful, the salesOrders task's connectorOutputPayload response parameter will have a value similar to the following:

   {
        "id": "2e048d8a-a796-ef11-8a6b-6045bdae882d"
        }
        

Example - Create a sales order line

1. In the Configure connector task dialog, click Entities.
2. Select salesOrderLines from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as the local variable.

   {
        "documentId": "b747cc93-c37f-ef11-ac23-7c1e523b4365",
        "sequence": 10014,
        "itemId": "8b0f75c5-f26e-ef11-a678-6045bdc89b07",
        "lineType": "Item",
        "lineObjectNumber": "1996-S"
        }
        

   If the integration is successful, the salesOrderLines task's connectorOutputPayload response parameter will have a value similar to the following:

   {
        "id": "35535130-d09d-ef11-8a6b-002248d4cc93"
        }
        

Example - Create a sales quote

1. In the Configure connector task dialog, click Entities.
2. Select salesQuotes from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as the local variable.

   {
        "paymentTermsId": "590d75c5-f26e-ef11-a678-6045bdc89b07",
        "currencyCode": "INR",
        "customerNumber": "30000"
        }
        

   If the integration is successful, the salesQuotes task's connectorOutputPayload response parameter will have a value similar to the following:

   {
        "id": "2116bd4e-3ba3-ef11-8a6b-6045bdacfb5e"
        }
        

Example - Create a purchase order

1. In the Configure connector task dialog, click Entities.
2. Select purchaseOrders from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as the local variable.

   {
        "vendorId": "7e0f75c5-f26e-ef11-a678-6045bdc89b07",
        "vendorNumber": "10000"
        }
        

   If the integration is successful, the purchaseOrders task's connectorOutputPayload response parameter will have a value similar to the following:

   {
        "id": "53389ee7-a796-ef11-8a6b-6045bdae882d"
        }
        

Example - Create an item

1. In the Configure connector task dialog, click Entities.
2. Select items from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as the local variable.

   {
        "number": "4000-D",
        "displayName": "Charlie Altostrat",
        "type": "Inventory",
        "itemCategoryId": "d61672cb-f26e-ef11-a678-6045bdc89b07",
        "baseUnitOfMeasureCode": "PCS"
        }
        

   If the integration is successful, the items task's connectorOutputPayload response parameter will have a value similar to the following:

   {
        "id": "fad09437-8d9e-ef11-8a6b-000d3af0e092"
        }
        

Example - Update a sales order

1. In the Configure connector task dialog, click Entities.
2. Select salesOrders from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   {
        "phoneNumber": "7764872993"
        }
        

5. Set the entity ID in Data Mapper to the entity of the salesOrders. To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   Instead of specifying the entityId, you can also set the filterClause to id ='5e9226d3-1c7b-ef11-a671-6045bdaef76c'.

Example - Update a sales order line

1. In the Configure connector task dialog, click Entities.
2. Select salesOrderLines from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   {
        "description": "Test from Altostrat"
        }
        

5. Set the entity ID in Data Mapper to the entity of the salesOrderLines To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   Instead of specifying the entityId, you can also set the filterClause to id ='35535130-d09d-ef11-8a6b-002248d4cc93'.

Example - Update a sales quote

1. In the Configure connector task dialog, click Entities.
2. Select salesQuotes from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   {
        "currencyCode": "USD"
        }
        

5. Set the entity ID in Data Mapper to the entity of the salesQuotes To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   Instead of specifying the entityId, you can also set the filterClause to id='2116bd4e-3ba3-ef11-8a6b-6045bdacfb5e'.

Example - Update a purchase order

1. In the Configure connector task dialog, click Entities.
2. Select purchaseOrders from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   {
        "shipToName": "Charlie Cruz"
        }
        

5. Set the entity ID in Data Mapper to the entity of the purchaseOrders To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   Instead of specifying the entityId, you can also set the filterClause to id ='6b88738e-3891-ef11-8a6b-002248d4e29e'.

Example - Update an item

1. In the Configure connector task dialog, click Entities.
2. Select items from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   {
        "displayName": "Updates Altostrat name"
        }
        

5. Set the entity ID in Data Mapper to the entity of the items To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as the local variable.

   Instead of specifying the entityId, you can also set the filterClause to id ='fad09437-8d9e-ef11-8a6b-000d3af0e092'.