Web Services: Support of OpenAPI 3.0

MYOB Acumatica 2025.1 now provides the OpenAPI 3.0 schema instead of the OpenAPI 2.0 schema. For details about OpenAPI 3.0, see OpenAPI Specification v3.0.1.

OpenAPI 3.0 of an Endpoint

A developer can retrieve the OpenAPI 3.0 schema of a contract-based API endpoint by clicking OpenAPI 3.0 on the More menu of the Web Service Endpoints (SM207060) form, as shown in the following screenshot.

Figure 1. The Open API 3.0.1 command

The developer can also retrieve the OpenAPI 3.0 schema of a contract-based API endpoint by using the following URL.

http://<Base endpoint URL>/swagger.json?company=<Tenant name>

In this URL, <Base endpoint URL> is the URL of the contract-based endpoint through which the developer is going to work with MYOB Acumatica, such as http://localhost/AcumaticaDB/entity/MyEndpoint/24.200.001/swagger.json?company=MyTenant. The developer can specify the company URL parameter to obtain information on the API of the endpoint available in a particular tenant.

OpenAPI 3.0 of an Instance

The developer can retrieve the OpenAPI 3.0 schema of an MYOB Acumatica instance by using the following URL.

http://<MYOB Acumatica instance URL>/entity/swagger.json

For example, if the developer uses a local instance with the name AcumaticaU100, they would retrieve the swagger.json file related to this instance by using the following URL: http://AcumaticaU100/entity/swagger.json.