Create a Return for Credit
If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can create a return for credit (that is, a return order of the RC type) for any number of invoices in MYOB Acumatica.
Testing of the Request
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:
- Deploy a new MYOB Acumatica instance with the U100 dataset. For details on deploying an instance, see To Deploy an MYOB Acumatica Instance.
- On the Enable/Disable Features (CS100000) form, make sure that the Inventory and Order Management feature is enabled.
- If you use Postman as the client application for testing, in the IntegrationDevelopmentGuide.postman_collection.json collection (which is located in the IntegrationDevelopment\Help folder of the Help-and-Training-Examples repository on GitHub), make sure the collection variables have the proper values.
- 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 order through the contract-based REST API. This return order 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/23.200.001/SalesOrder
Accept: application/json
Content-Type: application/json
{
"CustomerID": { "value": "GOODFOOD" },
"Description": { "value": "Return Order for 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" }
}