Skip to content
Hoursmith Docs
APIReferenceReports

Receivables summary

Receivables summary. Accounts receivable per currency: outstanding (SENT invoices' total minus amount paid), overdue (due date before today in the caller's timezone), drafts, paid this month (net received principal by payment date, caller's calendar month) and aging buckets, plus the largest balances per client (max 50 rows). 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).

GET
/reports/receivables

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

clientId?array<>

Filter by client. Repeat the parameter for several (max 25). Unknown ids return 404.

currency?string

Only invoices in this currency.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reports/receivables"
{  "data": {    "asOf": "2019-08-24",    "month": "string",    "timezone": "string",    "filters": {      "clientIds": [        "c055e856-96a7-4f69-80a6-b75690833d98"      ],      "currency": "string"    },    "currencies": [      {        "currency": "str",        "outstanding": {          "amount": "string",          "count": 0        },        "overdue": {          "amount": "string",          "count": 0        },        "drafts": {          "amount": "string",          "count": 0        },        "paidThisMonth": {          "amount": "string",          "count": 0        },        "aging": {          "notYetDue": {            "amount": "string",            "count": 0          },          "overdue1To30Days": {            "amount": "string",            "count": 0          },          "overdue31To60Days": {            "amount": "string",            "count": 0          },          "overdue61PlusDays": {            "amount": "string",            "count": 0          }        }      }    ],    "clients": [      {        "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",        "clientName": "string",        "currency": "str",        "outstanding": "string",        "invoiceCount": 0,        "overdue": "string",        "overdueInvoiceCount": 0,        "oldestDueDate": "2019-08-24"      }    ],    "clientTotal": 0,    "clientsTruncated": 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"  }}
{  "error": {    "code": "unauthenticated",    "message": "string",    "fields": {      "property1": "string",      "property2": "string"    },    "requiredPlan": "studio",    "feature": "string",    "requestId": "string"  }}
Was this page helpful?

Uninvoiced work (ready to invoice)

Billable work not yet invoiced, per client and project: hourly time (stopped entries only: running timers and zero-length entries are left out; value at the current rate, each entry rounded up to 15 minutes), billable expenses and remaining fixed-fee balances, with per-currency totals. from/to filter time-entry and expense dates; fixed-fee balances are CURRENT balances and are not date-filtered. Amounts are advisory estimates. Paged by client. 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).

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).