API referenceEngagements
List the periods of an engagement
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
Every period, oldest first, with used, remaining, overage and the invoices made from it. Use a period's id for entries, invoicing and the report.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
id*stringThe engagement's id.
OK
application/json- response
data*array<>curl -X GET 'https://app.helvetly.com/api/v1/engagements/string/periods'Example Response
{ "data": [ { "id": "string", "index": 0, "starts_on": "2019-08-24", "ends_on": "2019-08-24", "natural_ends_on": "2019-08-24", "full_quantity": "string", "quantity_manual": true, "quantity": "string", "unit_price": "1234.50", "overage_unit_price": "1234.50", "used": "string", "invoiced_quantity": "string", "advance_invoice": { "id": "string", "number": "string", "status": "string", "kind": "string" }, "unearned": "string", "carried_in": "string", "available": "string", "remaining": "string", "overage": "string", "expected": "string", "state": "string", "uninvoiced_quantity": "string", "invoices": [ { "id": "string", "number": "string", "status": "string", "kind": "string" } ] } ]}