Create a Return for Credit for Multiple Invoices

By using the REST API, you can create a return for credit (that is, a sales order of the RC type) for any number of invoices in MYOB Acumatica. (You can view the created return for credit on the Sales Orders (SO301000) form.)

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. On the Enable/Disable Features (CS100000) form, make sure that the Inventory and Order Management feature is enabled.
  3. 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.
  4. 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.

Request

You can use the following request example to create a return for credit for two invoices of the GOODFOOD customer. This return for credit will be created to refuse the INSTALL service included in the 000062 invoice and return 50 units of the ORANGES product included in the 000030 invoice.
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 ?$expand=Details HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/24.200.001/SalesOrder
Accept: application/json
Content-Type: application/json

{
    "CustomerID": { "value": "GOODFOOD" },
    "Description": { "value": "Return for Credit for Two Invoices" },
    "Details": [
        {
            "InvoiceType": { "value": "Invoice" },
            "InvoiceNbr": { "value": "000062" },
            "InventoryID": { "value": "INSTALL" }
        },
        {
            "InvoiceType": { "value": "Invoice" },
            "InvoiceNbr": { "value": "000030" },
            "InventoryID": { "value": "ORANGES" },
            "OrderQty": { "value": "50" }
        }
    ],
    "LocationID": { "value": "MAIN" },
    "OrderType": { "value": "RC" }
}

Usage Notes: Adding Detail Lines

If you need to add all lines of an invoice to a return for credit, you specify InvoiceType and InvoiceNbr in a detail.

If you need to add a particular line of an invoice to a return for credit, you specify the following fields of a detail line:

  • InvoiceType and InvoiceNbr to identify the invoice
  • InventoryID or InvoiceLineNbr to identify the line of the invoice

If you specify InventoryID for a detail line and do not specify InvoiceType and InvoiceNbr, the system creates no link to an invoice in the created return for credit.