BillOS v1
Console llms.txt OpenAPI
GET/accountant/desk

The accountant's desk

GET /accountant/desk

Requires the businesses scope.

One row for every business this credential was let into (its own, and those shared with it by an owner), saying what state a period is in: the income of the period, the recorded expenses and the receipts still waiting on their owner, the VAT return's figures, the open debts past their due date, and flags naming what is stuck (a missing allocation number, a problem the VAT return would carry, receipts not yet in the books, a business with no activity). status is attention, ready or quiet, and the rows come back with what needs attention first. Only businesses where the credential may read documents AND expenses are listed. Every figure is the ledger's own, in agorot, so the desk cannot disagree with the business's screens.

Query parameters

NameTypeDescription
periodstringA month (2026-09), a bi-month (2026-B4) or a year (2026). Default: the month that just closed.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
periodobjectrequired
period.keystringThe period key.
period.labelstringHebrew label.
period.fromstringFirst day.
period.tostringLast day.
period.frequencystringmonthlybimonthlyyearly
summaryobjectrequiredTotals over the rows: businesses, attention, ready, quiet, income, vatToPay, overdue, drafts (agorot).
businessesarray of objectrequired

Errors: 400, 401, 403, 404, 429. Every failure answers { "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }: branch on reason, and read hint for what to change (https://docs.billos.co.il/errors.md).

GET /accountant/desk
curl -X GET "$BASE/accountant/desk?period=" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/accountant/desk`, {
  method: 'GET',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.get(
    f"{BASE}/accountant/desk",
    headers={"X-Api-Key": KEY},
)
data = res.json()
Set BASE to https://api.billos.co.il/v1 and KEY to your bk_live_… key, or a bk_test_… key to run it against the sandbox.
Manage your businesses, keys and webhooks in the BillOS Console.