BillOS v1
Console llms.txt OpenAPI
POST/accountant/invite-link

A link that brings a client to BillOS

POST /accountant/invite-link

Requires the businesses scope.

An accountant cuts a link to send a client. It carries his verified email (the session's, never the body's) and the name of his office, signed, and expires in 30 days. It grants nothing by itself: the client opens it, signs in, opens or picks his business and approves, and that approval is an ordinary shared-access invite (POST /businesses/{bid}/access, role accountant) made by the owner. Session only.

Body

FieldTypeDescription
labelstringrequiredThe name of the office, shown to the client. Up to 60 characters.

Response

201: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
linkstringrequiredThe address to send the client.
tokenstringrequiredThe signed token inside it.
expiresAtstringrequiredWhen the link stops working.
labelstringThe office name as stored.
emailstringThe accountant's verified email the link names.

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

On this page
BodyResponse
POST /accountant/invite-link
curl -X POST "$BASE/accountant/invite-link" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "string"
  }'
const res = await fetch(`${BASE}/accountant/invite-link`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "label": "string"
  }),
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.post(
    f"{BASE}/accountant/invite-link",
    headers={"X-Api-Key": KEY},
    json={
      "label": "string"
    },
)
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.