Platform: Availability of Generic Inquiry Parameters in OData

In previous versions of MYOB Acumatica, generic inquiries with required parameters could not be exposed through OData. In MYOB Acumatica 2024.1.1, an implementation consultant or a developer can work with generic inquiries with parameters through OData Version 3.0, as described in the following sections.

Retrieval of the List of Generic Inquiries and Their Parameters

An implementation consultant or a developer retrieves the list of generic inquiries that are exposed through OData with their fields and parameters as described in Access to Generic Inquiries Through OData: General Information. For example, the following request retrieves the list of generic inquiries exposed through OData from the U100 tenant of the 2023R2 local instance of MYOB Acumatica.

GET https://localhost/2023R2/odata/U100/$metadata

Note:

This example is for a local install of Acumatica. Update the URL to match your MYOB Acumatica site.

If the instance includes generic inquiries with parameters that are exposed through OData, the response includes the FunctionImport items, as shown in the following screenshot. A FunctionImport item specifies the name of the exposed generic inquiry that is used in an OData request and the list of parameters.

Definition of the Parameter Values Through OData

To specify the values for the parameters of a generic inquiry and obtain the result of the generic inquiry, the implementation consultant or developer specifies the values of the parameters of the generic inquiry in the parameters of the HTTP request.

For example, the following request obtains the results of the DB-StorageDetailsByItemWarehouseLocation generic inquiry for the WHOLESALE warehouse.

GET https://localhost/2023R2/odata/U100/
          DBStorageDetailsByItemWarehouseLocation_WithParameters
          ?Warehouse=WHOLESALE

Note:

This example is for a local install of Acumatica. Update the URL to match your MYOB Acumatica site.

Definition of the Parameter Values in Excel

The implementation consultant can obtain the results of the generic inquiry with parameters in Microsoft Excel. The implementation consultant loads the results of the generic inquiry to an Excel workbook, as described in Access to Generic Inquiries Through OData: To Access an Exposed Inquiry in Microsoft Excel. In the Navigator dialog box, which opens when the consultant configures Microsoft Excel to obtain the results of the generic inquiry, the consultant can specify the values of the parameters of the generic inquiry, as shown in the following screenshot.