OpenAPI 2.0

MYOB Acumatica provides you with the contract-based REST APIs of web service endpoints and with the contract-based REST API of an MYOB Acumatica instance. The methods of a REST API are provided in a swagger.json file, which is an OpenAPI 2.0 (formerly known as Swagger 2.0) file. For more information about the OpenAPI specification, see https://www.openapis.org. You can use the swagger.json files to review the APIs of the instance and endpoints and build the client applications for MYOB Acumatica based on these files.

OpenAPI 2.0 of a Web Service Endpoint

You can retrieve the swagger.json file of a web service endpoint by clicking OpenAPI 2.0 on More menu of the Web Service Endpoints (SM207060) form or by using the following URL.

http://<Base endpoint URL>/swagger.json

In this URL, <Base endpoint URL> is the URL of the contract-based endpoint through which you are going to work with MYOB Acumatica. This URL has the following format.

http://<MYOB Acumatica instance URL>/entity/<Endpoint name>/<Endpoint version>/

You can specify the company URL parameter to obtain information on the API of the endpoint available in a particular company. For example, suppose that you want to retrieve the API reference of the custom endpoint with the name MyEndpoint and Version 23.200.001 available in the MyCompany company from a local MYOB Acumatica instance with the name AcumaticaDB. You would use the following URL to obtain the swagger.json file: http://localhost/AcumaticaDB/entity/MyEndpoint/23.200.001/swagger.json?company=MyCompany.

If no company is specified, the API of the endpoint available in the company to which the user is currently logged in is returned.

OpenAPI 2.0 of an Instance

You can retrieve the swagger.json file of an MYOB Acumatica instance by using the following URL.

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

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