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

Open items (חובות פתוחים)

GET /businesses/{bid}/receivables

Requires the documents scope.

Every issued invoice (305) and proforma (300) with a balance: what was paid against it, what was credited, what is left, how many days it has been open, in the four ageing buckets. A receipt that names the invoice (settles) is what closes it.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Query parameters

NameTypeDescription
partyIdstringOne customer.
asOfstringAge as of this day (default today).

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
receivablesReceivablesrequiredEvery open invoice and proforma, aged from its due date when it states one and from its document date otherwise.

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

PreviousUndo a later allocation NextPreview a draft as PDF
On this page
Path parametersQuery parametersResponse
GET /businesses/{bid}/receivables 
curl -X GET "$BASE/businesses/$BID/receivables?partyId=&asOf=" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/receivables`, {
  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}/receivables",
    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.