Retrieve Payments One by One

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can retrieve payments one by one from MYOB Acumatica. In this case, the key fields—namely, the payment type and reference number—are specified in a request. When a single payment is retrieved by using the contract-based REST API, the following information can be retrieved as well: documents to apply, orders to apply, application history, credit card processing information, and credit card transaction information.

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 T100 dataset. For details on deploying an instance, see To Deploy an MYOB Acumatica Instance in the Installation Guide.
  2. 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.
  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.

Request

You can use the following request example to retrieve the 000001 payment, along with detailed information about it, through the contract-based REST API.
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.
GET Payment/000001?$select=ReferenceNbr,Type,Status,ApplicationDate,
ApplicationHistory/DisplayDocType,ApplicationHistory/DisplayRefNbr
&$expand=ApplicationHistory HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/23.200.001/Payment
Accept: application/json
Content-Type: application/json