Skip to Content
HelvetlyDocs
API referenceInvoices

Export invoices as CSV

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
/api/v1/invoices/export

Every invoice matching the list filters (no paging) as a UTF-8 CSV with BOM: number, kind, type_code, status, client, dates, currency, totals, amount_paid, amount_due, refund_due, reference, sent_at. Cells that could run as spreadsheet formulas are prefixed with an apostrophe.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Query Parameters

search?string

Matches number, client and reference.

client_id?string

Only this client's.

status?string

Comma-separated: draft, open, paid, void, replaced, overdue, refund_due.

kind?string

Document type.

Value in"invoice""partial""prepayment""debit_note""corrected""credit_note""proforma""self_billed"
credited_invoice_id?string

Only documents that credit or correct this invoice.

issued_from?string

Issue date on or after (YYYY-MM-DD).

Formatdate
issued_to?string

Issue date on or before (YYYY-MM-DD).

Formatdate
ids?string

Comma-separated invoice ids.

sort?string

One of number, issue_date, due_date, total, client, created_at; prefix - for descending.

Response Body

The CSV file.

response?filetext/csv
Formatbinary
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/invoices/export'
Example Response
"string"