BillOS v1
Console llms.txt OpenAPI
POST/businesses

Create a business

POST /businesses

Requires the businesses scope.

One business per end user. Everything else is nested under the id this returns.

A business created with lastInvoiceNumber continues an existing numbering sequence. That is how you migrate a dealer off their previous software without restarting their document numbers.

Body

FieldTypeDescription
namestringrequiredLegal business name.
taxIdstringrequiredChecksum-validated.
dealerTypestringrequiredOne of: patur, murshe, company, ngo.
addressstring
phonestring
emailstring
defaultVatRateBpintegerBasis points. Defaults to the current statutory rate.
lastInvoiceNumberintegerContinue an existing sequence from this number.
brandingBrandingAppearance 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

201: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
businessBusinessrequiredOne Israeli dealer (עוסק), one of your end users.

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

On this page
BodyResponse
POST /businesses
curl -X POST "$BASE/businesses" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "דנה לוי",
    "taxId": "514667426",
    "dealerType": "murshe"
  }'
const res = await fetch(`${BASE}/businesses`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "דנה לוי",
    "taxId": "514667426",
    "dealerType": "murshe"
  }),
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.post(
    f"{BASE}/businesses",
    headers={"X-Api-Key": KEY},
    json={
      "name": "דנה לוי",
      "taxId": "514667426",
      "dealerType": "murshe"
    },
)
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.