Skip to main content
Solved

API Endpoint Definitions - Developer Setup


Hi All, 

 

I've gone through the I300, I310, I320, and I330 PDFs and have a decent grasp of the API. I am the only person in my Org who will be working on implementing functionality using the REST API.  

 

Are there any features or modules that my admin should enable for development purposes? I have access to customizations so I can see the Element Properties when I hold down ctrl + alt. I have access to the DAC Schema Browser. I can see all of the Endpoints available. I have referenced the swagger endpoint docs. Is there anything else I should have access to or should review? 

 

One example of a problem i’ve run into is understanding what arguments are required when hitting an endpoint.  For example the endpoint action bills/releasebills I was able to eventually figure out that I needed to pass the api call in this format:

{

“entity”: {

        “Type”: {“Value”:”Bill”},

        “ReferenceNbr”: {“Value”: “123”}

}

}

 

Where can I reference what each endpoint is expecting? 

 

Thank you

 

 

Best answer by Vignesh Ponnusamy

Hi @ExcelPerf,

I don’t think we such documentation as of now.

But you should be able to check the key field by inspecting the DAC of the specific screen. For example, you can inspect any field in the SO screen and select the DAC to see the key fields of the SOOrder DAC. Below is the screenshot of the option,

  

 

This should help you identify the key fields/parameter for the actions in the screen. 

View original
Did this topic help you find an answer to your question?

4 replies

Vignesh Ponnusamy
Acumatica Moderator
Forum|alt.badge.img+5

Hi @ExcelPerf,

I am not sure if its mentioned in course/documentation, request parameters should have fields(usually key fields) that is required to identify the document that you are targeting. For the bills and adjustments screen, as you mentioned it is the Type and ReferenceNbr, and it would change for other screens(would be the key fields for that specific screen).

Hope that clarifies. Feel free to post back if you have any questions.!


  • Author
  • Freshman I
  • 4 replies
  • July 29, 2024
Vignesh Ponnusamy wrote:

Hi @ExcelPerf,

I am not sure if its mentioned in course/documentation, request parameters should have fields(usually key fields) that is required to identify the document that you are targeting. For the bills and adjustments screen, as you mentioned it is the Type and ReferenceNbr, and it would change for other screens(would be the key fields for that specific screen).

Hope that clarifies. Feel free to post back if you have any questions.!

 

Is there documentation that specifies the required request parameters for each endpoint? 


Vignesh Ponnusamy
Acumatica Moderator
Forum|alt.badge.img+5

Hi @ExcelPerf,

I don’t think we such documentation as of now.

But you should be able to check the key field by inspecting the DAC of the specific screen. For example, you can inspect any field in the SO screen and select the DAC to see the key fields of the SOOrder DAC. Below is the screenshot of the option,

  

 

This should help you identify the key fields/parameter for the actions in the screen. 


  • Author
  • Freshman I
  • 4 replies
  • August 2, 2024

Thank you.  This is helpful 


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