API licences for MYOB Acumatica

API licences are used to give third-party software access to your MYOB Acumatica site. API licences are assigned to special user accounts, which allow you to limit their access like you would with real users (for example you can restrict an API user to the same data a Warehouse User or Payroll User licence has access to). 

There are two API licences in MYOB Acumatica:

• Full User API — A free licence with limited API calls, restricted to a single user
• Full Access API — A paid licence with unlimited API calls across many named users

While the number of calls and users is different, both licences can access the entire MYOB Acumatica system and maintain concurrent logins with a single API user.

When to get a paid licence

For any business critical integrations or if you have more than one integration, we recommend you use the paid Full Access API licence.

The free Full User API licence is only suitable for light integrations used for occasional reporting or testing purposes.

We also recommend you lock down the API licence for each individual integration via role management, to limit access permissions to the third-party developer based on what that specific integration needs via role management).

Comparison between the paid free API licenses

API requests

An API request is basically a query to MYOB Acumatica to search, retrieve, update, delete and create new entities in MYOB Acumatica Business. A single HTTP request of any type(POST, PUT, GET, DELETE), regardless of the payload, counts as a request. The following types of actions broadly create an API request:

• POST –to log in and log out of a site
• GET -  to search and retrieve entities defined in the endpoint
• PUT – To create new entities or update existing ones
• DELETE – to delete existing entities

API request examples

Retrieving

Updating/creating

Deleting

Login/logout

Polling (to check if something has changed in system)