Skip to content
Hoursmith Docs
APIReferenceInvoices

Clients ready to invoice

Clients ready to invoice. Owner, Admin or Manager only (Member tokens receive 403 forbidden_scope). The API itself requires the Studio or Agency plan. Read scope. Clients with unbilled billable time (stopped entries; running timers are left out), expenses or fixed-fee balance; one currency per row. Rows are ordered by the raw estimate compared as a plain number across currencies (no conversion) and then cut to `limit`, so a large amount in a low-value currency (for example JPY) can push workspace-currency clients out of a small page: pass clientId or a larger limit. Amounts are estimates — preview for exact totals.

GET
/invoices/ready-to-invoice

Authorization

BearerAuth
AuthorizationBearer <token>

Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.

In: header

Query Parameters

clientId?string

Repeatable; at most 25.

limit?integer

Default 10.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/invoices/ready-to-invoice"
{  "data": [    {      "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",      "clientName": "string",      "currency": "string",      "unbilledSeconds": 0,      "unbilledHours": "string",      "timeAmount": "string",      "expenseAmount": "string",      "expenseCount": 0,      "fixedFeeAmount": "string",      "fixedProjectCount": 0,      "estimatedTotal": "string"    }  ],  "warnings": [    "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"  }}
{  "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"  }}
Was this page helpful?