Skip to content
English - Australia
  • There are no suggestions because the search field is empty.

Setup Guide: MYOB Acumatica Connection

This guide walks you through the steps required to configure MYOB Acumatica in preparation for the Web Ninja website integration.

MYOB Acumatica Connection Setup

These steps should be completed by your MYOB partner prior to Web Ninja establishing the connection on your behalf. Once all steps have been completed, the relevant credentials and details will need to be forwarded to your Web Ninja contact so they can finalise the setup.

Step 1 — Create a Licensed API User Account

The API user account is the primary account Web Ninja uses to communicate with Acumatica. This account must be created and correctly configured before the integration can function.

  • Create a new user account in Acumatica designated for API use.
  • Set the account license type to either Fully Licensed or Limited Licensed.
  • Ensure the following roles are assigned to the account:
    • Administrator
    • OData v4 User

Once created, send the username, password, and the URL of your Acumatica login page to your Web Ninja contact.

Step 2 — Create a Standard User Account

A standard user account is required to assist with initial data setup, sales order testing, troubleshooting, and training. This is separate from the API user account and is used by your Web Ninja contact to navigate the system during the onboarding process.

 

Once created, send the username and password to your WebNinja contact.

Step 3 — Publish the WebNinja Customisation

The Web Ninja customisation package extends Acumatica with the additional functionality required for the integration. Your Web Ninja contact has already or will provide you with the customisation file.

  1. Import the customisation file provided by your Web Ninja contact.
  2. Validate the customisation and confirm that the validation status displays as Passed.
  3. Publish the customisation and confirm that the status displays as Published.

Important: If any previous Web Ninja customisations exist in the system, these must be unpublished and removed/deleted before publishing the new one to avoid conflicts.

Critical: After publishing the customisation, navigate to the System Contract settings and confirm that the System Contract is set to 4. (see below) If this is not set correctly, the sync between Acumatica and your WebNinja website will fail to connect.

The screenshot below highlights the system contract being set to 2 which will not allow the Web Ninja system to connect to the MYOB api.

If it's set to 2, and you're on Acumatica v2024R1 or higher - you'll need to delete the endpoint, go back to the Webninja Customisation, and use Publish with cleanup to force it to recreate the endpoint. On v2024R1 and newer versions - this will automatically publish the endpoint with contract = 4

Step 4 — Set the WebNinja Endpoint to the Latest Version

The WebNinja endpoint must be configured to the correct version to ensure compatibility with the integration.

Make sure the endpoint is set correctly:
Endpoint Name:       WebNinjaApiv20
Endpoint Version:    20.200.001

If it's not this version, please follow-up with your Webninja contact and request they send you the latest customisation which will install the correct endpoint (see the note at the end of Step 3 above about Publish with Cleanup)

Step 5 — Locate the Tenant Name

The Tenant Name is required for the WebNinja connection settings (Referred to as the Company in the Webninja connector's settings)

To locate the Tenant Name:

  1. Navigate to More Items > System Management.
  2. Under System Maintenance, click Tenants.
  3. Note the Tenant Name displayed.

Send the Tenant Name to your WebNinja contact and let them know this is for the Company Field in Webninja's settings.

Step 6 — Locate the Company Name

The Company Name is also required for the WebNinja connection settings (referred to as the Branch in Webninja settings)

To locate the Company Name:

  1. Navigate to More Items > Configuration.
  2. Click Companies.
  3. Note the Company Name displayed.

Send the Company Name to your WebNinja contact and let them know this is for the Branch field in the Webninja sync settings.

Step 7 — Setup Checklist

Before notifying your WebNinja contact that the setup is complete, please confirm that all of the following items have been addressed:

  Task Action Required
API user account created and licensed Send username, password, and Acumatica login URL to WebNinja
API user account roles assigned (Administrator & OData v4 User)
Standard user account created Send username and password to WebNinja
Latest WebNinja customisation published and validated
System Contract confirmed as set to 4
Endpoint set to WebNinjaApiv20 (version 20.200.001)
Tenant Name located Send to WebNinja
Company Name located Send to WebNinja

 

Once all items are checked off and the relevant details have been sent through, your WebNinja contact will proceed with configuring the connection on the WebNinja side.