Contract-Based REST API

The contract-based REST API operates with business logic objects that do not depend on MYOB Acumatica forms or their properties and methods. (In this context, contract-based means based on the object model that the REST API provides.) Each REST API contract is fixed and does not change based on system customization, localization, or any other changes made to MYOB Acumatica.

For example, suppose that the contract of the web service contains the definition of the CustomerID field, which accesses the Customer ID element on the Customers (AR303000) form. If you have changed the name of the Customer ID element to Customer Identifier in a customization project, the contract of the web service remains fully functional and does not require update; also, your application requires no further modifications. You can access the Customer Identifier element on the form through the same CustomerID field.

After that, you can use the REST API in your application. For examples of the REST API requests, see REST API Examples.