Reports API

September 28, 2021


On this page

This REST API implements calls for retrieving reports.

It contains a much improved set of calls for assembling an X Report / Z Report (cashier's shift summary).

There is an article that explains how the different calls of Reports API correspond to sections on the standard X / Z Report that can be printed from back office.

Usage

To find the endpoint specific for your account, use the "getServiceEndpoints" call.

Each endpoint also provides Swagger documentation. For an example, see the documentation provided by the sandbox endpoint:

https://api-reports-eu10.erply.com/documentation/index.html

Use an Erply client code and API session key to make requests. (Send these as headers "clientCode" and "sessionKey".)