How to fixed Sales Order OData V4 Ship-To / Bill-To Errors in Business Central

-

How to Fix Sales Order OData V4 Ship-To / Bill-To Errors in Business Central

When integrating with Microsoft Dynamics 365 Business Central through the OData V4 API, I ran into a problem while creating Sales Orders with Ship-To addresses.

Sales Orders without Ship-To or Bill-To information were created without any issues. However, as soon as I tried to include a Ship-To address as an Alternative Shipping Address, the API returned errors. After some investigation, the solution turned out to be a very small but important change in the page extension.

Problem

I was posting a Sales Order using the OData API and included Ship-To fields in the payload:

{
  "Document_Type": "Order",
  "Sell_to_Customer_No": "10000",
  "ShipToOptions": "Alternate Shipping Address",
  "Ship_to_Code": "0009"
}

Instead of processing the request, Business Central returned errors such as:

  • Form.RunModal is not allowed in write transactions

  • Validation failures on Ship-To fields

This clearly indicated that the API was not recognizing the Ship-To field correctly.

Root Cause

When I reviewed the Sales Order Card page extension, I found two issues:

  1. The default code was attempting to open a page during the write transaction. Since API requests run as background write transactions, any call that opens a page or modal dialog (for example, Form.RunModal) is not allowed. This was the reason behind the write transaction error.

  2. The ShipToOptions field is a protected variable in Business Central. Because of this, it cannot be directly exposed to OData requests.

To make it usable in API requests, I added a new field on the page extension that referenced the base variable:

field(ShipToOptionsnew; ShipToOptions)

{

    ApplicationArea = All;

}

By exposing this new field (ShipToOptionsnew) at the page level, I was able to pass the value successfully through the OData API.

The Fix

Once I updated my API request to use the correct field name (ShipToOptionsnew) and set it before providing the Ship-To details, the Sales Order was created successfully.

Here’s the working payload:

{

  "Document_Type": "Order",

  "Sell_to_Customer_No": "10000",

  "ShipToOptionsnew": "Alternate Shipping Address",

  "Ship_to_Code": "0009"

}

This small change ensured that Business Central recognized the request correctly and accepted the Alternative Shipping Address details.


Key Takeaways

  • Always confirm whether fields are standard or have been extended/renamed in your environment.

  • If you encounter validation errors when posting Ship-To or Bill-To details, check the Page Extension code to see how fields are defined.

  • In this case, replacing ShipToOptions with ShipToOptionsnew resolved the issue immediately.

  • Before building integration logic, run a GET request on an existing Sales Order. This will show you the exact field names your system exposes through OData.

By identifying the correct field name and adjusting the request accordingly, I was able to resolve the Ship-To error and successfully create Sales Orders via OData V4.

Thank you for your time,
Dharmendra Chavda

Comments

Post a Comment

Popular posts from this blog

Data Upload into CRM from Excel Using Power Automate

-
Image
When managing a CRM like Microsoft Dynamics 365, uploading data from an Excel file can be a tedious manual task, especially when working with large datasets. You can automate this process using Power Automate (formerly known as Microsoft Flow), saving time and ensuring data consistency. Step 1: Prepare Your Data in Excel Ensure that your Excel file is well-organized, the  first row contains the Header names, and check incorrect values to prevent upload issues. Step 2: Create a table in Excel or based on the requirement.            Import Contact Template Step 3: Upload Your Excel File to OneDrive. Power Automate needs access to your Excel file. Store your file in a cloud-based location like OneDrive for Business or SharePoint: Upload the file to your OneDrive. Take note of the file path, as you will need it in Power Automate. Step 4: Set Up Power Automate to Upload Excel Data to CRM Now, we will set up a flow to automate the data upload process. Log in...
Read more

Run a Dynamics 365 Plugin from JavaScript on Button Click

-
Image
Trigger a Dynamics 365 Plugin from JavaScript on Button Click In Dynamics 365, plugins usually run when system events happen — like creating, updating, or deleting a record. But in some cases, you might want to run a plugin only when the user clicks a button on a form. This blog will guide you step by step on how to trigger a Dynamics 365 plugin from JavaScript using a Custom Action and a Plugin. Steps to call a plugin from JavaScript   Create a Custom Action Open Advanced Settings → Solutions (or open the specific solution where you want to add the action). Click New in the top menu. Choose Automation → Process. From the process types, pick Action — use an Action when you want to call plugins or custom logic from JavaScript, workflows, or Power Automate. Once you click on Action a Quick Create Process form will open and fill details. After that below form is open and you can update process argument as below. And Activate process. 2. Register the Plugin on the Acti...
Read more

Update a Lookup Field value using PowerAutomate

-
Image
 Hello Readers, Update a Lookup Field value using PowerAutomate. Step 1: Create a New Flow and add the below trigger to the update field. Select the Entity Assignment to update when another field in modified or updated. Step 2: Add another trigger to fetch the value from another entity Contact to update data in the Assignment entity. Row ID: Select from the Assignment entity field to match with the contact entity. Step 3: Add the Update trigger and select the same entity Assignment. Row ID: select from Assignement unique entity. Supervisor: Select the update field based on our requirements. Regards, Dharmendra Chavda
Read more