How to Use the MYOB AccountRight API Locally

This guide outlines the process to connect to the MYOB AccountRight API on your local machine using the Server Edition. No API key or OAuth process is required.

Requirements

• MYOB AccountRight Server Edition (2025) installed

• An accessible company file (.myox)

• A local company file user (not linked to a my.MYOB account)

• Base64-encoded username:password for authentication

• Access to: http://localhost:8080/accountright/

Step 1: Install AccountRight Server Edition

1. Download the latest Server Edition from Downloads - MYOB Support .

2. Install and launch AccountRight Server Edition.

3. Confirm the API is running by visiting:

   http://localhost:8080/accountright/

   You should see a list of company files.

Step 2: Set Up a Local Company File User

1. Open the company file.

2. Navigate to Setup > User Access.

3. Add or edit a user.

4. Ensure “This user will sign on with a my.MYOB account” is not selected.

5. Assign a username and password.
   Manage users

Step 3: Authenticate Using x-myobapi-cftoken

1. Combine your username and password:

   username:password

2. Base64 encode the string.

3. Include these headers in your API requests:

   x-myobapi-cftoken: <Base64EncodedUsernamePassword> x-myobapi-version: v2 Content-Type: application/json 

    

No API key or OAuth is required for local API

Step 4: Make a Request

1. Retrieve your company file ID:

   GET http://localhost:8080/accountright/ 

    

   1. Use the company file ID to make requests. Example:

      GET http://localhost:8080/accountright/{CompanyFileID}/Contact/Customer

       

Default Company File Location

• PC Edition:
  C:\Users\<YourUsername>\Documents\MYOB\My AccountRight Files

• Server Edition:
  C:\Users\Public\Documents\MYOB\My AccountRight Files

How to Change the File Location

1. Open the Start Menu and search for:

   Set Library Location SE

2. Choose a new folder (must be on a local drive).

3. Move existing company files to the new location.

Configure API for Custom Server Environments

If hosting MYOB on a custom port or IP:

1. Locate the config file at:

   C:\Users\<YourName>\AppData\Local\Programs\MYOB\AccountRightServerEdition\app-2025.x.xxxx.x\API\MYOB.AccountRight.API.WindowsServiceHost.exe.config 

    

2. Update the following keys:

   <add key="PublicAddressServer" value="localhost" /> 
   <add key="PublicAddressPort" value="8080" /> 
   <add key="InstallationAddress" value="http://localhost:8080/accountright" />

    

3. Restart the MYOB AccountRight API service via services.msc.

Testing Tips

• Use tools like Postman or Insomnia to test API calls.

• Ensure each request includes x-myobapi-version: v2.

• No token refresh is needed for local API usage.

See Also

• Changing the local API config file

• Authentication Guide

• Local API Add-on Connector