Retrieve the List of Pro Forma Invoices of a Project

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can retrieve the list of the pro forma invoices of a project. This step can be part of the larger process of creating and sending a pro forma invoice by email, which is described in Send a Pro Forma Invoice by Email.

System Preparation

Before you test the code below, you need to configure your client application and the MYOB Acumatica instance to be used as follows:
  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 in the Installation Guide.
  2. On the Enable/Disable Features (CS100000) form, make sure the Projects feature is enabled.
  3. If you use 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.
  5. Implement the Invoke Project Billing example as a prerequisite to the current example, so that the TESTPR3 project will be created with a pro forma invoice.

Request

You can use the following example of an HTTP request to retrieve the list of pro forma invoices of a project 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 /TESTPR3?$expand=Invoices HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/24.200.001/Project
Accept: application/json
Content-Type: application/json
Note:
To obtain the list of pro forma invoices of the project with the TESTPR3 project ID, you can also use the GET request for the ProFormaInvoice entity with the $filter=ProjectID eq 'TESTPR3' parameter.