Retrieve the Companies' Structure

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can retrieve information about the companies' structure—that is, the structure of the companies and branches in the tenant.. For this purpose, the Company Branch (CS401000) generic inquiry is used.

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. 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.
  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.

Request

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.

You can use the following HTTP request example to retrieve the companies’ structure.

PUT ?$expand=Results HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/23.200.001/CompaniesStructure
Accept: application/json
Content-Type: application/json

{}