items

List Items

List/filter items, scoped to the caller's member companies (A1).

Optional period (YYYY-MM) filters by the item's effective date (invoice date, falling back to the Europe/Zurich-local ingestion date); a malformed value returns 422 {"msg": "period must be YYYY-MM"}. exclude_triage_status drops items carrying that triage verdict (NULL-safe) — the Payables/Receivables pages pass unrelated so relevance-parked items show only in the Inbox (pipeline §"Relevance gate").

Optional q is free text: a case-insensitive partial (substring) match over the filename and the counterparty name from both of its sources (the linked counterparty and the extracted data.company). %/_ are matched literally, blank is ignored, and total counts the filtered set.

duplicate filters on the row's is_duplicate flag (ZET-413); credit_note on its is_credit_note flag (ZET-429) — both server-side, so total stays exact.

get/items

Request

  • Base URL: https://app.zeno-works.ch (the document declares no server; this is the origin it was published from)
  • URL: https://app.zeno-works.ch/items
  • Auth: none declared

Query parameters

source'email' | 'epost' | 'upload' | 'bexio' | 'abacus' | 'filesystem' | 'clouddrive'
direction'payable' | 'receivable' | 'unknown'

Query-filter vocabulary for Item.direction — NEVER a column type.

Item.direction is tri-state (payable/receivable/NULL = unknown); the PG direction enum stays binary. This enum exists so list endpoints can accept direction=unknown (→ direction IS NULL) alongside the two real values without widening the DB enum.

archive_status'pending' | 'archiving' | 'archived' | 'failed'
triage_status'irrelevant' | 'needs_review' | 'unrelated'

AI ingest-gate verdict parking an item in the Inbox (pipeline §"Ingest triage", §"Relevance gate").

NULL = not triaged / normal flow. irrelevant/needs_review are the metadata-triage verdicts on a held-unusable item (a human override flips between them; re-analysis resets the columns to NULL). unrelated is the relevance-gate verdict on a cleanly extracted invoice that doculyse's entity resolver matched to neither party of the owning company — the item is held pending (never archived, no counterparty, never coded) until a human restores it (clears the verdict) or deletes it.

exclude_triage_status'irrelevant' | 'needs_review' | 'unrelated'

AI ingest-gate verdict parking an item in the Inbox (pipeline §"Ingest triage", §"Relevance gate").

NULL = not triaged / normal flow. irrelevant/needs_review are the metadata-triage verdicts on a held-unusable item (a human override flips between them; re-analysis resets the columns to NULL). unrelated is the relevance-gate verdict on a cleanly extracted invoice that doculyse's entity resolver matched to neither party of the owning company — the item is held pending (never archived, no counterparty, never coded) until a human restores it (clears the verdict) or deletes it.

counterparty_idstring nullable
company_idstring nullable
periodstring nullable
paidboolean nullable
postedboolean nullable
duplicateboolean nullable
credit_noteboolean nullable
qstring nullable
limitinteger
offsetinteger

Headers

authorizationstring nullable

Cookies

access_tokenstring nullable

Response

Successful Response

totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.