Cash flow
Cash flow. Cash received (client payments net of refunds, by payment date) versus team payouts and expenses, per currency and month, with the paged underlying transactions (signed amounts; absolute app links). Transaction descriptions are workspace content. Owner or Admin only; Agency plan (teamPayouts), 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).
Authorization
BearerAuth Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Query Parameters
Inclusive start (movement date), YYYY-MM-DD.
Inclusive end (movement date), YYYY-MM-DD. Must not be before from (422).
Only movements in this currency.
1-based page (default 1). A page past the end returns an empty page.
Transactions per page; exactly one of 10, 25, 50, 100 (default 25).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/reports/cash-flow"{ "data": { "range": { "from": "2019-08-24", "to": "2019-08-24" }, "currency": "string", "currencies": [ { "currency": "str", "received": "string", "teamPayments": "string", "expenses": "string", "remaining": "string", "months": [ { "month": "string", "received": "string", "teamPayments": "string", "expenses": "string", "remaining": "string" } ] } ], "availableCurrencies": [ "str" ], "transactions": [ { "id": "string", "kind": "receipt", "date": "2019-08-24", "currency": "str", "amount": "string", "description": "string", "appUrl": "string" } ], "unknownDateReceiptCount": 0, "pagination": { "page": 0, "perPage": 0, "total": 0, "totalPages": 0, "hasMore": 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" }}Project profitability
Per-project hours and value: tracked, uninvoiced and invoiced value in the client currency, plus fixed-fee value and remaining balance (CURRENT balances, not date-filtered). Archived projects, and projects of archived clients, are listed while they have time in range or are named by projectId or clientId. members (per-person billability) is returned only on the Agency plan (advancedReporting); otherwise a warning says it was omitted. Members see only their own hours on projects they belong to and no money; a userId other than their own is a 404. Any role. 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).
List recurring invoices
Cursor-paginated series list. Unknown or repeated scalar query parameters return 422. Scope: read. Manager, Admin or Owner token (Members get 403). Requires the Studio plan or higher (`recurringBilling`, 402 otherwise). While recurring invoices are temporarily unavailable, every recurring endpoint returns a definitive 409 `conflict`.