Skip to Content
HelvetlyDocs
API referenceInvoices

Download an invoice as PDF

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/{id}/pdf

The invoice's PDF: the frozen original for an issued document, a live watermarked rendering for a draft, and the uploaded original (any content type) for an invoice imported as issued elsewhere. Add download=1 to get it as an attachment instead of inline.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

id*string

The invoice's id.

Query Parameters

download?"1"

1 to send Content-Disposition: attachment instead of inline.

Value in"1"

Response Body

The document.

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