API Reference

There is one API for the whole platform. There is no separate Sales 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 this module’s resources is the Sales API.

The document types this module produces are reachable through the generic document endpoints, by their server document type — INTERNAL_SALES_INVOICE, INTERNAL_SALES_ORDER, INTERNAL_SALES_QUOTATION, INTERNAL_SALES_RETURN, INTERNAL_SALES_CREDIT_NOTE, INTERNAL_SALES_DEBIT_NOTE, INTERNAL_SALES_REFUND_NOTE — and each applet’s reference page names the four API permissions that document type needs. The retail cash bill, INTERNAL_SALES_CASHBILL, is the Point of Sale module’s.

A document created through the API is not checked the same way as one created on screen. Some validations in this module are client-side only — the rule that a refund note’s line total must equal its settlement total, for instance, is enforced in the browser and not by the backend. An integration that posts documents directly must apply those rules itself.