Retrieve the List of Ledgers

If you are using the contract-based REST API to integrate MYOB Acumatica with an external system, this external system can retrieve a list of ledgers. For details about the management of ledgers, see Managing Ledgers.

System Preparation

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 Instance Deployment: To Deploy an Instance with Demo Data.
  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, 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.

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 a list of the available ledgers. This request also retrieves information about the companies associated with each ledger and the branches that can post to each ledger.

GET ?$expand=Branches,Companies&$select=LedgerID,Branches/BranchID,Branches/BranchName,
    Branches/CompanyName,Companies/Company,Companies/CompanyName HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/24.200.001/Ledger
Accept: application/json
Content-Type: application/json