Create a Purchase Return from a Purchase Receipt Record

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can create purchase returns from purchase receipt records. For details about the management of purchase documents, see Managing Purchase Documents.

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:
  1. Deploy a new MYOB Acumatica instance with the U100 dataset. For details on deploying an instance, see To Deploy an MYOB Acumatica Instance.
  2. On the Enable/Disable Features (CS100000) form, make sure that the Inventory and Order Management feature is enabled.
  3. 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.
  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 example of an HTTP request to create a purchase return by using the purchase receipt number (the POReceiptNbr field) and the purchase receipt line number (the POReceiptLineNbr field). Thus, a specific line of a purchase receipt will be added to the purchase return being created.
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/PurchaseReceipt
Accept: application/json
Content-Type: application/json

{
    "Type": {"value": "Return"},
    "VendorID": {"value": "GOODFRUITS"},
    "CreateBill": {"value": "False"},
    "Description": {"value": "Test return (one PR line)"},
    "ProcessReturnWithOriginalCost": {"value": "True"},
    "Details": [
        {
            "POReceiptNbr": {"value": "000016"},
            "POReceiptLineNbr": {"value": "1"}
        }
    ]
}