web
You’re offline. This is a read only version of the page.
close
Skip to main content

Notifications

Announcements

No record found.

Community site session details

Community site session details

Session Id :
Finance | Project Operations, Human Resources, ...
Unanswered

Documentation question about OData EndPoints

(0) ShareShare
ReportReport
Posted on by 9

Sorry, newbie question...

https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/ contains lots of documentation on the calls and endpoints. I have been able to issue a few (such as SalesOrderLines). Yet many endpoints are missing / undocumented and bring up few to no results in Google.

I realize many entities are specific to our org, but I feel like I'm still missing what might be common endpoints (example: DataManagementExecutionJobs).

Can anyone point me to a resource I may have overlooked?

I have the same question (0)
  • Martin Dráb Profile Picture
    237,990 Most Valuable Professional on at

    You're asking in a forum about "Finance and Operations", but the link points to Business Central documentation. Which product do you actually mean?

  • KennethH Profile Picture
    9 on at

    Hi, yes, finance. The link was only an example of rich documentation of other endpoints

  • Martin Dráb Profile Picture
    237,990 Most Valuable Professional on at

    All right, so you understand that you can't look for F&O entities in BC documentation.

    While the linked documentation gives you some details, it's not actually that informative. Yes, there is a page about each operation of each entity, but it's almost the same in all cases, because the structure is defined by OData and the only thing that differs is the name of the entity. The documentation is (I believe) generated from Open API specification.

    One useful thing there is an example of data (e.g. in Create purchaseOrders), nevertheless if you have an existing record, you can export it to get an example.

    Would it be possible to generate such documentation? Yes. The list of entities, labels, fields etc. can be easily obtained from metadata. It would just need some solution for the sample data. Is there any such documentation already generated? No, at least I'm not aware of it.

    I'm a big fan of Open API specification and I would love if it was available for all web services exposed from F&O - it gives you documentation, but it has several more benefits. It's not that useful for CRUD operations on entities, because they're all the same, but it would help a lot with custom services and OData actions. I discussed this topic in Open API for JSON-based custom services in AX 7. Sadly, no such a thing is available.

    If you tell us what kind of information you're looking at, we might be able to tell you how to get it (or that it isn't available at all).

Under review

Thank you for your reply! To ensure a great experience for everyone, your content is awaiting approval by our Community Managers. Please check back later.

Helpful resources

Quick Links

Responsible AI policies

As AI tools become more common, we’re introducing a Responsible AI Use…

Neeraj Kumar – Community Spotlight

We are honored to recognize Neeraj Kumar as our Community Spotlight honoree for…

Leaderboard > Finance | Project Operations, Human Resources, AX, GP, SL

#1
Abhilash Warrier Profile Picture

Abhilash Warrier 669 Super User 2025 Season 2

#2
André Arnaud de Calavon Profile Picture

André Arnaud de Cal... 449 Super User 2025 Season 2

#3
Martin Dráb Profile Picture

Martin Dráb 384 Most Valuable Professional

Last 30 days Overall leaderboard

Product updates

Dynamics 365 release plans