Skip to content
Developers

Developers

Documentation for developers building on BigLedger. There are two different jobs here, with different toolchains and different starting points. Pick yours.

Build an applet
A screen that runs inside BigLedger, alongside the built-in ones. Angular, loaded by the shell at runtime.
Integrate an external system
Move data between your own system and BigLedger over HTTP. Access keys, REST, webhooks.

Build an applet

Almost every screen a BigLedger user sees — Chart of Account, Sales Invoice, Cashbook, Point of Sale — is an applet: a self-contained web application that the BigLedger shell loads at runtime and mounts inside its own page. Applets are built, versioned and released independently of the platform and of each other.

Getting Started
From an empty directory to a bundle running inside a tenant.
Applet Structure
The runtime contract, the API client, settings, permissions, packaging and release.

What you need: Node.js, the Angular CLI (Angular 11–15), and two public npm packages — blg-akaun-ts-lib for the API and, optionally, blg-akaun-ng-lib for UI components.

What you need from us: a registration record for your applet, and a tenant to install it into. Neither is self-service. Applet Development says exactly where those hand-offs fall and what to ask for.

Integrate an external system

Your own system — a storefront, a warehouse tool, a marketplace connector, a data warehouse — exchanging data with BigLedger over HTTPS. One REST API, JSON in and JSON out, a self-service credential, and 969 server-to-server endpoint methods across 159 controllers.

Getting Started
Sign in, issue an access key, and read and write your first records - end to end.
Data API
Path grammar, the resources available, paging, envelopes, limits and error codes.
Authentication
Access keys, tokens, the tenantCode header and every failure code.
Webhooks
The event path out of BigLedger - and the four things it does not do.

What you need from us: a tenant code, and a user in that tenant with the right permissions. The access key itself is one API call you make yourself. Integrate an external system says where each hand-off falls.

Module references

E-Invoice API
Malaysian e-Invoice submission, cancellation, rejection, notifications and document queries. Verified endpoint by endpoint.
Unified Communications API
Conversations, messages, channels and endpoints for the communications module.
Automation
Webhooks, the tenant cron table, the background job processors and the approval engine - and the workflow engine BigLedger does not have.
Platform Library
A different job again: building a backend application that depends on the BigLedger Java libraries.
Parts of the module-level API reference are still being rewritten. An audit on 6 September 2026 found that several pages described endpoints that do not exist, and those pages were unpublished rather than left up. Everything linked from this page is verified against the platform source. Treat anything not linked from here as absent rather than as documentation you have not found — and if you need a route that is not covered, ask rather than guess.

Getting help

  • Developer questions: open an issue at BigLedger-Support/public. Include your tenant code, the applet or endpoint involved, and what you expected to happen — the queue is public, so the answer helps whoever asks next.
  • Public repositories: github.com/bigledger
  • The product itself: akaun.com

If a page in this section tells you to call something that does not answer, that is a bug in the documentation and we want to hear about it.

Last updated on