Skip to main content
Answer

Generic Inquiry via OData - Friendly Names and Extra Fields

  • July 19, 2025
  • 3 replies
  • 63 views
B
Varsity II
Forum|alt.badge.img

Is there a way to adjust the metadata of a generic inquiry exposed via OData?  I have a simple customer balance inquiry that an external CRM system will use to get an account’s balance.  The friendly names of the parameters are “Company” and “Customer”, but the OData field names are “BranchID_2” and “Account”, respectively.  Also, the response includes fields that aren’t in the Results grid of the inquiry.  Why? Presumably because they are fields used in the joins and aggregation, but there’s no need for them to be in the response as it just adds clutter.  Thanks.

 

Best answer by bbohn

Hi ​@bbohn 

In my experience, the extra fields are the primary key fields from the exposed tables.  I assume Acumatica includes these in OData feeds to guarantee each record can be uniquely identified.

If you want to get rid of them, you can use the $select parameter.  This will limit the results to include only the fields you specify.

For example, if you add the following to your URL:

$select=Account,AccountName,CurrentBalance

only these three fields will be returned.

Source:

https://help.acumatica.com/Help?ScreenId=ShowWiki&pageid=ecbfdb12-4853-4ff5-b8c5-eade02f9b47b

Thanks for the link and the example.  That works perfectly, although it’s cumbersome and hard to justify to a developer why they need to specify the additional constraint.  Appreciate the help.

    3 replies

    B
    Varsity II
    Forum|alt.badge.img
    • bbohn
    • Author
    • Varsity II
    • July 21, 2025

    We’re currently on 2024R1 while implementing.  I figured out from other posts that before 2025R2, Acumatica ignores parameters and filters after-the-fact, so it makes sense that the field names in the filter specification need to match the names of the fields from the Results grid.  I suppose we’ll have to wait for 2025R2 to use the actual parameter names with the “_WithParameters” extension in the url.  I would still like to understand why Acumatica adds extra fields to the OData response that are not in the Results grid.  Thanks.

    S
    Jr Varsity III
    Forum|alt.badge.img+2

    Hi ​@bbohn 

    In my experience, the extra fields are the primary key fields from the exposed tables.  I assume Acumatica includes these in OData feeds to guarantee each record can be uniquely identified.

    If you want to get rid of them, you can use the $select parameter.  This will limit the results to include only the fields you specify.

    For example, if you add the following to your URL:

    $select=Account,AccountName,CurrentBalance

    only these three fields will be returned.

    Source:

    https://help.acumatica.com/Help?ScreenId=ShowWiki&pageid=ecbfdb12-4853-4ff5-b8c5-eade02f9b47b

    Chris Hackett
    B
    B
    Varsity II
    Forum|alt.badge.img
    • bbohn
    • Author
    • Varsity II
    • Answer
    • July 22, 2025

    Hi ​@bbohn 

    In my experience, the extra fields are the primary key fields from the exposed tables.  I assume Acumatica includes these in OData feeds to guarantee each record can be uniquely identified.

    If you want to get rid of them, you can use the $select parameter.  This will limit the results to include only the fields you specify.

    For example, if you add the following to your URL:

    $select=Account,AccountName,CurrentBalance

    only these three fields will be returned.

    Source:

    https://help.acumatica.com/Help?ScreenId=ShowWiki&pageid=ecbfdb12-4853-4ff5-b8c5-eade02f9b47b

    Thanks for the link and the example.  That works perfectly, although it’s cumbersome and hard to justify to a developer why they need to specify the additional constraint.  Appreciate the help.

    Chris Hackett
    Terms & ConditionsCookie settingsAccessibility statement
    About Acumatica ERP system
    Acumatica Cloud ERP provides the best business management solution for transforming your company to thrive in the new digital economy. Built on a future-proof platform with open architecture for rapid integrations, scalability, and ease of use, Acumatica delivers unparalleled value to small and midmarket organizations. Connected Business. Delivered.
    © 2008 — 2024  Acumatica, Inc. All rights reserved