BillOS v1
Console llms.txt OpenAPI
POST/businesses/{bid}/ita/simulate

Move a sandbox connection in time

POST /businesses/{bid}/ita/simulate

Requires the businesses scope.

Sandbox only. expiring moves a connected sandbox business to its last days and fires ita.expiring; expired ends its consent and fires ita.expired. For trying your reminders and screens today rather than in three months. A live key is refused with 403 forbidden.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Body

FieldTypeDescription
statestringrequiredOne of: expiring, expired.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
itaItaConnectionrequiredA business's connection to רשות המסים (חשבוניות ישראל): whether BillOS may request מספרי הקצאה for it, and until when. Never a token: those stay in BillOS.

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

PreviousStart a consent NextAsk for a sandbox key
On this page
Path parametersBodyResponse
POST /businesses/{bid}/ita/simulate 
curl -X POST "$BASE/businesses/$BID/ita/simulate" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "state": "expiring"
  }'
const res = await fetch(`${BASE}/businesses/${BID}/ita/simulate`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "state": "expiring"
  }),
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.post(
    f"{BASE}/businesses/{BID}/ita/simulate",
    headers={"X-Api-Key": KEY},
    json={
      "state": "expiring"
    },
)
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.