adding "Work Description" while creating a sales quote using API

(1) Share

Report

Posted on by Prem A Nair

Hello
I am trying to create a sales quote by posting the required data to http://<businesscentralPrefix>/companies({id})/salesQuotes

The minimum required json is the following

{
"customerNumber": "10000"
}

The above is working and creating a sales quote with defaults.

But I also need to add the "Work Description" while i create the quote. The API documentation is not mentioning about it. But I can create/add "Work Description" when I create the quote thru BC. Also while I retrieve the quotes the "Work Description" updated is not retrieved by the API.

I tried with the following json

{
"customerNumber": "10000",
"workDescription" : "bla bla bla"
}

But the API complained and returned the following

{
    "error": {
        "code": "BadRequest",
        "message": "The property 'workDescription' does not exist on type 'Microsoft.NAV.salesQuote'. Make sure to only use property names that are defined by the type. CorrelationId: 962c3d60-00db-481a-a3ff-20273fa1e8ec."
    }
}

Please let me know if someone has some thoughts on this.

Thanks
Prem

Categories:

Dynamics 365 Business Central

Microsoft Dynamics NAV

I have the same question (0)

All responses (7)

Answers (1)

Suggested answer

Gerardo Rentería Ga... 25,384 Most Valuable Professional on at

Like (2)

Report

Hi

You should copy the original API and create a new custom one, I hope this information helps you.

Developing a custom API - Business Central | Microsoft Learn

How To Create Custom APIs In Business Central - Business Central Geek

Dynamics 365 Business Central: How to use Standard/Custom API Bound Actions | Dynamics 365 Lab

Best

GR

Was this reply helpful? Yes No
Suggested answer

Khushbu Rajvi. 20,838 Super User 2025 Season 2 on at

Like (2)

Report

Since the Work description field type is Blob, you can't simply add or store data in it as you would with other data types like Integer, Code, or Text. Blob fields require specific handling to store and retrieve data.

Handling Blob fields through the API requires a slightly different approach, as Blobs are typically managed via separate data streams. If "Work Description" is simple text that needs to be stored as a BLOB, you can encode the text in Base64 format and store it in the BLOB field.
Hope it helps: https://community.dynamics.com/forums/thread/details/?threadid=8d3c4cbe-db2e-4c9f-9596-8f1d93771ec7

Was this reply helpful? Yes No
Prem A Nair 37 on at

Like (0)

Report

i am a new bee and yet to explore BC :)

The "Work Description" field is present in the default sandbox setup. Pls see the attached screenshot circled part. That field is OOTB and I thought it shd be returned by the API call (either as normal data or as a sep req to get blob data)

Was this reply helpful? Yes No
Suggested answer

Suresh Kulla 50,247 Super User 2025 Season 2 on at

Like (1)

Report

Please check this post, it will show an example how to handle BLOB fields in API. You need to create a copy of standard API and update it accordingly.

https://demiliani.com/2020/01/24/dynamics-365-business-central-handling-blob-fields-on-apis/

Was this reply helpful? Yes No
Suggested answer

Khushbu Rajvi. 20,838 Super User 2025 Season 2 on at

Like (2)

Report

I know that it is present in the table and on the page. However, it's a BLOB field, so when you're pushing data, you need to handle it specifically. You can follow the link that Suresh mentioned.

Was this reply helpful? Yes No
Suggested answer

YUN ZHU 95,750 Super User 2025 Season 2 on at

Like (1)

Report

Before Work Description was of BLOB type, you used the standard API of Sales Quote. WorkDescription does not exist in the standard API, so you first need to customize the API.

More details: Dynamics 365 Business Central: Can we extend standard APIs? – Download Standard Source Code for APIs

https://yzhums.com/20960/

Hope this helps.

Thanks.

ZHU

Was this reply helpful? Yes No
Verified answer

Prem A Nair 37 on at

Like (1)

Report

an update on this. I could retrieve and update the "Work Description" using the ODataV4 URLs not with the normal REST api. Here are the details

retrieve Work Description from Sales Quote

GET to https://api.businesscentral.dynamics.com/v2.0/<instance>/BC/ODataV4/Company('CRONUS%20IN')/salesDocuments(6f7ca2ee-0195-ef11-8a73-6045bdc91196)/workDescription

update Work Description

PATCH to https://api.businesscentral.dynamics.com/v2.0/<instance>/BC/ODataV4/Company('CRONUS%20IN')/salesDocuments(6f7ca2ee-0195-ef11-8a73-6045bdc91196)/workDescription

with a header If-Match * and plain txt data in body as new value for Work Description

Was this reply helpful? Yes No