Building on it
Reports
All reports are plain API calls; the console is one consumer of them. Times are Nigerian time (WAT, UTC+1) and money is in kobo.
For a merchant#
| Report | Call |
|---|---|
| Sales, grouped | `GET /v1/merchants/{id}/reports/sales?groupBy=Day |
| Same, as a spreadsheet | add &format=csv |
| End of day (Z report) | GET /v1/merchants/{id}/reports/z?date=2026-11-16&branchId=… (or shiftId) |
| Stock value | GET /v1/merchants/{id}/inventory/valuation?detail=true |
| Stock movements | GET /v1/merchants/{id}/inventory/movements?reason=…&from=…&to=… |
| Oversells | GET /v1/merchants/{id}/oversells (then POST …/oversells/{id}/acknowledge) |
| Refused terminal submissions | GET /v1/merchants/{id}/rejections |
| Reconciliation | GET /v1/merchants/{id}/reconciliation/summary?date=… and …/exceptions |
| Individual sales | GET /v1/merchants/{id}/sales, GET …/sales/{saleId} (the full receipt) |
A sales row has sales, quantity, grossKobo, discountKobo, taxKobo, refundedKobo, netKobo, and costKobo for products (so margin is netKobo - costKobo).
For an operator or reseller#
GET /v1/reports/network?groupBy=Merchant|Terminal|Day&from=2026-11-01&to=2026-11-16 covers everyone beneath you. Merchants and terminals with no sales in the period are included and
flagged, so an idle device is as visible as a busy one. Maximum 93 days.
For platform staff#
GET /v1/reports/platform?days=14: organisations, terminals by status, volume per operator, daily volume, webhook delivery health, custom-domain status.
Webhooks instead of polling#
If you would rather be told than ask, subscribe to webhooks: sale.created, sale.returned, stock.low, transaction.unmatched, import.completed.