MYOB EXO Business Services Release 1.0 SP1 Noteshelp.myob.com.au/exo/onthego/releasenotes/11/MYOB... · MYOB has carefully prepared this material but excludes (to the extent allowed

MYOB EXO BUSINESS SERVICES 1.0 SP1

Release Notes

Important Notices

This material is copyright. It is intended only for MYOB Enterprise Solutions Business Partners and their customers. No part of it may be reproduced in any way without the prior permission of MYOB.

MYOB has carefully prepared this material but excludes (to the extent allowed by legislation) any direct or indirect liability arising from errors or omissions or from its use. Any case studies (including the application of particular accounting standards or legislation) are representative examples only, and will not directly apply to the user’s own circumstances. They are not a substitute for professional advice. Users must check that third party materials, for example from the IRD and the ATO, are current at the time they are used.

Trademark Rights

MYOB is an internationally registered trademark of MYOB Technology Pty Ltd. The use of this trademark and MYOB’s other trademarks is prohibited without prior consent. Other products mentioned may be service marks, trademarks or registered trademarks of their respective owners.

Contents Introduction 1

What’s New in this Release? ........................................................................ 1

Installation 2

Pre-Install Requirements .............................................................................. 2

Installing the EXO Business Services ............................................................. 2

Setting up the Services 6

Setting up EXO Business Services ................................................................. 6

Setting up EXO Business ............................................................................... 8

Adding the EXO API and EXO OnTheGo Modules ........................................................ 8

Updating the EXO Business Database .......................................................................... 8

Generating User Tokens ............................................................................................... 8

Adding EXO OnTheGo Access and Devices ................................................................... 9

Bulk Loading Locations ............................................................................................... 10

API Troubleshooting ................................................................................... 12

Testing the API Service ............................................................................................... 12

Service Errors .............................................................................................................. 13

Application Errors ....................................................................................................... 14

New Features 15

EXO OnTheGo ............................................................................................. 15

New Endpoints ........................................................................................... 15

Advert Types ............................................................................................................... 15

Communication Processes ......................................................................................... 16

Company Information ................................................................................................ 16

Common Phrases ........................................................................................................ 17

Search Templates ....................................................................................................... 17

Access Token Autorefresh .......................................................................................... 18

Updated Endpoints ..................................................................................... 18

Contacts ...................................................................................................................... 18

Debtor Transactions ................................................................................................... 20

Stock ........................................................................................................................... 20

Sales Orders ................................................................................................................ 21

Companies .................................................................................................................. 21

Filtering and Ordering ................................................................................ 22

Filter ............................................................................................................................ 22

Order By ...................................................................................................................... 23

Decimal Places in Schemas ......................................................................... 24

Resolved Issues 25

Known Issues 26

Introduction What’s New in this Release?

The focus of the 1.0 SP1 release of the EXO Business Services is on adding support for the EXO OnTheGo app and increasing the scope of the EXO API by adding new endpoints and adding extra attributes and functions to existing endpoints.

The purpose of this document is to provide essential information on the installation and use of this release:

• The Installation section provides an overview of the installation process, including pre-installation requirements.

• The Setting up EXO API section provides information on configuring the EXO API after installation.

• The New Features section describes all new features introduced in this release. • The Resolved Issues section describes all issues that have been addressed by

this release.

For information on how to use the EXO API, including documentation on all API endpoints, see the EXO API Online Help at http://apidocs.myob.com/api/exo/.

MYOB EXO Business Services 1.0 SP1 Release Notes Page 1 of 26 Copyright 2014 MYOB Technology Pty Ltd.

http://apidocs.myob.com/api/exo/

Installation Pre-Install Requirements

Full details of requirements and supported operating systems for PCs running MYOB EXO Business components are available on the Minimum System Requirements page on the MYOB website.

The EXO API requires EXO Business 8.3 or later. If you are using EXO Business 8.7, you can set up the EXO API using the EXO Business Configurator application; for EXO Business versions 8.3 – 8.6, you must use the separate ExoMobileConfig.exe application (see “Setting up the ” on page 6).

Installing the EXO Business Services The EXO Business Services Setup Wizard, EXO Business Services Installer.msi, installs the local components needed to access the EXO API from an EXO Business server. This wizard is supplied with the main EXO Business installer in EXO Business 8.7 and later.

The EXO Business Services Setup Wizard must be run on a server that already has EXO Business installed on it. It must be run from an account with administrative permissions.

To perform the installation: 1. Double-click on the EXO Business Services Installer.msi installer. The welcome

screen appears:


http://myob.com.au/products/medium-business/enterprise-solutions/exo-business-1258090694421?productArea=Minimum+System+Requirements&category=1257828903138

http://myob.com.au/products/medium-business/enterprise-solutions/exo-business-1258090694421?productArea=Minimum+System+Requirements&category=1257828903138

2. Click Next. The MYOB EXO End User Licence Agreement is displayed:

3. Tick I accept the terms in the Licence Agreement and click Next to continue.

4. Select which components to install. Choose from:

• The EXO API Service

• The EXO Messaging Service

Note: The API configuration utilities are always installed (see “Setting up the ” on page 6).

5. The install location is displayed at the bottom of the window. Click Browse to choose a different location if necessary.


6. Click Next. You are now ready to install the EXO API components.

7. Click Install to being the installation. The progress of the installation is

displayed:


8. Once the installation is complete, click Finish to close the wizard. You can choose to open the EXO Business Service Configuration utility to set up details of the EXO API services (see page 6).

Note: The EXO Business Service Configuration utility is installed in the same

location as the EXO API services. You can run the utility (MYOB.ED.EXO.Cloud.ServiceConfig.exe) from this location at any time.


Setting up the Services Once the EXO Business services have been installed, they must be set up and the EXO Business system must be configured to interact with them. These steps are detailed below.

Note: All setup must be performed on the server that the services are installed on, using an account with administrative permissions.

Setting up EXO Business Services The EXO Business services must be set up for each EXO Business database connection, using the MYOB EXO Business Service Configuration utility. This utility, MYOB.ED.EXO.Cloud.ServiceConfig.exe, can be run immediately after installation, or you can open it from the EXO API install directory at any time.

The utility displays configuration settings for the following services:

• EXO API Configuration o API Services – use this service if you want to use the EXO API on a local

network. o Live Relay Services – use this service if you want to communicate with

the EXO API remotely using the online MYOB LiveRelay. (You can use both the API Service and the Live Relay Service at the same time.)

• EXO Business Alerts Configuration o Message Services – this is the EXO Business messaging service.

To configure an API service, select an EXO Business database connection, then click the relevant Add Service button.


Note: The EXO Business database connection must have been created using an account with administrative permissions. It should specify a valid server name (not blank, local, localhots, etc).

For the API Service, you must also enter a Base URL, which is the location and port the API is accessible on (the default should be suitable in most cases, unless you want to use a different directory and/or port).

Note: For local API access, ensure that your firewall is configured to allow the relevant ports, services and/or applications.

To validate that the EXO API has been successfully installed and set up, navigate to the Base URL in a web browser or REST client to see a list of available endpoints.

Note: The API Services should be set to the “Automatic (Delayed Start)” startup type. If the API Service attempts to starts before the MSSQL service has started, it will fail. Setting the API Service to a delayed start, and having SQL Server as automatic (not delayed) should overcome this problem during bootup.

The configuration process for the messaging service is slightly different; where the API services create a separate instance for each EXO Business database connection, the messaging service has a single instance, which can have multiple connections to it.

To install the messaging service instance, select a database connection and click Add Connection. This adds the service and sets up a connection to the selected database. To add new connections, select them from the EXO Connection dropdown and click Add Connection.


Setting up EXO Business The EXO Business system must be set up to use the EXO Business services. Setup can be performed in two ways:

• If you are using EXO Business 8.7 or later, you can use the EXO Configurator or the EXO OnTheGo Configurator to set up the EXO API.

• If you are using EXO Business 8.3 – 8.6, you must use the EXO OnTheGo Configurator, which is installed with the EXO API. This application contains only the EXO Configurator screens that are relevant to EXO API.

Adding the EXO API and EXO OnTheGo Modules The first step is to add the “EXO API” module in the Company section of EXO Configurator/EXO OnTheGo Configurator. To do this:

1. Click the Add toolbar button. 2. Select “EXO API” from the Module dropdown. 3. Enter your licence details. 4. Click Save. 5. Click Launch Update to update the EXO Business system.

If you are licensed to use the EXO OnTheGo app, you must also add the “EXO OnTheGo Sales” module. Repeat steps 1 – 5, selecting “EXO OnTheGo Sales” at step 2.

Updating the EXO Business Database If you are upgrading to a new version of the EXO API, you must update the database to add support for any new features used by the API. Open the EXO OnTheGo configurator and click the Launch Update button on the Company section.

Generating User Tokens Once the EXO API module is added and licensed, an API/OnTheGo Access tab becomes available when editing staff members in the Staff section of the EXO Configurator:


A similar tab is available in the EXO OnTheGo Configurator:

Tick the Allow API Access box for each staff member who will need to use the EXO API. This generates an API token for the staff member, to be used in API requests. You can right-click on the token to copy it to the clipboard.

For more information on working with the API and required token, see the EXO API Online Help at http://developer.myob.com/api/exo/exo-api-overview/getting-started/.

Adding EXO OnTheGo Access and Devices Once the EXO OnTheGo module is added and licensed, an OnTheGo sub-tab becomes available when editing staff members in the EXO Configurator and EXO OnTheGo Configurator:

Tick the Allow OnTheGo Access box to enable access to the EXO OnTheGo app for that staff member. The EXO OnTheGo license specifies a maximum number of users—once this limit has been reached, the Allow OnTheGo Access box is disabled on all other staff members.

Note: If you reduce the number of EXO OnTheGo users you are licensed for, you must untick the Allow Mobile Access boxes of enough staff members to bring you down to the new limit before you can save the new licence.


http://developer.myob.com/api/exo/exo-api-overview/getting-started/

http://developer.myob.com/api/exo/exo-api-overview/getting-started/

The EXO OnTheGo app can be licensed for up to two devices per staff member. Click the Add Device button on the OnTheGo sub-tab to enter the details for staff members’ devices.

Device Name Enter a descriptive name for the device.

Device ID Enter the device’s Unique Device Identifier (UDID). You can find this number using the EXO OnTheGo app:

1. Open the app. 2. On the login screen that appears, tap the > arrow next to the connection name.

(If this is the first time you are using the app, the connection name will be “Demo”.)

3. On the Connections window, tap Add connection to open the Create connection window. The UDID appears at the bottom of this window.

4. Tap the icon to create an email containing the UDID. Send this email to an address that can be accessed from the EXO Business server.

5. On the EXO Business server, open the email and copy the UDID. 6. Paste the UDID into EXO Configurator or EXO OnTheGo Configurator.

Click OK. A key is generated for the device; this key is to be used in API requests from the device, and must be entered when setting up a connection to the device in the EXO OnTheGo app. You can right-click on the key to copy it to the clipboard.

Bulk Loading Locations The EXO API can retrieve the geolocation details (latitude and longitude) stored for Debtors, Creditors, Non Accounts and Contacts to search for accounts based on their physical location—the EXO OnTheGo app makes use of this functionality, for example. These details can be entered in the EXO Business system in version 8.7 SP2 and later; in previous versions, the details must be entered and updated in bulk using the EXO OnTheGo Configurator.


To enter location details, click the Geo Locations button on the main toolbar:

To bulk update location details:

1. Use the Update locations for: dropdown to select the kind of account to update (Debtors, Creditors, Non Accounts or Contacts).

2. Use the Update where status is in: dropdown to filter the list of accounts by status. Only accounts that appear on the list will be updated. By default, accounts whose status is already “OK” are filtered out.

3. Click Bulk Update.

The system attempts to retrieve details for each account in the list, and updates each account’s status according to whether the attempt succeeds or fails.

Note: For versions prior to EXO Business 8.7 SP2, the EXO OnTheGo Configurator inserts database triggers to ensure that geolocation details are updated automatically if an account’s address is edited. These triggers are removed upon upgrading to EXO Business 8.7 SP2 or later.


API Troubleshooting Testing the API Service Once the API service is installed and set up, you can test it using the Advanced Rest Client in Google Chrome:

1. Download and run the Advanced Rest Client. 2. Enter the URL: http://localhost:8888/contact 3. Add a header called “Authorization”. 4. Right-click on this header and click the Edit value box that appears. 5. On the Basic tab of the popup that appears, enter the login details of a user for

the EXO Business connection you’re using and click OK.

6. Add a header called “x-myobapi-exotoken”. 7. Enter the API access token for the user whose login details you entered in step

5. (You can copy the token from EXO Business Config > Staff > Staff > API/OnTheGo Access tab > API sub-tab.)

8. Click Send.

The response should be 200 OK and a list of the contacts from the system should be returned.


https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo

https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo

Service Errors Service fails to start

Ensure that the MSSQL service is running. If the API Service attempts to start before the MSSQL service has started, it will fail.

System ID mismatch errors

This indicates that the system ID recorded for the service in the EXO Business database is not the system ID of the API server. To reset the system ID, go to the Staff > Profile Assignment > Staff section of the EXO Business Configurator and click the Reset System ID button. This sets the system ID to NULL in the EXO Business database; when the API Service is next started or restarted it will write the correct system ID to the database.

404 Not Found “Requested provider not found by [JWTAuthenticationProvider].”

If this error appears when trying to access the API, it indicates that the API and/or LiveRelay services are not started.

Errors at login

Check the “EXO API” or “EXO OnTheGo Sales” licence in the EXO Business Configurator or EXO OnTheGo Configurator, ensuring that it has not expired and that all licence details are correct.

Check that the API and/or LiveRelay services are started.

Error 13816 “Windows could not start the MYOB EXO Business API Provider Service (connection_name) service on Local Computer.”

If this error appears when attempting to start the API service, check the current error log (MYOB.ED.EXO.Cloud.Provider.ServiceHost.ERROR.log with no day suffix) for possible causes.

If the error is that the service cannot find a connection (“EXO connection with name EXO_DEMO doesn't exists or not valid SQL Server connection.”), check that the connection was created using an account with administrative privileges; delete and recreate the connection if necessary. Check that server name of the connection has a valid value (not blank, local, localhost, etc).

Try deleting the service from the MYOB EXO Business Service Configuration utility and re-adding it.


ERROR:Exception starting service. EXCEPTION: System.IO.FileLoadException: Could not load file or assembly 'System.Core, Version=2.0.5.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e, Retargetable=Yes' or one of its dependencies.

This error can be resolved by applying the .NET Framework 4.0.3 update, which can be downloaded from Microsoft’s website:

http://www.microsoft.com/en-us/download/details.aspx?id=3556

Application Errors If the application you are using to access the EXO API returns the error “Requested provider not found by [JWTAuthenticationProvider]” this indicates that the API provider service on the API server is not running, or is not connected to the Internet. Check the status of the MYOB EXO Business API Provider Service in the Windows Services management console.


http://www.microsoft.com/en-us/download/details.aspx?id=3556

New Features EXO OnTheGo

This release introduces changes to support the EXO OnTheGo iPad app. EXO OnTheGo requires a separate license and is restricted by the number of users licensed. See the “Setting up the ” section in these Release Notes for information on how to enable and set up the EXO OnTheGo module in EXO Business, in particular “Adding the EXO API and EXO OnTheGo Modules” on page 8 and “Adding EXO OnTheGo Access and Devices” on page 9.

New Endpoints This release adds new endpoints to the EXO API.

Advert Types The new adverttype endpoint returns details of the Advert Types set up for Contacts. This endpoint has the following attributes:

Attribute Type Can be null Description

description string yes Descriptive text/name for the Advert Type.

processid integer no ID number of the Communication Process associated with the Advert Type.

communicationprocess object yes Details of the Communication Process associated with the Advert Type.

Note: This is an expanded attribute that only appears when the contact endpoint is called with the $expand option.

rel string yes Relative path to the endpoint.

title string yes The endpoint’s name.

id integer no The Advert Type’s unique ID number (SEQNO).

href string yes Hyperlink for the request to the specified Advert Type.


Communication Processes The new communicationprocess endpoint returns details of the Communication Processes that are available when sending marketing communications to Contacts. This endpoint has the following attributes:

Attribute Type Can be null

description string yes Descriptive text/name for the Communication Process.



id integer no The Communication Process’s unique ID number (SEQNO).

href string yes Hyperlink for the request to the specified Communication Process.

Company Information The new companydatafileinfo endpoint returns basic information about the EXO Business company. This endpoint has the following attributes:


parentcompanyname string yes Name of the parent company from the Company > Company Details section of EXO Config.

companyname string yes Name of the company from the Company > Company Details section of EXO Config.

defaultcustomer integer no The ID number of the company’s default Debtor, as specified by the Default debtor account number profile setting.

id integer no The company’s unique ID number.

logofilename string yes File name of the company logo image, as specified by the Company logo filename profile setting.

defaultbranch integer no The ID of the company’s default branch, as specified by the Default branch for new transactions profile setting.



href string yes Hyperlink for the Company Data File Info request.

You can also return the company logo image file with the request:

companydatafileinfo/image

You can specify a height and width (in pixels) as optional parameters: https://exo.api.myob.com/companydatafileinfo/image?height=60&width=320

The image’s aspect ratio is preserved if just one of the dimensions is specified. If no dimensions are supplied, the width defaults to 100 pixels (with the height calculated to


preserve the aspect ratio). You can return the actual dimensions of the image with width=auto and/or height=auto.

Common Phrases The new commonphrases endpoint returns details of the Common Phrases set up in EXO Business. This endpoint has the following attributes:


phrasetext string yes The text of the common phrase.



id string no The phrase’s unique ID number (SEQNO).

href string yes Hyperlink for the Common Phrase request.

Search Templates The new search template endpoints can be used to return search results using a pre-defined search template set up in the EXO Business database. Three new endpoints are available:

• searchtemplate – applies to all search templates in the system. • geolocationtemplate – applies only to search templates for location-

based searches on company accounts (TYPE = G). • stocksearchtemplate – applies only to search templates for searches on

stock items (TYPE = S).

A call to one of the search template endpoints returns a list of templates with the following attributes:


name string yes The template’s descriptive name.

active boolean no Whether or not the template is currently active.

type string yes The type of template. S = stock search template, G = geolocation template.

parameters object yes Lists the input parameters that the template uses.



id string no The phrase’s unique ID number (SEQNO).

href string yes Hyperlink for the Common Phrase request.


Note: To use the search template endpoints, you must upgrade the EXO Business database using the EXO OnTheGo Configurator—see “Updating the EXO Business Database” on page 8. Search templates will be included in the EXO Business system from 8.7 SP3.

To use a search template to return search results, call the relevant endpoint with the ID number of the search template you want to use, for example:

http://localhost:8888/stocksearchtemplate/1

Depending on the search template being called, the call may need to pass parameters to filter the search results, for example:

http://localhost:8888/searchtemplate/1?accno=21&q=airfil

This will return search results using the search template with the ID number 1 and passing in the Debtor account number 21 and the search string “airfil” as parameters.

See the new “Search Templates” White Paper for details on setting up and using search templates.

Note: Search templates can make use of the latitude and longitude properties that have been added for companies—see page 21.

Access Token Autorefresh MYOB EXO Business licences are renewed annually. Since the expiry date of access tokens is based on expiry date of the EXO API and EXO OnTheGo modules, the tokens become invalid after a year and must be refreshed. A call to the new token endpoint automatically refreshes the token used in the call and returns the refreshed token as a string. This endpoint has no attributes.

Updated Endpoints Contacts The following attributes have been added to the contact endpoint:


Description

postaladdress object no The Contact’s postal address.

line1 string yes Line 1 of the postal address.





postalcode string yes The Contact’s post code.



Description

deliveryaddress object no The Contact’s delivery address.

line1 string yes Line 1 of the delivery address.






advertsourceid integer yes The ID number of the Contact’s Advert Type.

advertsource object no Details of the Contact’s Advert Type.


active boolean yes Returns true or false to indicate whether or not the Contact is currently active.

optoutemarketing boolen yes Returns true or false to indicate whether or not the Contact has opted out of eMarketing communications.

salespersonid integer yes The ID number of the Contact’s Sales person.

salesperson object yes Details of the Contact’s Sales person.


defaultcompanyid object The company associated with the Contact.

companytype integer The company type (1 = Debtor, 2 = Creditor, 3 = Prospect/ Non Account).

accno integer The company’s ID number.

Search Function

Search functionality has been added to the contact endpoint. The request:

contact/search?q={query}

returns all Contact records that match the search query.


Debtor Transactions The debtor/transaction endpoint now returns transaction lines. Each line has the following attributes:


stockcode string yes The ID code of the stock item on the line.

quantity float yes The quantity of the stock code on the line.

unitprice float yes The unit price of the stock item on the line.

discount float yes The percentage discount on the line.

tax float yes The tax total for the line.

total float yes The total value for the line, excluding tax.

totalincludingtax float yes The total value for the line, including tax.

taxrate float yes The percentage tax rate on the line at the time of the transaction.

unitpriceincludingtax float yes The unit price of the stock item on the line, inclusive of tax.

exchangerate float yes The exchange rate for the line at the time of the transaction.

hidden_sellprice float yes For Bills of Materials kits that use pricing by components, this attribute returns the header-level sell price; for BOMs that use individual stocklines, this attribute returns the line’s real price.

description string yes The description of the stock item on the line.

id integer no The line’s unique ID number.

href string yes Hyperlink for the transaction line request.

Stock

Stock Item Image

The new stockitem/{id}/image endpoint returns the image file associated with the stock item. You can specify a height and width (in pixels) as optional parameters: https://exo.api.myob.com/stockitem/airfil01/image?height=50&width=50

The image’s aspect ratio is preserved if just one of the dimensions is specified. If no dimensions are supplied, the width defaults to 100 pixels (with the height calculated to preserve the aspect ratio). You can return the actual dimensions of the image with width=auto and/or height=auto.


Decimals in Best Price Quantities

The bestprice endpoints for Stock items and Bills of Materials now support decimal quantities, e.g.

https://exo.api.myob.com/stockitem/abc/bestprice?debtorid=2&quantity=4.5

The endpoints follow the decimal place settings configured in the EXO Configurator at Business Essentials > General Settings.

Sales Orders The following attribute has been added to the salesorder endpoint:


accountname string yes The name of the Debtor account on the Sales Order.

This attribute is available for GET only.

The salesorder/validate endpoint’s response now includes the text of any error messages that occurred. The response code is now always 200.

Converting Quotes to Orders Sales Order Quotes can be converted to full Sales Orders using the new salesorder/convertquotetoorder/{id} endpoint.

This endpoint is available for POST calls only, and is called passing in the id of the Sales Order Quote to convert. If successful, it returns a new Sales Order object. If the status of the specified Sales Order isn’t 3 (Quotation), the endpoint will return an error.

Companies The following attributes have been added to the company endpoint:


balance float yes The company’s current balance.

contactname string yes The name of the company’s default contact.

latitude float yes The company’s latitude.

longitude float yes The company’s longitude.

geocodestatus integer yes Whether or not location details have been successfully retrieved for the company: • -1 or NULL – no attempt has been made to retrieve

details • 0 – details successfully retrieved • 1 or greater – an error occurred during the attempt


Latitude, longitude and geocodestatus attributes have also been added to the following endpoints:

• contact • debtor • prospect

Note: To make full use of these new geolocation attributes, you must upgrade the EXO Business database using the EXO OnTheGo Configurator—see “Updating the EXO Business Database” on page 8. Geolocation features will be supported in the EXO Business system from 8.7 SP2.

Filtering and Ordering Several endpoints now support filtering and ordering operations on the returned data. These formatting of these operations is based on the OData protocol, although the EXO API does not support all of OData. See http://odata.org for information and documentation on the OData protocol.

Note: Filtering and ordering options are case-sensitive. The attributes and operators listed in the sections below must be capitalised as they appear.

Filter You can now filter results by adding the $filter option to API calls. The $filter option is used with the following syntax:

$filter=Attribute operator value

Where Attribute is the endpoint attribute to filter by and operator is one of the supported operators:

• eq – Equals • ne – Not Equals • gt – Greater Than • ge – Greater Than or Equal • lt – Less Than • le – Less Than or Equal • and – And • or – Or

The and and or operators can be used to build a filter string that contains multiple Attribute operator value combinations.


http://odata.org/

The following table lists all endpoints that can be filtered and the attributes they can be filtered by:

Example: https://exo.api.myob.com/debtor?$filter=Active eq true and Balance gt 0.00

This call will return all active Debtor accounts with a balance greater than zero.

Note: Filters use the endpoint’s attributes, not the EXO Business database fields they relate to. For example, while the ACTIVE field in the DR_ACCS table is a char(1) value which can be “Y” or “N”, the Active attribute of the debtor endpoint is a Boolean value, which can be true or false.

Order By You can now order results by adding the $orderby option to API calls. The $orderby option is used with the following syntax:

$orderby Attribute {direction}

Where Attribute is the endpoint attribute to order results by and direction is either asc or desc to specify ascending or descending order. If no direction is specified, the ordering defaults to ascending.

Multiple attributes can be specified, separated by commas—the returned results will be order by the first attribute specified, then by the second and so on.

Endpoint Attributes

company Active, SalesPersonId

debtor Active, SalesPersonId, Balance

debtor/{id}/transactions StatusId, TransactionTypeId

debtor/{id}/historynote SalesPersonId

prospect Active, SalesPersonId

stock Active

stockItem Active

bom Active

salesorder Status, SalesPersonId

contact Active, SalesPersonId


The following table lists all endpoints that can be ordered and the attributes they can be ordered by:

Examples: https://exo.api.myob.com/debtor?$orderby AccountName desc

This will return all Debtor accounts in descending order of account name. https://exo.api.myob.com/salesorder?$orderby Status asc, Id asc

This will return all Sales Orders ordered by status (ascending) and then ordered by ID (ascending).

Decimal Places in Schemas The GETFORM schemas for the salesorder, debtor and stockitem endpoints now specify the lengths and number of decimal places for fields where appropriate.

Floating point fields now specify, in addition to other attributes:

• precision – this is the total number of digits the field supports • scale – this is the number of decimal places the field should display

Where relevant, the value of the scale attribute is taken from the decimal place settings in the Business Essential > General Settings section of the EXO Configurator.

Endpoint Attributes

company AccountName, CompanyType, Id

debtor AccountName, Balance, Id

debtor/{id}/transactions DueDate, InvoiceNumber, Amount, OutstandingAmount, TransactionTypeId

debtor/{id}/historynote Date, SalesPersonId, Subject

prospect AccountName, Id

stock Stockcode, Description

stockitem Stockcode, Description

bom Stockcode, Description

salesorder Id, Status, DueDate, AccountName

contact Fullname


Resolved Issues Service Request ID Description

- When creating a new Contact via the EXO API, some fields defaulted to incorrect values if a value was not specified for them. This has been resolved.

- An error would be returned if the pagesize parameter was specified with a value of zero. This has been resolved; specifying ?pagesize=0 will now return results using the default page size of 10.


Known Issues The following issues have been identified as requiring end-user attention in this release.

Timeout Issues The API communicates using HTTP; any request that takes more time to complete than the standard HTTP timeout period will fail. This may include search operations that would return a large set of results or operations on transactions like Sales Orders that have a large number of lines. How large an operation has to be before it times out will depend in part on the speed of the EXO Business database server, network connectivity, etc.


Documents

MYOB EXO Business Services Release 1.0 SP1 Noteshelp.myob.com.au/exo/onthego/releasenotes/11/MYOB... · MYOB has carefully prepared this material but excludes (to the extent allowed