Firstly, a few quick thank yous to @ajkauffmann and @evanidus1 for working on this with me as authors. And a "big thank" you to @KennieNP for agreeing to write a foreword for us (along with many great tips).
Now, what's inside?
We have detailed examples endpoint-by-endpoint for each of the HTTP actions that are valid, of course.
We have a master list of all the endpoints and when actions are valid, along with what BC Page/Report they relate to.
For each endpoint, we cover the hard-to-find information about what precisely changed for which versions of BC (future blog post about how we pulled this off later this year):
For each endpoint, we do a detailed field-by-field mapping from endpoint field to BC screen field:
A common issue when working with the API v2.0 is that there are sometimes restrictions of what data is visible depending on the data settings. We carefully documented all of these criteria that can save you a significant amount of time.
Often the BC API is something worked with by Non-Business Central teams, such as #PowerPlatform integrators or web development shops. We provide explainers about what the data structure is for some of the more confusing-to-Non-BC endpoints:
And if that wasn’t enough… What precisely IS going on with Sales and Purchase Documents under the hood?
And we even have a masterwork of a chapter by Arend-Jan Kauffmann, covering not only how OAuth and App Registrations work, but detailing:
• Desktop Application Scenarios
• Web Application Scenarios
• Background Application Scenarios
This ~500 page production has been underway for over a year in the making to ensure we cover as much as we can with all the details that tend to cause the biggest challenges (such as Attachments, Dimensions, and Pictures).
For now, this is available exclusively as an eBook on our site at:
sparebrained.com/books/business-central-api-reference/
We are working diligently to lay this out in a physical copy for easy flipping through and bookmarking later this year.
And of course, as we do updates to the book over time, buyers of the eBooks will get the new version automatically.
It is our hope you'll agree with Kennie: "This book should be in the local library for any serious Business Central partner practice out there."