Skip to main content
Solved

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

  • January 24, 2023
  • 8 replies
  • 1048 views

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

jinin wrote:

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
Did this topic help you find an answer to your question?

8 replies

jinin
Pro I
Forum|alt.badge.img+11
  • Pro I
  • 701 replies
  • January 24, 2023

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
,

 

 


Forum|alt.badge.img
  • Author
  • Jr Varsity II
  • 20 replies
  • Answer
  • January 24, 2023
jinin wrote:

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!


  • Freshman I
  • 8 replies
  • August 23, 2023

  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 


jinin
Pro I
Forum|alt.badge.img+11
  • Pro I
  • 701 replies
  • August 23, 2023

Hi @chvakhil ,

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


  • Freshman I
  • 8 replies
  • August 23, 2023

User Defined Custom Field showing on the UI:

 

Element Properties:

 


  • Freshman I
  • 8 replies
  • August 23, 2023
chvakhil wrote:

User Defined Custom Field showing on the UI:

 

Element Properties:

 

 

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


jinin
Pro I
Forum|alt.badge.img+11
  • Pro I
  • 701 replies
  • August 23, 2023

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.

Forum|alt.badge.img
  • Varsity II
  • 123 replies
  • October 14, 2024

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

 


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings