API referenceInvoices
Invoice summary
Needs a token with the read:invoices scope (or write:invoices). 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
Open, overdue, paid and draft totals in one currency plus the last months, optionally for a client and a named period compared to the preceding one.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
currency?stringThree-letter ISO code. Default: the workspace currency.
Length
3 <= length <= 3client_id?stringOnly this client's.
period?stringAdds the period figures.
Value in
"this_month""last_month""this_quarter""this_year""last_12_months"OK
application/json- response
data*Figures of one currency. period is present only when the period query parameter was given.
curl -X GET 'https://app.helvetly.com/api/v1/invoices/summary'Example Response
{ "data": { "currency": "string", "outstanding": { "amount": "1234.50", "count": 0 }, "overdue": { "amount": "1234.50", "count": 0 }, "paid_this_month": { "amount": "1234.50", "count": 0 }, "paid_last_month": { "amount": "1234.50" }, "drafts": { "amount": "1234.50", "count": 0 }, "refund_due": { "amount": "1234.50", "count": 0 }, "avg_days_to_pay": 0, "collection_rate": 0, "monthly": [ { "month": "string", "invoiced": "1234.50", "paid": "1234.50" } ], "period": { "name": "string", "from": "2019-08-24", "to": "2019-08-24", "paid": { "amount": "1234.50", "count": 0 }, "paid_previous": { "amount": "1234.50" }, "avg_days_to_pay": 0, "collection_rate": 0 } }}