Release a Credit Memo

By using the REST API, you can release a credit memo. In MYOB Acumatica, the successful execution of the request described in this topic changes the value in the Status box on the Invoices (SO303000) form to Open.

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 U100 dataset. For details on deploying an instance, see Instance Deployment: To Deploy an Instance with Demo Data.
  2. If you are using 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 HEADOFFICE branch.
  4. Execute the Create a Credit Memo request.

Request

Tip: In the request examples 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 (such as https://my.acumatica.com) if the instance is installed in the root of the website.

You can use the following sample HTTP request to invoke the release operation for the 000123 credit memo. 

POST /entity/Default/24.200.001/SalesInvoice/ReleaseSalesInvoice HTTP/1.1
Host: [<MYOB Acumatica instance URL>]
Accept: application/json
Content-Type: application/json

{
    "entity":{
        "Type": {"value": "Credit Memo"},
        "ReferenceNbr": {"value": "000123"}
    }
}
Attention: If the request returns the 400 Bad Request, 401 Unauthorized, or 500 Internal Server Error response, the operation has failed.

A response to the POST request with the 202 Accepted status has the Location header, which contains a URL that you should use to check the status of the operation by using the GET HTTP method. When the GET HTTP method with this URL returns 204 No Content, the operation is completed. For more information, see Execute an Action That Is Present in an Endpoint.