BillOS v1
Console llms.txt OpenAPI
GET/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.

These are management reports; the regulatory filing artifact remains the OPENFRMT export.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.
kindstringrequiredהכנסות / הוצאות / רווח והפסד. One of: incomes, expenses, profit.

Query parameters

NameTypeDescription
fromstring
tostring
formatstringOne of: pdf, json. Default pdf.

Response

200: raw application/pdf bytes.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error": …, "reason": … }. Branch on reason.

PreviousNumbering-continuity report NextInitiated backup
On this page
Path parametersQuery parametersResponse
GET /businesses/{bid}/reports/{kind} 
curl -X GET "$BASE/businesses/$BID/reports/profit?from=&to=&format=" \
  -H "X-Api-Key: $KEY"
  -o document.pdf
const res = await fetch(`${BASE}/businesses/${BID}/reports/profit`, {
  method: 'GET',
  headers: {
    'X-Api-Key': KEY,
  },
})
const pdf = Buffer.from(await res.arrayBuffer())
import requests
res = requests.get(
    f"{BASE}/businesses/{BID}/reports/profit",
    headers={"X-Api-Key": KEY},
)
open("document.pdf", "wb").write(res.content)
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.