/businesses/{bid}/reports/{kind}Management report
GET /businesses/{bid}/reports/{kind}
Requires the export scope.
Cash-basis, mirroring the OPENFRMT semantics exactly: income is payment-bearing documents, expenses count at record. Default is a rendered Hebrew PDF carrying the business branding; ?format=json returns the aggregates for your own dashboard. The profit report includes a VAT block (עסקאות / תשומות / נטו) for VAT-registered dealers, income.byParty: the income before VAT by the customer named on each paid document, largest first (partyName null for documents with no customer), and months: every calendar month the range touches, oldest first, with its income before VAT, its expense cost and the profit between them (a quiet month is a zero).
full is the accountant's pack for the period: the three reports composed into ONE PDF, or with format=xlsx the workbook (income, expenses, and profit and loss as three sheets, each document linked); format=json returns the three reports' aggregates under incomes, expenses and profit.
These are management reports; the regulatory filing artifact remains the OPENFRMT export.
Path parameters
| Name | Type | Description | |
|---|---|---|---|
bid | string | required | Business id, from POST /businesses. |
kind | string | required | הכנסות / הוצאות / רווח והפסד / full: הדוח המרוכז לרואה החשבון. One of: incomes, expenses, profit, full. |
Query parameters
| Name | Type | Description | |
|---|---|---|---|
from | string | ||
to | string | ||
format | string | xlsx only with kind=full. One of: pdf, json, xlsx. Default pdf. |
Response
200: raw application/pdf bytes.
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).