Check the Status of a Sales Invoice

If you are using the REST API to integrate MYOB Acumatica with an external system, this external system may need to check the status of a sales invoice. For example, the external system may need to check the status of a sales invoice after the release operation has been performed for it.

In MYOB Acumatica, after the release operation has been completed on the Invoices (SO303000) form, the sales invoice has the Open status, which is specified in the Status box.

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.
  4. Remove the INV000046 sales invoice from hold by completing Remove a Sales Invoice from Hold.
  5. Invoke the release operation by completing Invoke Release of an Invoice.
  6. Make sure the operation has completed successfully by completing Retrieve the Status of the Release Operation.

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 check the status of the sales invoice after the release operation. 

GET /entity/Default/24.200.001/SalesInvoice/Invoice/INV000046
    ?$select=ReferenceNbr,Type,Status HTTP/1.1
Host: <MYOB Acumatica instance URL>
Accept: application/json
Content-Type: application/json