Platform: New URLs for OData

MYOB Acumatica provides the following types of OData interfaces:

  • The OData interface that retrieves data from generic inquiries. This interface is called generic inquiry–based.
  • The OData interface that retrieves data from data access classes (DACs). This interface is called DAC-based.

As a part of the migration to .NET Core, MYOB Acumatica 2024.2.1 introduces new URLs for these OData interfaces.

Important:
The URLs that were supported in previous versions of MYOB Acumatica will continue to work until the release of MYOB Acumatica 2025 R2. We strongly recommend that a technical specialist update the applications to use the new URLs.

URL for the Generic Inquiry–Based OData Interface

The URL for the generic inquiry–based OData interface is <MYOB Acumatica instance URL>/t/<TenantName>/api/odata/gi.

For example, a technical specialist would specify the http://sweetlife.com/erp/t/U100/api/odata/gi/$metadata URL if the following are true:

  • The URL of the MYOB Acumatica instance is http://sweetlife.com/erp .
  • The instance contains the U100 tenant.
  • The technical specialist wants to obtain the list of fields and parameters in exposed generic inquiries in this tenant.

Other Changes to the Generic Inquiry–Based OData Interface

In addition to the new URL of the generic inquiry–based OData interface, a technical specialist can find the following changes in requests to this URL:

  • The interface is based on the OData Version 4.0 protocol.
  • The $format URL parameter is no longer supported. Now almost all requests return data in JSON format. An exception is the request for the list of field and parameters of generic inquiries, which returns data in XML format. (This request uses the <MYOB Acumatica instance URL>/t/<TenantName>/api/odata/gi/$metadata URL.).
  • The type of date and time fields has been changed to DateTimeOffset. Therefore, if the technical specialist needs to filter records by a date and time field, the technical specialist specifies a string similar to the following in the filter: LastModifiedOn gt 2024-05-08. (In previous versions, this filter has been specified as follows: LastModifiedOn gt datetime'2024-05-08'.)
  • A request for $metadata returns an additional attribute, Scale="Variable", for the fields of the Decimal type, as shown in the following example.
    <Property Name="QtyOnHand" Type="Edm.Decimal" Scale="Variable" />

  • For each exposed generic inquiry with parameters, the response includes a Function element, which specifies the list of parameters of the generic inquiry.

URL for the DAC-Based OData Interface

The URL for the DAC-based OData interface is <MYOB Acumatica instance URL>/t/<TenantName>/api/odata/dac.

For example, a technical specialist would specify the http://sweetlife.com/erp/t/U100/api/odata/dac/$metadata URL if the following are true:

  • The URL of the MYOB Acumatica instance is http://sweetlife.com/erp .
  • The instance contains the U100 tenant.
  • The technical specialist wants to obtain the list of data access classes (DACs), their fields, and the relationships between DACs in this tenant.