Retrieve Localized Values of All Multilingual Fields

For some text boxes on MYOB Acumatica forms, users can type values in multiple languages if multiple locales are configured in MYOB Acumatica. For example, if your MYOB Acumatica instance has the English and French locales activated and multilingual user input configured, you can specify the value of the Description box on the Stock Items (IN202500) form in English or French.

In this topic, you can learn how to retrieve localized values of all requested multilinqual fields.

HTTP Method and URL

If you need to retrieve the list of records that satisfies the specified conditions, you use the GET HTTP method and the following URL.

GET http://<Base endpoint URL>/<Top-level entity>

The URL has the following components:

<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>/.
<Top-level entity> is the name of the entity for which you are going to retrieve the list of records.

For example, suppose that you want to retrieve the list of stock item records from a local MYOB Acumatica instance with the name AcumaticaDB by using the system endpoint with the name Default and Version 23.200.001. You should use the following URL to retrieve the list of records.

http://localhost/AcumaticaDB/entity/Default/23.200.001/StockItem

Parameters

You retrieve all localized values of all requested fields by adding the $expand=Translations parameter to the request.

Request Headers

You can specify the following header in the request.


Header	Description
Accept	Specifies the format of the response body, which should be application/json.

Response Status Codes

The following table lists the HTTP status codes that the system returns for a request that retrieves records by conditions.


Code	Description
200	The request has been completed successfully. The response body contains the list of records that satisfy the specified conditions.
401	The user is not signed in to the system.
403	The user has insufficient rights to access the MYOB Acumatica form that corresponds to the entity.
429	The number of requests has exceeded the limit imposed by the license (see License Restrictions for API Users).
500	An internal server error has occurred.

Example

You can also use the following request to retrieve all localized values on the Stock Items form.

GET ?$expand=Translations HTTP/1.1
Host: [<Acumatica ERP instance URL>]/entity/Default/23.200.001/StockItem
Accept: application/json
Content-Type: application/json

Suppose that the default language is English. If for a particular record, the Description element of the Stock Items form has the value Item in English and Pièce in French (as in the previous example), the response has the following data for this record.

...
"Description": {
    "value": "Item",
    "translations": {
        "en": "Item",
        "fr": "Pièce"
    }
...