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

Schedule a report

PUT /businesses/{bid}/report-schedules/{report}

Requires the businesses scope.

Create or replace one report's schedule. Saving never mails a backlog: the period already closed counts as sent. movein needs the MOVEIN settings saved first; pcn874 is not for a עוסק פטור or a yearly frequency. Owner only.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.
reportstringrequiredOne of: workbook, full, profit, incomes, expenses, receivables, months, parties, documents_zip, movein, documents_csv, pcn874.

Body

FieldTypeDescription
emailsarray of stringrequired
frequencystringDefault: this dealer type's. One of: monthly, bimonthly, yearly.
sendOnDayintegerDay of the month AFTER the period, 1..28. Default 1.
activebooleanDefault true; false pauses without losing the settings.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
scheduleobjectrequired

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

PreviousReports sent by email on a schedule NextStop a scheduled report
On this page
Path parametersBodyResponse
PUT /businesses/{bid}/report-schedules/{report} 
curl -X PUT "$BASE/businesses/$BID/report-schedules/{report}" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": []
  }'
const res = await fetch(`${BASE}/businesses/${BID}/report-schedules/{report}`, {
  method: 'PUT',
  headers: {
    'X-Api-Key': KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "emails": []
  }),
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.put(
    f"{BASE}/businesses/{BID}/report-schedules/{report}",
    headers={"X-Api-Key": KEY},
    json={
      "emails": []
    },
)
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.