# MYOB setup for PopMCP

If PopMCP shows Sign in with MYOB with no fields, click it, sign in as an administrator of the company file, and approve the file. If it asks for an API Key and API Secret, apply to MYOB for API access, register an app in the Developer tab in my.MYOB with PopMCP's redirect URL, enter its details, then sign in the same way. This covers MYOB Business, Essentials and AccountRight online files. MYOB Acumatica and EXO are separate products and are not covered.

- Auth: OAuth authorization
- Setup time: 5 min once you have MYOB API access
- API base URL: https://api.myob.com/accountright/{businessId}
- Credentials screen: https://my.myob.com.au/Pages/Default.aspx
- Provider docs: https://developer.myob.com/api/myob-business-api/api-overview/getting-started/

## Approval required before this works

MYOB issues no personal keys, so connecting needs an API key from its developer access, which you apply for. When PopMCP's own MYOB sign-in is switched on, an administrator of the company file just signs in, and needs none of this.

- Typical wait: MYOB publishes no timeline for setting up access. Registering an app takes minutes after that.
- Cost: MYOB's developer program lists monthly fees for API access: see its program page for current prices. You also need a MYOB subscription on the company file. PopMCP adds nothing to this.
- Blocked until approved: Your own API key cannot be registered until MYOB gives you access, so the connection cannot start before then.
- Works meanwhile: Check that the login you will use is an administrator of the company file, and that the file is held online rather than on a desktop.

## Before you begin

- A my.MYOB login that is an administrator of the company file you want to connect. MYOB lets only an administrator approve access, one file at a time.
- The file must be held online. AccountRight files kept on a desktop cannot be reached from PopMCP.
- To use your own API key: API access from MYOB, which you apply for. MYOB's developer program page lists membership levels with monthly fees. You also need PopMCP's redirect URL from the connect form: https://app.popmcp.com/api/providers/myob/callback

## Get your credentials

### 1. Check whether you need your own key at all

Open MYOB in PopMCP. If you see Sign in with MYOB and no fields, click it and skip to the last step. If the form asks for an API Key and API Secret, carry on.

### 2. Apply to MYOB for API access

Open MYOB's Getting Started page and click Submit your Application. MYOB sets up your access, creating a my.MYOB login if you do not have one, and invites you to a sandbox company file for testing. MYOB's developer program page lists the levels and what each costs, so read it first.

Screen: https://developer.myob.com/api/myob-business-api/api-overview/getting-started/

### 3. Register an app with PopMCP's redirect URL

Sign in to my.MYOB, click the Developer tab, then click Register App. Enter a name such as `PopMCP`, and under the redirect URL enter `https://app.popmcp.com/api/providers/myob/callback` exactly. Click Register App.

Screen: https://my.myob.com.au/Pages/Default.aspx

### 4. Copy the API Key and API Secret

MYOB shows the API Key and API Secret on the page, with the app's usage and limits. Copy both.

Screen: https://my.myob.com.au/Pages/Default.aspx

### 5. Sign in and approve the company file

Enter the API Key and API Secret in PopMCP, or skip that if there were no fields, and click Sign in with MYOB. Sign in on MYOB's page as an administrator of the file, choose the file, and approve access. PopMCP connects to that one file. If your company file still has its own user name and password rather than a my.MYOB sign-on, enter them in PopMCP under More options first. To connect another file, repeat this step in another workspace.

## Fields PopMCP asks for

- API Key (clientId) [required]: Only needed to use your own API key. Apply for API access at developer.myob.com, then in my.MYOB open the Developer tab, click Register App, enter a name and the redirect URL shown here, and copy the API Key.
- API Secret (clientSecret) [required]: Shown beside the API Key in the Developer tab. Stored encrypted and used only on our server.
- Company file user name (companyFileUser): Only if your company file still has its own user name and password rather than a my.MYOB sign-on.
- Company file password (companyFilePassword): The password for that company file user. Leave it empty if the user has none.

## Callback URL to register

https://app.popmcp.com/api/providers/myob/callback

## Scopes requested

- sme-company-file
- sme-company-settings
- sme-general-ledger
- sme-sales
- sme-purchases
- sme-banking
- sme-inventory
- sme-timebilling
- sme-payroll
- sme-contacts-customer
- sme-contacts-supplier
- sme-contacts-personal
- sme-contacts-employee

## Verify

PopMCP shows MYOB as Connected under your company file's name, and myob_company_overview returns the file with its tax codes and accounts.

## Troubleshooting

### MYOB shows an error page instead of asking for access

Cause: PopMCP's redirect URL is not on your app, or differs by a character.

Fix: In the **Developer** tab in my.MYOB, set your app's redirect URL to `https://app.popmcp.com/api/providers/myob/callback` and connect again.

### "MYOB signed you in but this company file refused access"

Cause: The person who signed in is not an administrator of the file, or the file still has its own user name and password rather than a my.MYOB sign-on.

Fix: Connect again as an administrator. If the file has its own sign-on, enter its user name and password in PopMCP under **More options**.

### "MYOB did not say which company file you approved"

Cause: The sign-in finished without a file being chosen.

Fix: Connect again and choose a file on MYOB's page. If it does not offer the file, check the login is an administrator of it.

### "MYOB did not accept the app's API Key and API Secret"

Cause: One was mistyped, or the key is inactive.

Fix: Copy both again from the **Developer** tab in my.MYOB, and connect again.

### "MYOB says this API key is missing or inactive"

Cause: The key has been disabled, or the developer access behind it has lapsed.

Fix: Check the key in the **Developer** tab, and with MYOB if it stays inactive. Connect again afterwards.

### A tool answers that the sign-in did not grant a scope

Cause: Access to that part of the file was not approved when you connected.

Fix: Connect MYOB again as an administrator of the file and approve access.

### A tool answers that MYOB is limiting calls

Cause: MYOB limits each API key to a few calls a second and a daily total, and calls beyond that get a 403.

Fix: Wait a moment and try again. Run calls one after another rather than side by side.

### A delete is refused and the error says transactions must be reversed

Cause: This file is set to require reversals in its preferences.

Fix: Enter a reversing transaction instead, or change the preference in MYOB if your accountant agrees.

---

Source: https://www.docs.popmcp.com/docs/integrations/myob/