API Reference

Every resource, grouped by business domain.

Identity

Who-am-I, organization membership, the live scope catalog, and OAuth2 token issuance/revocation.

6 endpoints

Dashboard

Mobile dashboard summaries, built on the same aggregations as the web dashboard.

1 endpoint

Customers

Customer master records for sales documents.

6 endpoints

Customer Contacts

Named contacts on a customer record (e.g. for the customer portal). Uses the customers.* scope.

5 endpoints

Customer Ledger

Computed running-balance statement per customer (invoices, payments, adjustments). Read-only.

2 endpoints

Vendors

Vendor master records for purchase documents.

5 endpoints

Vendor Ledger

Computed running-balance statement per vendor (bills, payments, debit notes). Read-only; uses the reports.read scope.

2 endpoints

Inventory

Tax Rates

GST/tax rate presets applied to items and line items.

5 endpoints

Currencies

Currencies available for multi-currency sales/purchase documents.

5 endpoints

Payment Terms

Payment-term presets (net days) used by customers and invoices.

5 endpoints

Accounts

Financial accounts (cash/bank/wallet/etc.) used as payment sources and destinations.

5 endpoints

Items

Item (product/service) master records, with optional size variants.

6 endpoints

Item Groups

Hierarchical grouping/category tree for items. Uses the items.* permission scope.

5 endpoints

Warehouses

Physical/logical stock locations. Managed under the settings.* permission scope.

5 endpoints

Price Lists

Per-item selling/purchase price overrides, grouped into named lists.

5 endpoints

Number Series

Auto-numbering configuration (prefix/suffix/padding) per document type.

5 endpoints

Inventory

Stock-on-hand positions (item variant × warehouse). Read-only via the API.

2 endpoints

Purchases

Expenses

Standalone business expenses not tied to a vendor bill.

5 endpoints

Debit Notes

Vendor debit notes against bills. Read-only via the API; uses the bills.* permission scope.

2 endpoints

Bills

Vendor bills. Read-only via the API.

2 endpoints

Purchase Orders

Purchase orders sent to vendors. Read-only via the API.

2 endpoints

Sales

Quotes

Sales quotes. Read-only via the API — creation/editing happens in the web app.

2 endpoints

Sales Orders

Confirmed sales orders. Read-only via the API.

2 endpoints

Credit Notes

Customer credit notes against invoices. Read-only via the API; uses the invoices.* permission scope.

2 endpoints

Payments

Payments Made

Payments made to vendors, with bill allocations. Read-only via the API.

2 endpoints

Payments Received

Payments received from customers, allocated against invoices or customer credit.

4 endpoints

Invoices

Customer invoices — the one fully write-enabled sales document in the API.

9 endpoints