Project budget and financials
Project budget and financials. Budget consumption and billing status for one project. Every role that can see the project gets tracked time and the hours budget; Owner/Admin/Manager responses add the amount budget and unbilled/billed/fixed-fee amounts in the client currency (omitted for Members). For HOURLY projects, unbilledHours and unbilledAmount are billable, uninvoiced, stopped time (a running timer is left out), each entry rounded up to the quarter hour; billedAmount is SENT and PAID invoice lines in the project's current currency (lines billed in another currency are listed in billedOtherCurrencies, never added); the amount budget's used also counts DRAFT invoice lines. Archived projects are included. No plan beyond API access. Read-only; requires a token with read scope. Unknown or repeated (non-list) query parameters, impossible dates and inverted ranges return 422 with `fields`. Money is an exact decimal string paired with its currency; amounts in different currencies are never added together and nothing is converted. Responses are private (Cache-Control: private, no-store; Vary: Authorization).
Authorization
BearerAuth Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Path Parameters
Project id.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/financials"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "clientId": "5e505642-9024-474d-9434-e5a44f505cc5", "status": "string", "archived": true, "rateType": "HOURLY", "trackedSeconds": 0, "trackedHours": "string", "hoursBudget": { "capHours": "string", "usedHours": "string", "remainingHours": "string", "percentUsed": 0, "overBudget": true }, "currency": "str", "amountBudget": { "currency": "str", "cap": "string", "used": "string", "remaining": "string", "percentUsed": 0, "overBudget": true }, "unbilledHours": "string", "unbilledAmount": "string", "billedAmount": "string", "billedOtherCurrencies": [ { "currency": "str", "amount": "string" } ], "fixedFeeAmount": "string", "draftReservedAmount": "string", "remainingToInvoice": "string", "overAllocatedAmount": "string", "fixedFeeBillingInitialized": true }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}Dashboard overview
The dashboard snapshot: hours for the 7 days ending today (caller's timezone) with the trend against the prior 7 days, active projects and the caller's own assigned open tasks (tasks of archived projects are left out, and a Member's count reads their current project access, so the tasks of a project they were removed from no longer count). Owner/Admin/Manager responses are workspace-wide and add unbilled and outstanding amounts per currency; Members get only their own hours on their projects and no money. Any role; no plan beyond API access. Takes no parameters. Read-only; requires a token with read scope. Unknown or repeated (non-list) query parameters, impossible dates and inverted ranges return 422 with `fields`. Money is an exact decimal string paired with its currency; amounts in different currencies are never added together and nothing is converted. Responses are private (Cache-Control: private, no-store; Vary: Authorization).
Revenue report
Invoiced, paid, outstanding and draft revenue per currency with a monthly series. Months and from/to use the invoice ISSUE date: paid is attributed to the issue month, not the payment date (use /reports/cash-flow for cash basis). Invoices replaced by a correction are excluded from invoiced totals. Owner, Admin or Manager only: a Member token gets 403. Plan: Studio or Agency (reports); otherwise 402. Read-only; requires a token with read scope. Unknown or repeated (non-list) query parameters, impossible dates and inverted ranges return 422 with `fields`. Money is an exact decimal string paired with its currency; amounts in different currencies are never added together and nothing is converted. Responses are private (Cache-Control: private, no-store; Vary: Authorization).