חשבוניות SLK
פתיחת חשבון
All API pages

API reference

GET /api/billing/v1/documents

נסו ב-Playground
On this page

Search issued documents, or fetch one full document by id. Read-only: it works while the account is dormant and in sandbox.

http
GET /api/billing/v1/documents?type=3&from=2026-09-01&to=2026-09-30&limit=50
X-Api-Key: bk_…

Filters#

QueryMeaning
typeDocument type (1 invoice, 2 receipt, 3 invoice-receipt, 4 credit note … see create-document).
status0 draft · 1 open · 2 closed · 3 fully credited · 4 partially credited · 5 cancelled. When omitted, drafts (0) are excluded.
from, toissue_date >= from and issue_date <= to (YYYY-MM-DD, inclusive).
qSubstring over customer name and subject, or an exact document number.
limit1–1000, default 200. Out-of-range numbers are clamped; a non-numeric value falls back to the default.
idReturn one full document instead of a list. Every other filter is then ignored.

Rows are ordered newest first (issued_at, then created_at).

List response#

json
{
  "documents": [
    {
      "id": "3f2b7c1e-9d4a-4c55-8a51-6d1e0f6b7a10",
      "doc_type": 3,
      "doc_number": 1042,
      "status": 1,
      "customer_id": null,
      "customer_name": "אורן כהן — סטודיו לעיצוב",
      "subject": "תשלום על בניית אתר תדמית",
      "issue_date": "2026-09-29",
      "due_date": null,
      "net_agorot": 381356,
      "vat_agorot": 68644,
      "total_agorot": 450000,
      "balance_agorot": 0,
      "currency": "ILS",
      "allocation_number": null,
      "issued_at": "2026-09-29T10:02:11.000Z"
    }
  ]
}

Field names here are the database column names (snake_case), unlike the camelCase used when you create a document. Money is agorot. balance_agorot is the open balance (meaningful for invoice/proforma types). allocation_number is filled when the Tax Authority allocation number was obtained.

One document#

http
GET /api/billing/v1/documents?id=3f2b7c1e-9d4a-4c55-8a51-6d1e0f6b7a10
json
{
  "doc": { "id": "3f2b7c1e-…", "doc_type": 3, "doc_number": 1042, "status": 1, "customer_name": "…", "vat_bp": 1800,
           "reference_doc_ids": "[]", "doc_hash": "…", "prev_hash": "…", "api_identifier": "order-12345", "issued_at": "…" },
  "lines":       [{ "position": 0, "name": "בניית אתר תדמית", "quantity_milli": 1000, "unit_price_agorot": 450000, "vat_bp": 1800, "total_agorot": 450000 }],
  "payments":    [{ "payment_type": 3, "amount_agorot": 450000, "date": "2026-09-29" }],
  "events":      [],
  "settlements": []
}
  • doc is the full document row without the frozen html_snapshot.
  • reference_doc_ids is a JSON string containing an array of ids.
  • settlements lists which receipt paid down which invoice (receipt_id, invoice_id, amount_agorot) — it is populated for both sides of the link.
  • Unknown id: 404 {"error":"not found"}.

Notes#

  • Sandbox documents (SBX-…) live in a separate table and are not returned here. In a sandbox account the list is empty apart from anything created in the dashboard.
  • There is no pagination cursor; narrow with from/to and limit.
  • Document links (viewUrl) need a dashboard session; there is no public share link in this API.

Errors: 401 bad key, 404 unknown id, 429 rate limited. See errors.

GET /api/billing/v1/documents — SLK Invoices API