Skip to main content
Solved

Fetching User-Defined-Field in Customer Acumatica REST-API

  • Jan 24, 2023 4:49 PM UTC
  • 8 replies
  • 1496 views
  • Translate All
Jr Varsity II
Forum|alt.badge.img

I'm trying to fetch the user-defined-field that I added in Customer Entity but it's not working. I'm getting this error: "message": "An error has occurred.", "exceptionMessage": "The column 'Document_AttributeCWCID' is not found in the data set.",

It is working in Contact entity and SalesOrder

My sample parameter in Contact $custom = Contact.AttributeCWCID

In SalesOrder: $custom = Document.AttributeSOID

Best answer by jayson

Hi @jayson ,

If the element is a user-defined field, use the syntax below,
 Document.Attribute<AttributeID>, where you replace <AttributeID> with the ID of the attribute that corresponds to the user-defined field.

I’ve tried it with the customer entity and works fine. 
Example,
/Customer/AACUSTOMER?$custom=Baccount.AttributePRODREQ
,

 

 

Thank you! I thought it should be Customer or Document instead of Baccount. Thanks!

View original

8 replies

jinin
Pro I
Forum|alt.badge.img+12
  • jinin
  • Pro I
  • Jan 24, 2023 6:04 PM UTC

Hi @jayson ,

If the element is a user-defined field, use the syntax below,
 Document.Attribute<AttributeID>, where you replace <AttributeID> with the ID of the attribute that corresponds to the user-defined field.

I’ve tried it with the customer entity and works fine. 
Example,
/Customer/AACUSTOMER?$custom=Baccount.AttributePRODREQ
,

 

 

Translate
Jini N
    Jr Varsity II
    Forum|alt.badge.img
    • jayson
    • Author
    • Jr Varsity II
    • Answer
    • Jan 24, 2023 7:17 PM UTC

    Hi @jayson ,

    If the element is a user-defined field, use the syntax below,
     Document.Attribute<AttributeID>, where you replace <AttributeID> with the ID of the attribute that corresponds to the user-defined field.

    I’ve tried it with the customer entity and works fine. 
    Example,
    /Customer/AACUSTOMER?$custom=Baccount.AttributePRODREQ
    ,

     

     

    Thank you! I thought it should be Customer or Document instead of Baccount. Thanks!

    Translate
      Freshman I
      • chvakhil
      • Freshman I
      • Aug 23, 2023 4:46 AM UTC

        Hi Team,

       

      I am a developer who is integrating Acumatica with our application as part of ERP integrations. As per the client requirement we have some custom user defined fields within the entities. 

       

      I am providing all the details i have with me on this so that you can help me out.

       

      User Defined Custom Field showing on the UI:

       

       

       

      Element Properties:

      I have found the properties of this element from Customization -> Inspect Element

       

       

       

       

      Requirement:

      I would like to know the API signature on how to access this type of fields from RESP APIs.

       

      Note:

      As we have client deliverables, i would really appreciate a quick response. 

       

      Acumatica Version: 22R2

      Endpoint Version: 22.200.001

       

      Thanks & Regards,

      Akhil Chakicherla 

      Translate
      jinin
      Pro I
      Forum|alt.badge.img+12
      • jinin
      • Pro I
      • Aug 23, 2023 4:54 AM UTC

      Hi @chvakhil ,

      Can you please share the screenshot? It's not visible.

      Translate
      Jini N
      Freshman I
      • chvakhil
      • Freshman I
      • Aug 23, 2023 6:40 AM UTC

      User Defined Custom Field showing on the UI:

       

      Element Properties:

       

      Translate
      Freshman I
      • chvakhil
      • Freshman I
      • Aug 23, 2023 6:42 AM UTC

      User Defined Custom Field showing on the UI:

       

      Element Properties:

       

       

      @jinin - I have added the snapshots again. Please have a look.

      Translate
      jinin
      Pro I
      Forum|alt.badge.img+12
      • jinin
      • Pro I
      • Aug 23, 2023 10:51 AM UTC

      Hi @chvakhil ,

      Please do the below steps

      -  Navigate the Web service endpoint screen, select the Salesorder entity, and select the details section as shown below
       


      -   click on the Extend entity and again click on the populate. A popup will open. Select the Details view and Choose the user field.


      • -  Close the popup and check the grid, the value will be added on the grid. Save the screen.
        - Add the field  on the Endpoint same as other field (Use the proper name added on the endpoint) and check whether its reflected or not.

        Hope this helps you.
      Translate
      Jini N
        Captain I
        Forum|alt.badge.img+3
        • tahayabali
        • Captain I
        • Oct 14, 2024 6:06 PM UTC

        Hi I am trying to get the UDF as per the instructions above but UDF value is null even it is present inthe Acumatica.

        My query: http://localhost/entity/Default/22.200.001/Customer?$filter=CustomerID eq '000002'&$custom=Baccount.AttributeAGDCRAN

         

        Translate
        Taha Yab Ali
        Terms & ConditionsAccessibility 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