Best Way to learn REST API


I can see the power of what the REST API could do.

What I want is some guidance on how to go about learning more as the whole thing is huge.

I have read “Epicor Kinetic - Classic User Interface. Epicor REST Services v.2” guide and understand that. I am familar with POST and GET.

Is there a guide to what all fields and records types are in the REST API? The OData Erp.BO.APInvoiceSvc/APInvoices POST has over 2800 fields but I don’t know what is required and what can be ignored (and I understand that every implementation is probably different). I also understand that there are arrays of records but not all are required.

My end goal (ambitious!) is to build some simplified user interfaces outside of Epicor to make loading data easier.

Complicating this is I am using Kinetic Cloud so no on-premises system so not local development environment.



Hello ! I’m using API quite a bit and have found if you do a trace, or look at the developer tools in your web browser, you can see what requests and responses are sent and received, you can use this to pick out the fields you need to send, then replicate this in Postman.

1 Like

Don’t forget the REST Help Swagger interface, that pretty much should give you what you are looking for. You should be able to access your test environment. Even for cloud.


With a little thought, and ingenuity, it won’t even slow you down.


REST is just a window. The real power is in the business objects (BPMs), BAQs, Functions… etc
Some nice data tools in the ODATA interfaces though.

My advice is to spend a lot of time tracing things in the smart client, or as a fallback,
use the browser client and the network tab.

Don’t just watch what Epicor does, but how Epicor does things.
You’ll get a feel for it pretty quick I bet.

This forum is a GREAT resource. To be honest, it’s the only reason I code so
much in Epicor. Always something new to learn, and someone new (or old) to learn from.

There are some good posts here on REST, Functions, Etc. Some are getting a bit dated, but
I’ve found almost everything still applies. It is a product in flux after all, so you have to expect
some changes every now and then.

I’m sure there are a few people here who can provide some links to actual documentation if
said documents exist. (I’m a disorganized mess, I just use Inspect Will Smith GIF in the upper right :rofl: )


Thanks to all.

1 Like