Skip to Content
HelvetlyDocs
API referenceEngagements

Download a period's service report

Needs a token with the read:engagements scope (or write:engagements). 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/engagements/{id}/periods/{period_id}/report

The service report (Leistungsnachweis) of a period as a PDF, rendered live from the entries.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

id*string

The engagement's id.

period_id*string

The period's id, from list_engagement_periods.

Query Parameters

download?"1"

1 sends it as an attachment instead of inline.

Value in"1"

Response Body

The PDF.

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

Create an invoice draft for a period

Previous Page

Email a period's service report

Next Page