Add a Note to a Stock Item

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can add a note to a stock item.

System Preparation

Before you test the code below, you need to do the following to configure your client application and the MYOB Acumatica instance to be used:

  1. Deploy a new MYOB Acumatica instance with the T100 dataset. For details on deploying an instance, see Instance Deployment: To Deploy an Instance with Demo Data in the Installation Guide.
  2. If you use Postman as the client application for testing, in the IntegrationDevelopmentGuide.postman_collection.json collection, make sure that the collection’s variables have the proper values. This collection is located in the IntegrationDevelopment\Help folder of the Help-and-Training-Examples repository on GitHub.
  3. To sign in to the instance in the client application, use the tenant name (which you specified when you created the instance) and the MYSTORE branch.

Request

You can use the following request example to add the My note note to the AALEGO500 stock item through the contract-based REST API.

Tip:
In the request example below, <MYOB Acumatica instance URL> is the URL of the MYOB Acumatica instance (such as https://my.acumatica.com/MyInstance). You can omit the instance name in the URL (that is, you can use https://my.acumatica.com) if the instance is installed in the root of the website.
PUT /entity/Default/24.200.001/StockItem?
    $select=InventoryID HTTP/1.1
Host: [<MYOB Acumatica instance URL>]
Accept: application/json
Content-Type: application/json

{
 "InventoryID": {"value": "AALEGO500"},
 "note": {"value": "My note"}
}

Usage Notes

To add a note to a detail line of a document, you use the same approach that you use to add notes to top-level entities. That is, for the contract-based REST API, you specify the value of the note system field of the detail entity. For example, to add a note to a warehouse detail line of a stock item, you specify the value of the note system field of the StockItemWarehouseDetail entity, which is a detail entity of the StockItem entity. You identify the detail line that should be updated by using the values of key fields or by using the entity ID.