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

Send a scheduled report now

POST /businesses/{bid}/report-schedules/{report}/send

Requires the businesses scope.

Sends the report to its addresses now, for a period you name (default: the last closed one). 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
periodstringYYYY-MM, YYYY-Bn or YYYY. Default: the last closed period.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
sentbooleanrequiredWhether a letter went out.
resultsarray of object
toarray of string

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

PreviousStop a scheduled report NextRemove a person's access
On this page
Path parametersBodyResponse
POST /businesses/{bid}/report-schedules/{report}/send 
curl -X POST "$BASE/businesses/$BID/report-schedules/{report}/send" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/report-schedules/{report}/send`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.post(
    f"{BASE}/businesses/{BID}/report-schedules/{report}/send",
    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.