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

Read a document

GET /businesses/{bid}/documents/{id}

Requires the documents scope.

Beside the document itself: basedOn (the document a credit note or negative receipt corrects), corrections (the corrections issued against this one), quote (the quote it was converted from), and the open-items view (settlement on an invoice or proforma, settles on a receipt).

Path parameters

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

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
documentDocumentrequiredA draft is freely mutable. An issued document is immutable forever, blocked at the database engine, not merely in application code.

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

PreviousCreate a draft NextUpdate a draft
On this page
Path parametersResponse
GET /businesses/{bid}/documents/{id} 
curl -X GET "$BASE/businesses/$BID/documents/$DOC_ID" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/documents/${DOC_ID}`, {
  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}/documents/{DOC_ID}",
    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.