B2BE MYOB API Portal

User Onboarding Guide

(For Rexel project)

Prepared By: Jackey Zhang

Date: 9/09/2019
Version: 6.0
 What is B2BE MYOB API Portal?

● It’s a web portal for MYOB AccountRight users to trade

Purchase Order (outbound) and/or Invoice (inbound) with
their suppliers via B2BE.

● Communicate directly with MYOB AccountRight Live API.

● Integrate with B2BE systems for EDI transaction.

 Customer Onboarding Overview

Part I : Customer Onboarding workflow

1. Create MYOB company file account for B2BE in MYOB
2. Authorise B2BE in API Portal & MYOB
3. Link company file in API Portal
4. Map contact card with predefined suppliers in API Portal

Part II : Function - Upload Invoice from API Portal to MYOB

 Onboarding: Email Engagement

Buyer will receive an email of onboarding instructions

For customer engagement, B2Be will send an email on behalf of the

suppliers to API Portal users (buyers) containing:

● Onboarding instructions (step by step)

● B2BE’s MYOB API Portal URL

● API Portal login credentials (username and password)

 Onboarding Step 1: Create MYOB company file account

MYOB uses OAuth2.0 authentication for API Portal to access MYOB company file, so buyer
needs to create a dedicated user account in their company file and assign this account to
B2BE’s MYOB API Portal.

1.1) In MYOB AccountRight, login as Administrator, open “Setup -> User Access”.
 Onboarding Step 1: Create MYOB company file account
(cont)

1.2) Create new user in “Manage Users” tab with proper roles (“Purchases” + “Inventory
management” are recommended as minimum if using default roles)

- New user’s permission: should at least allow create invoice, read/write inventory and read card file; for simplicity, you
may select three roles : “Cards”, “Inventory management” and “Purchases”.
- Uncheck option “This user will sign on with a my.MYOB account” before input password.
- Set username and password: will be used for linking company file in Step 3. (username can be any string, “b2be” is
recommended)
 Onboarding Step 2: Authorise B2BE

2.1) Buyer login API Portal for first time

Click the API Portal URL (https://gateway.b2be.com/http/apiportal/auth/login for UAT test, or

https://gateway.b2be.com/http/apiportal/auth/login for Production) , go to B2BE API Portal
login page, input the username and password provided in email, and click “Login” button.
 Onboarding Step 2: Authorise B2BE (cont)

2.2) After login, buyer must authorise immediately by clicking “here” link.

2.3) Then user is redirected to MYOB authentication

website, and sign in buyer’s MYOB account:

 Onboarding Step 2: Authorise B2BE (cont)

2.4) After logging in MYOB, buyer can authorise B2BE API Portal to access his AccountRight
company file by clicking “Allow Access” button.
 Onboarding Step 2: Authorise B2BE (cont)

2.5) After authorisation succeeds, user is redirected back to B2BE API Portal.

- Now “Auth Token” section shows token timestamps, which means authorisation is successful;
- Company file list is loaded automatically on right section “Company File”.
 Onboarding Step 3: Link Company File in API Portal

In “Company File” section, user can link Only One of his company files to API Portal,
and provide company file’s access account credentials (the username and password
created on Step 1.2)

3.1) Select one of the available company files by clicking “Link” button.
 Onboarding Step 3: Link Company File in API Portal
(cont)

3.2) Click “Link” button of the

company file, and fill in company
file username/password in
pop-up window “Company File
Login Credentials”, and click
“Save”.
 Onboarding Step 3: Link Company File in API Portal
(cont)
.)

3.3) After clicking the save button, portal will validate the credentials with MYOB. If
there is no error, the linked company file will be shown as below with access account
user name (here is “ctm10”).
 Onboarding Step 4: Map contact card with
predefined suppliers

After linking to a company file, it will load all the contacts from your MYOB company file’s
“Cards List” to below “Contact List from MYOB” drop-down list in “Suppliers Contact
Mapping” section. User will then select from the dropdown list of supplier contacts on
the right column, mapping to predefined “B2BE Supplier Code” on the left column
(Below “Supplier ABC” is only demo purpose). Click “Save” button once mapping is done.
 Onboarding Step 5: Other profile options

After mapping contact, you need to config other options in Options section like below.
After that, remember to click “Save” button to make them effective.

1) Grant permission to insert new

records: if user allows B2BE to insert
new items into their MYOB Inventory,
should tick this option.

2) Tax Codes & Accounts: firstly click

the two “Refresh” buttons to load all
your Tax Codes list and Expense
Account list from MYOB company file,
and then select default Tax Code and
Account name to be used when
creating new item in your inventory.

3) Document option: In default B2BE

send full invoice with each line item
details to MYOB; if option
“WithoutLineDetails” is selected,
invoice will have no line item details,
instead, only summary amount is
included.
 Invoice: from B2BE to MYOB

- “Auto Mode”: In default, all Invoices from suppliers are automatically uploaded
by B2BE backend service to buyer’s MYOB company file, without manual
involvement.
- “Manual Mode”: If backend service can’t upload Invoice due to some reason
(such as authorization expired), the Invoice files will be stored in B2BE, waiting
for user to manually trigger uploading after login API Portal.
1) Search for Invoice

MYOB AddOn
“B2BE -> MYOB”
module:

Search Criteria :
 Invoice: from B2BE to MYOB (cont)

2) Select only “Processed” invoice(s) :

 Invoice: from B2BE to MYOB (cont)

3) After clicking “Upload” button, selected invoice(s) will be uploaded to MYOB

company file and status is then changed to “UPLOADED”:
Thank you!