BillOS v1
Console llms.txt OpenAPI
POST/businesses/{bid}/documents/{id}/email

Email the document link

POST /businesses/{bid}/documents/{id}/email

Requires the documents scope.

Sends the public PDF link to up to 5 addresses in a BillOS-branded email, one email per address. Sending IS a print (auto): the origin exactly once, the copy after (הוראה 18(ב)2). Issued (or cancelled) documents only; not available in sandbox; rate-limited (BOOKS_EMAIL_RATE_PER_MIN, default 10/min).

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.
idstringrequiredDocument id.

Body

FieldTypeDescription
toarray of stringrequiredRecipient addresses (1-5).

Response

200: { "ok": true, … }

FieldTypeDescription
okboolean
sentarray of string
failedarray of string
variantstringOne of: origin, copy.
urlstringThe public PDF link the email carries.

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

PreviousGet the public PDF link NextList expenses
On this page
Path parametersBodyResponse
POST /businesses/{bid}/documents/{id}/email 
curl -X POST "$BASE/businesses/$BID/documents/$DOC_ID/email" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "2026-07-31"
  }'
const res = await fetch(`${BASE}/businesses/${BID}/documents/${DOC_ID}/email`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "to": "2026-07-31"
  }),
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.post(
    f"{BASE}/businesses/{BID}/documents/{DOC_ID}/email",
    headers={"X-Api-Key": KEY},
    json={
      "to": "2026-07-31"
    },
)
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.