Skip to navigation

Balances, receivables and the action inbox

View as Markdown

The fast half of the dashboard.

balances folds every non-archived account into one reporting-currency total (plus bank/cash subtotals) and lists each account in its own currency. receivables is the same point-in-time query that drives the web KPI strip. actions counts and previews the four kinds of unreconciled work; the counts are complete, items is capped at 5 rows per kind.

Every list is narrowed to what the caller may actually read, so the counts of a restricted role are smaller — not filtered client-side.

Authentication

AuthorizationBearer

JWT issued via POST /api/v1/auth/sign_in. Used by mobile and SPA clients. Revoked tokens are rejected.

OR
AuthorizationBearer

Lucanto API key. Two prefixes:

  • lct_pat_<random><checksum> — personal access token (owner: User)
  • lct_live_<random><checksum> — workspace token, live data

Issue keys at /settings/api_keys (personal) or /:workspace_id/settings/api_keys (workspace). Plaintext token is shown once and never again.

Path parameters

workspace_idlongRequired>=1
Workspace ID. The numeric ID shown in your URLs.

Response

OK
balancesobject
receivablesobject
actionsobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error