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

List expenses

GET /businesses/{bid}/expenses

Requires the expenses scope.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Query parameters

NameTypeDescription
statusstringOne of: draft, recorded.
categoryKeystring
fromstring
tostring
takeintegerDefault 200.
beforestringTime cursor: rows created strictly before this instant, newest first. To page, start with now and pass the last row's createdAt.
qstringFree-text search: supplier name or document number.
skipintegerOffset paging: rows to skip before take. Default 0.
countsstringAdds counts: { total, byStatus } over the same filters (minus status). One of: 1.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
expensesarray of Expenserequired

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

PreviousEmail the document link NextCreate an expense
On this page
Path parametersQuery parametersResponse
GET /businesses/{bid}/expenses 
curl -X GET "$BASE/businesses/$BID/expenses?status=&categoryKey=&from=" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/expenses`, {
  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}/expenses",
    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.