Point of Sale API notes
There is one API for the whole platform. There is no separate POS API, and no separate host for
it: every request mapping the backend serves is under /core2/ on api.akaun.com.
For the path grammar, access endpoints, authentication, paging, response envelopes and error codes, see the developer integration path. The generated route reference for sales documents, which the cash bill shares, is the Sales API.
The cash bill is reachable through the generic document endpoints by its server document type,
INTERNAL_SALES_CASHBILL, and the POS General page
names the four API permissions it needs. The other sales document types are the
Sales module’s.
A bill created through the API is not checked the same way as one rung up on screen. Some
validations at the till are client-side only. An integration that posts cash bills directly must
apply those rules itself — including the rule that settlement must equal the lines, which the till
satisfies with the rounding adjustment item.
Last updated on