OData URL from an Acumatica Instance

Owned by Cortlandt _
Last updated: Mar 21, 2024
2 min read

How to put together a OData URL from an Acumatica instance. How to find the core Acumatica URL.

Acumatica URLs (portals and OData) are NOT case sensitive. 

OData URL from Single-tenant Acumatica

The OData URL is constructed by adding the suffix odata or odatav4 to the core Acumatica URL.

How to Find your Core Acumatica OData URL from Single-tenant Acumatica

  1. Log in to your Acumatica tenant in a web browser.

    • The login page of a single-tenant Acumatica only prompts for a user name and password. There is not a Select a tenant dropdown menu.

  2. Examine the URL shown on the web browser after logging in.   
    The URL  should end with a suffix such as 'Main' or '(W(n))/Main' and maybe strings after the word Main.
    The string before the suffix is your core Acumatica single-tenant URL.

Core Acumatica URL Examples:   The core URL is shown in bold/

How to Build Your OData URL

The OData URL is constructed by adding the suffix odata for OData v3, or odatav4 for OData v4 to the core Acumatica URL.

Example.  Based on the examples above, the OData URL is:

  1. OData v3: https://acu.abc.com/DB_2022R2/odata

  2. OData v4: https://acu.abc.com/DB_2022R2/odatav4

OData URL from a Multi-tenant Acumatica

The login page of a multi-tenant Acumatica has a Select a tenant dropdown menu, and prompts for a user name and password. 

how to put together the OData URL from an Acumatica instance.

How to Find your Core Acumatica OData URL from Multi-tenant Acumatica

  1. Log in to one of your Acumatica tenants using a web browser.

  2. Once you are logged to Acumatica, go to Finance → Journal Transactions.

  3. You'll see the URL on the web browser's with something like the examples below. 
    Examples.  Your core Acumatica URL is comprised of the segments in bold.

    1. Example 1: Full URL: https://acu.abc.com/(W(2))/Main?CompanyID=TenantId&ScreenId=GL3010PL

      1. Acumatica core URL: https://acu.abc.com/TenantId/

    2. Example 2: Full URL: https://acu.abc.com/DB_2022R2/(W(2))/Main?CompanyID=TenantId&ScreenId=GL3010PL

      1. Acumatica core URL: https://acu.abc.com/DB_2022R2/TenantId/

  4. The OData URL puts  odata for OData v3, or odatav4 for OData v4 between the core Acumatica URL and the TenantId.
    Example.  Continuing from the Example 1 above:

    1. OData v3: https://acu.abc.com/odata/TenantId

    2. OData v4: https://acu.abc.com/odatav4/TenantId

How to Build Your Multi-tenant OData URL

Work in progress - Put step #4 above here?

Notes

  • (W(n)): some sites will show these two URL segments, some sites will not.

  • (W(n)) where n = integer. 

  • When the tenant name has spaces, the Acumatica URL will replace them with '+'. However, use %20 instead of +  for the OData URL.
    Examples:

    • Acumatica URL: https://acumatica.com/Main?CompanyID=DataSelf+ETL+Plus&ScreenId=DB000031

    • OData URL: https://acumatica/odata/DataSelf%20ETL%20Plus/

  • The URL works with the regular table name appended. But it will not work with the full DAC name (example: PX_Objects_PO_POLine)
    In ETL+, when you change the DAC table name between a tables and its PX_Objects sibling, you might have to update/re-add the SQL statement (column list). These two DAC tables might NOT have exactly the same column list.