Skip to Content
HelvetlyDocs
API referenceInvoices

List invoices

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

Invoices, credit notes and other documents of the workspace, paged and filterable.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Query Parameters

page?integer

Page number, from 1.

Range1 <= value
Default1
page_size?integer

Items per page.

Range1 <= value <= 200
Default50
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"
issued_from?string

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

Formatdate
issued_to?string

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

Formatdate
sort?string

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

Response Body

OK

application/json
  1. response
data*array<>
meta*

Paging of a list: page/page_size in, totals out.

Example Request
curl -X GET 'https://app.helvetly.com/api/v1/invoices'
Example Response
{  "data": [    {      "id": "string",      "kind": "invoice",      "type_code": "string",      "number": "string",      "status": "draft",      "is_overdue": true,      "client": {        "id": "string",        "number": 0,        "name": "string"      },      "issue_date": "2019-08-24",      "due_date": "2019-08-24",      "currency": "string",      "total": "1234.50",      "rounding_amount": "1234.50",      "payable_total": "1234.50",      "prepaid_total": "1234.50",      "amount_due": "1234.50",      "refund_due": "1234.50",      "payment_methods": {        "qr_bill": true,        "revolut": true      },      "deducted_on": {        "id": "string",        "number": "string"      },      "sent_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "page_size": 0,    "total": 0,    "total_pages": 0  }}