API referenceReports
Get key figures
Needs a token with the read:reports scope. Authentication
Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.
GET
Outstanding, paid, overdue, spending, VAT to reclaim and cash flow in one currency.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
currency?stringISO code; default the invoice settings' currency, else CHF.
Match
^[A-Z]{3}$OK
application/json- response
Key figures in one currency, in major units (JSON numbers). Invoice figures stay 0 without read access to invoices, expense figures without read access to expenses.
currency*stringcurrencies*array<string>outstanding*numberopen_count*integerpaid_this_month*numberpaid_change*numberoverdue_count*integerinvoice_count*integeravg_days_to_pay*numbercollection_rate*numberspent_this_month*numbervat_to_reclaim*numberpending_count*integerexpense_count*integerreceipts_matched*numbertrends*cash_flow*Keys 30d, 90d and 12m.
unread*curl -X GET 'https://app.helvetly.com/api/v1/reports/key-figures'Example Response
{ "currency": "string", "currencies": [ "string" ], "outstanding": 0, "open_count": 0, "paid_this_month": 0, "paid_change": 0, "overdue_count": 0, "invoice_count": 0, "avg_days_to_pay": 0, "collection_rate": 0, "spent_this_month": 0, "vat_to_reclaim": 0, "pending_count": 0, "expense_count": 0, "receipts_matched": 0, "trends": { "outstanding": [ 0 ], "paid": [ 0 ], "spent": [ 0 ], "vat": [ 0 ] }, "cash_flow": { "property1": [ { "date": "2019-08-24", "income": 0, "expenses": 0 } ], "property2": [ { "date": "2019-08-24", "income": 0, "expenses": 0 } ] }, "unread": { "notifications": 0, "inbox": 0 }}