BillOS v1
Console llms.txt OpenAPI
GET/businesses/{bid}/accountant-report

The periodic report to the accountant

GET /businesses/{bid}/accountant-report

Requires the businesses scope.

The schedule that mails this business's closed periods to its accountant (section 4, Shared access), or null when there is none. Also returns the frequencies and the default for this dealer type, so a UI keeps no copy of the rule. Owner only.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
reportAccountantReportrequiredThe schedule that mails a business's closed periods to its accountant.
frequenciesarray of string
defaultFrequencystringWhat this dealer type reports on: yearly for a עוסק פטור, monthly otherwise.

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 /businesses/{bid}/accountant-report
curl -X GET "$BASE/businesses/$BID/accountant-report" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/accountant-report`, {
  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}/businesses/{BID}/accountant-report",
    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.