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

Reports sent by email on a schedule

GET /businesses/{bid}/report-schedules

Requires the businesses scope.

Every report this business sends by itself, one schedule per report, and the reports it may schedule (each with unavailable, the reason it may not, or null). Reports with the same addresses, frequency and day leave in one letter. The periodic report to the accountant is the workbook (and pcn874) schedule. Owner only.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
schedulesarray of objectrequired
reportsarray of object
frequenciesarray of string
defaultFrequencystring

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).

PreviousSend the report now NextSchedule a report
On this page
Path parametersResponse
GET /businesses/{bid}/report-schedules 
curl -X GET "$BASE/businesses/$BID/report-schedules" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/report-schedules`, {
  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}/report-schedules",
    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.