Preview a draft as PDF

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

Requires the documents scope.

The draft rendered as a "טיוטה"-watermarked PDF so your user sees exactly what they are about to issue. Nothing is recorded and no number is consumed. Drafts only.

Path parameters

Name	Type		Description
`bid`	string	required	Business id, from `POST /businesses`.
`id`	string	required	Document id.

Body (optional)

Field	Type		Description
`branding`	Branding		Appearance of the rendered PDF. Stored once per business; a logo is stored as a file and referenced by hash, never re-frozen into each document.

Response

200: raw application/pdf bytes.

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

On this page

Path parameters Body (optional)Response

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

curl -X POST "$BASE/businesses/$BID/documents/$DOC_ID/preview" \
  -H "X-Api-Key: $KEY"
  -o document.pdf

const res = await fetch(`${BASE}/businesses/${BID}/documents/${DOC_ID}/preview`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
  },
})
const pdf = Buffer.from(await res.arrayBuffer())

import requests
res = requests.post(
    f"{BASE}/businesses/{BID}/documents/{DOC_ID}/preview",
    headers={"X-Api-Key": KEY},
)
open("document.pdf", "wb").write(res.content)

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.