Reports

Report endpoints take one JSON query parameter, reportFilter.

reportFilter

Field	Type	Notes
dateFilter	object	See dateFilter.
accountFilter	string[]	Account IDs.
contactFilter	string[]	Contact IDs.
itemFilter	string[]	Item IDs.
tagsFilter	string[]	Tags.
txnType	string	A transaction type.
ledgerType	string	For example CustomerInvoice, SupplierBill, IncomingPayment, OutgoingPayment, Journal, GeneralEntry.
accountingType	string	Accrual or Cash.
reportType	string	CustomerBase, VendorBase or CombinedBase (for contact reports).
onlyCashEntries, includeRetainedEarnings, includeBalance	boolean
branchId	string	Read a specific branch instead of the main branch.

Only the fields relevant to a report are used; leave the rest out.

curl -G "$BASE_URL/reporting/getDashboard" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode 'reportFilter={"dateFilter":{"predefinedDateFilter":"ThisMonth"}}'

Report endpoints

Endpoint	Permission	Description
GET /reporting/getDashboard	FinancialReport · Read	Business summary for the period: income, expenses, receivables/payables and related totals.
GET /reporting/ledger-entries	Read on a transaction type	General-ledger entries matching the filter. Returns Ledger[].
GET /reporting/ledger-entries-with-balance	Read on a transaction type · Advanced Reports plan feature	Ledger entries with a running balance.
GET /reporting/ledger-totals	FinancialReport · Read or LedgerReport · Read · Advanced Reports plan feature	Totals aggregated by account — the building block for trial balance, profit and loss, and balance sheet views.
GET /reporting/contact-txns	SalesReport, PurchaseReport or LedgerReport · Read	Transactions grouped by contact for a period (use contactFilter and reportType).
GET /reporting/contact-statement	SalesReport, PurchaseReport or LedgerReport · Read	Customer or vendor statement of account with opening balance, entries and closing balance.
POST /reporting/reportPdf	Any report permission · Read	Renders rows you supply as a PDF. JSON body: { "object": "<report name>", "list": [ ...rows... ] }. Returns the file.
POST /reporting/reportExcel	Any report permission · Read	Same input, returns an Excel file.

For the exact response schema of each report, see the OpenAPI document.