BillOS v1
Console llms.txt OpenAPI
PUT/accountant/desk/businesses/{bid}

How often a client files VAT

PUT /accountant/desk/businesses/{bid}

Requires the businesses scope.

The accountant's own note on one business that was shared with him: how often it files its VAT return, which the desk turns into the next deadline. It lives on the access row he holds, so it is his alone (a second accountant keeps his own, the owner has no say in it) and needs only read access to the business. null clears it, and the desk then assumes monthly for a VAT dealer and none for a עוסק פטור. Only a person the business was shared with can write it: an owner or a key answers 403.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Body

FieldTypeDescription
vatFrequencystring,nullrequiredmonthly, bimonthly (a pair of months is due with the second), none (files no VAT return) or null. One of: monthly, bimonthly, none, null.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
vatFrequencystring,null

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

PUT /accountant/desk/businesses/{bid}
curl -X PUT "$BASE/accountant/desk/businesses/$BID" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vatFrequency": "monthly"
  }'
const res = await fetch(`${BASE}/accountant/desk/businesses/${BID}`, {
  method: 'PUT',
  headers: {
    'X-Api-Key': KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "vatFrequency": "monthly"
  }),
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.put(
    f"{BASE}/accountant/desk/businesses/{BID}",
    headers={"X-Api-Key": KEY},
    json={
      "vatFrequency": "monthly"
    },
)
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.