Release a Payment

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can release an accounts receivable payment in MYOB Acumatica.

System Preparation

Before you test the code below, you need to do the following:

  1. Create a payment for an invoice and sales order, as described in Create a Payment for an Invoice and a Sales Order.
  2. On the Payments and Applications (AR302000) form, open the created payment. (Its reference number is assumed to be 000077 in this example.)
  3. On the form toolbar, click Remove Hold, and specify the payment amount in the Payment Amount box.
  4. Save the document.

Request

You can use the following request example to invoke the release process for the 000077 AR payment through the contract-based REST API. The reference number of the AR payment is specified in the ReferenceNbr field.

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.
POST /Release HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/24.200.001/Payment
Accept: application/json
Content-Type: application/json

{
    "entity": {
        "Type": { "value": "Payment" },
        "ReferenceNbr": { "value": "000077" }
    }
}