--- title: "List Receivables" method: GET path: "/companies/{company_id}/ar/receivables" tags: ["ar-invoices"] --- # List Receivables `GET /companies/{company_id}/ar/receivables` ## 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/companies/{company_id}/ar/receivables` - Auth: none declared Unified receivables list: authored AR invoices + ingested receivable documents in one date-sorted page (Receivables → Invoices tab). ``period`` (``YYYY-MM``) narrows both arms to a month; ``status`` / ``doc_type`` are authored-only filters; ``origin`` narrows to one arm. A malformed ``period`` returns 422. See ``invoiage_core.ar.receivables_list``. ``q`` is a case-insensitive substring search over what each row *shows* — the authored arm's invoice number + customer name, the ingested arm's filename + counterparty name. It narrows **both** arms and their counts, so ``total`` always describes the returned set (ZET-172; the same cap as ``GET /items``). ## Path parameters - `company_id` string, required ## Query parameters - `status` 'draft' | 'issued' | 'cancelled': Editorial lifecycle owned by ``ar_invoice`` (paid/overdue are derived on read from the linked ``gl_open_item``, not stored here). - `doc_type` 'invoice' | 'credit_note' - `period` string, nullable - `origin` 'authored' | 'ingested', nullable - `q` string, nullable - `limit` integer - `offset` integer ## Headers - `authorization` string, nullable ## Cookies - `access_token` string, nullable ## Response `200` Successful Response - ReceivablesListResponse - `rows` ReceivableRow[], required - `kind` 'authored' | 'ingested', required - `invoice` ArInvoiceOut - `doc_type` 'invoice' | 'credit_note' - `counterparty_id` string, nullable - `issuer_profile_id` string, nullable - `issue_date` string, date, required - `due_date` string, date, nullable - `service_period_start` string, date, nullable - `service_period_end` string, date, nullable - `currency` string - `language` string, required - `payment_terms_id` string, nullable - `invoice_discount_kind` 'none' | 'percent' | 'amount' - `invoice_discount_value` string - `footer_text` string, nullable - `legal_text` string, nullable - `notes` string, nullable - `credited_invoice_id` string, nullable - `id` string, required - `status` 'draft' | 'issued' | 'cancelled', required: Editorial lifecycle owned by ``ar_invoice`` (paid/overdue are derived on read from the linked ``gl_open_item``, not stored here). - `origin` 'human' | 'system' | 'ai' | 'api' | 'mcp' | 'chat': What KIND of actor posted a journal entry — the attribution flag. Two axes in one vocabulary, because the column answers one question — *can a reader take this as a person's own judgement?* **Authorship** — the value says who composed the booking: * ``ai`` = the AI-accountant composed it (an autonomous post, or a one-click accept where the content is still the accountant's proposal); * ``system`` = a mechanical/background ``SystemPrincipal`` post (migrations, close automation, deterministic seeds). **Channel** — the value says which surface a person's own action arrived through, because "a ``UserPrincipal`` acted" is NOT the same claim as "a person decided". All four are derived from the request edge by :func:`~invoiage_db.repos.gl_posting._resolve_origin`: * ``human`` = an interactive browser session (cookie/JWT auth). The only value that asserts a person was looking at the screen; * ``mcp`` = an API-key request carrying the mcp shell's ``X-Zeno-Surface`` marker — a connected agent, which MAY be relaying a person and may not; * ``api`` = any other API-key request (a script, an integration, an agent calling the REST api directly). Not provably a person either; * ``chat`` = the built-in CFO chat relaying a person's approval in-app. Its *authored* bookings stamp ``ai``; ``chat`` is only for the relay. Widening this vocabulary is a **one-way door on rollback**: the PG type is a native enum converted at load (``pg_enums._pg_enum``), so an api whose Python enum lacks a value raises ``LookupError`` reading any row that carries it. See the ``0112`` migration. - `document_no` string, nullable - `commercial_document_id` string, nullable - `snapshot_document_id` string, nullable - `net_total` string, required - `vat_total` string, required - `gross_total` string, required - `payment_status` string, nullable - `open_amount` string, nullable - `is_overdue` boolean - `posting` ItemPostingOut: The ledger projection of one ingested document — the posted/not marker. Present only on the surfaces that project it (the item lists and the item detail read, ZCT-848); everywhere else ``ItemOut.posting`` stays ``None``, which means "not computed here", NOT ``unposted``. Never branch on a missing value. It answers "is it in the journal?", not "may I code it?": a coding row posted without an entry, or an expense-receipt routing row, reads ``unposted`` here while coding the item is still refused as already booked (``gl_autopost.coding_blocker``). ``accounts`` is filled only for :attr:`ItemPostingStatus.posted` and holds **every** operating leg, largest first — a document split across three expense accounts has no single answer, and silently showing the first line would be a lie. It may legitimately be empty (an entry with only control/VAT legs). - `status` 'posted' | 'reversed' | 'held' | 'unposted', required: Where an ingested document stands in the general ledger (ZET-98/103/108). Deliberately NOT a boolean: a boolean collapses four states a treuhänder has to tell apart, and "not posted" alone cannot say *why*. - ``posted`` — a coding decision for this document points at a journal entry whose ``status`` is ``posted``. This is the only value that means "it is in the ledger"; :attr:`ItemPostingOut.accounts` says where. - ``reversed`` — the document was booked and that entry was reversed. The ledger no longer carries it, so it is **not** posted (ZET-95), but it is a materially different state from "never touched": it needs re-booking. - ``held`` — the AI accountant produced a coding proposal that did not clear the autonomy policy and is waiting for a human. Nothing is in the ledger. - ``unposted`` — everything else: no coding decision at all, a shadow-mode decision (``assist``: it *would* have posted but did not), or a decision of a kind that books nothing. - `journal_entry_id` string, nullable - `accounts` ItemPostingAccountOut[] - `account_id` string, required - `code` string, required - `name` string, required - `amount` string, required - `coding_pending` boolean - `filed_with` ItemFiledWithOut: The booking a re-ingested COPY of an invoice was filed with (ZEN-1, ZCT-945). The coder's dunning linkage (``ap_dunning.try_link_ap_document``) recognises a second upload of an invoice that is already booked and files it against that booking's open item instead of booking it twice. It writes no decision, so the copy's own projection is ``unposted`` and the lists used to read "Not posted" — to the reader the AI looked as if it had stopped posting. This names the booking the copy belongs to. Set only where "already booked" is TRUE (:func:`services.item_posting.posting_map`): an advisory, non-reminder, non-collision link whose holder entry is posted, and — for the weaker payment-reference tier — only for a copy dated like the booked invoice. ``gross`` / ``currency`` are the BOOKED document's; ``amount_differs`` says the copy prints another total or currency, so the reader checks the booking rather than trusting the badge (the linker matches amounts within a band, not exactly). - `journal_entry_id` string, required - `entry_no` string, nullable - `entry_date` string, date, required - `match_tier` string, required - `gross` string, required - `currency` string, required - `amount_differs` boolean - `sent_at` string, date-time, nullable - `last_sent_to` string, nullable - `issued_at` string, date-time, nullable - `created_at` string, date-time, required - `updated_at` string, date-time, required - `item` ItemOut: Serialized item (analysis fields read from the related File). Build with ``ItemOut.from_item`` so the derived flags + effective money source are computed consistently. ``data``/``ai_data``/``qr_data`` are the Item's own per-invoice extraction. ``document_index``/``page_range``/``document_count`` describe this invoice's position within its (possibly multi-invoice) File. The read-side derived fields (``is_paid``/``due_date``/``dunning_*``/``doc_type``/ ``document_type``/``counterparty_name``/``payment``) are populated by ``app.services.item_view`` so list + detail share one path; ``from_item`` leaves them at their defaults. - `id` string, required - `company_id` string, required - `source` 'email' | 'epost' | 'upload' | 'bexio' | 'abacus' | 'filesystem' | 'clouddrive', required - `file_id` string, required - `sha256` string, required - `filename` string, required - `size` integer, required - `mime_type` string, required - `date` string, date-time, required - `invoice_date` string, date, nullable - `service_period_start` string, date, nullable - `service_period_end` string, date, nullable - `document_index` integer - `page_range` string, nullable - `document_count` integer - `direction` 'payable' | 'receivable', required - `money_source` string, nullable - `money_source_override` string, nullable - `counterparty_id` string, nullable - `archive_status` 'pending' | 'archiving' | 'archived' | 'failed', required - `archive_error` string, nullable - `archived_at` string, date-time, nullable - `storage_connection_id` string, nullable - `storage_ref` string, nullable - `archived_path` string, nullable - `is_archived` boolean, required - `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. - `triage_reason` string, nullable - `analysis_status` 'pending' | 'analyzing' | 'analyzed' | 'failed', required - `analysis_error` string, nullable - `is_analyzed` boolean, required - `ai_data` unknown - `qr_data` unknown - `data` unknown - `email_id` string, nullable - `section` string, nullable - `epost_account_id` string, nullable - `letter_id` string, nullable - `letter_title` string, nullable - `letter_type` string, nullable - `uploaded_by` string, nullable - `bexio_account_id` string, nullable - `bexio_invoice_id` string, nullable - `bexio_document_nr` string, nullable - `bexio_status` string, nullable - `bexio_updated_at` string, date-time, nullable - `bexio_is_valid_from` string, date-time, nullable - `source_payload` unknown - `is_duplicate` boolean - `duplicate_of` ItemDuplicateOfOut: Why this item carries ``is_duplicate`` (ZET-264). ``null`` when the item is not a duplicate. Projected by the **detail** response and by the **upload** response (ZCT-515 — the surface that first tells a caller ``is_duplicate: true`` must also be able to say of what); list rows keep the boolean badge alone, because naming the siblings there is a query per row. Derived from the same predicate as ``is_duplicate``, so the two can never disagree. - `matches` ItemDuplicateMatchOut[], required - `item_id` string, required - `arms` string[], required - `match_key` string, required - `truncated` boolean - `vat_missing` boolean - `counterparty` InvoiageCoreSchemasItemCounterpartyBrief: Nested counterparty summary embedded in an item when requested. - `id` string, required - `company_id` string, required - `kind` string, required - `name` string, required - `normalized_name` string, required - `town` string, nullable - `vat_number` string, nullable - `is_paid` boolean - `due_date` string, nullable - `dunning_level` string, nullable - `dunning_label` string, nullable - `doc_type` string, nullable - `document_type` string, nullable - `is_credit_note` boolean - `card_statement_issuer` string, nullable - `counterparty_name` string, nullable - `payment` ItemPaymentInfo: Payment-ready instruction for an item, read verbatim from ``qr_data[0]``. Present on an :class:`ItemOut` only when the item is payment-ready (effective ``money_source == "qr"``, exactly one parsed QR, and a complete iban/amount/ currency). Every field comes from the QR (the authoritative payment instruction), NOT the normalized counterparty. ``amount`` is the 2-decimal accounting string. - `creditor_name` string, nullable - `creditor_iban` string, required - `amount` string, required - `currency` string, required - `reference_type` string, nullable - `reference` string, nullable - `posting` ItemPostingOut: The ledger projection of one ingested document — the posted/not marker. Present only on the surfaces that project it (the item lists and the item detail read, ZCT-848); everywhere else ``ItemOut.posting`` stays ``None``, which means "not computed here", NOT ``unposted``. Never branch on a missing value. It answers "is it in the journal?", not "may I code it?": a coding row posted without an entry, or an expense-receipt routing row, reads ``unposted`` here while coding the item is still refused as already booked (``gl_autopost.coding_blocker``). ``accounts`` is filled only for :attr:`ItemPostingStatus.posted` and holds **every** operating leg, largest first — a document split across three expense accounts has no single answer, and silently showing the first line would be a lie. It may legitimately be empty (an entry with only control/VAT legs). - `status` 'posted' | 'reversed' | 'held' | 'unposted', required: Where an ingested document stands in the general ledger (ZET-98/103/108). Deliberately NOT a boolean: a boolean collapses four states a treuhänder has to tell apart, and "not posted" alone cannot say *why*. - ``posted`` — a coding decision for this document points at a journal entry whose ``status`` is ``posted``. This is the only value that means "it is in the ledger"; :attr:`ItemPostingOut.accounts` says where. - ``reversed`` — the document was booked and that entry was reversed. The ledger no longer carries it, so it is **not** posted (ZET-95), but it is a materially different state from "never touched": it needs re-booking. - ``held`` — the AI accountant produced a coding proposal that did not clear the autonomy policy and is waiting for a human. Nothing is in the ledger. - ``unposted`` — everything else: no coding decision at all, a shadow-mode decision (``assist``: it *would* have posted but did not), or a decision of a kind that books nothing. - `journal_entry_id` string, nullable - `accounts` ItemPostingAccountOut[] - `account_id` string, required - `code` string, required - `name` string, required - `amount` string, required - `coding_pending` boolean - `filed_with` ItemFiledWithOut: The booking a re-ingested COPY of an invoice was filed with (ZEN-1, ZCT-945). The coder's dunning linkage (``ap_dunning.try_link_ap_document``) recognises a second upload of an invoice that is already booked and files it against that booking's open item instead of booking it twice. It writes no decision, so the copy's own projection is ``unposted`` and the lists used to read "Not posted" — to the reader the AI looked as if it had stopped posting. This names the booking the copy belongs to. Set only where "already booked" is TRUE (:func:`services.item_posting.posting_map`): an advisory, non-reminder, non-collision link whose holder entry is posted, and — for the weaker payment-reference tier — only for a copy dated like the booked invoice. ``gross`` / ``currency`` are the BOOKED document's; ``amount_differs`` says the copy prints another total or currency, so the reader checks the booking rather than trusting the badge (the linker matches amounts within a band, not exactly). - `journal_entry_id` string, required - `entry_no` string, nullable - `entry_date` string, date, required - `match_tier` string, required - `gross` string, required - `currency` string, required - `amount_differs` boolean - `analysis_fault` IngestFaultOut: Why an ingest record failed or is parked, and what removes the cause. - `code` 'transient' | 'quota_held' | 'defect_fixed' | 'platform_defect' | 'bytes_gone' | 'too_large' | 'unreadable' | 'unexplained' | 'unsupported_type' | 'parse_error' | 'format_unknown' | 'not_a_statement' | 'no_account_id' | 'nothing_readable' | 'no_statement_found' | 'fiscal_year_undeterminable' | 'corrupt_archive' | 'empty_archive' | 'ambiguous_tabular' | 'analysis_failed' | 'statement_format_not_importable' | 'statement_beside_invoice' | 'statement_beside_card_bill' | 'accounting_document_not_importable' | 'statement_import_failed' | 'archive_incomplete' | 'encrypted' | 'corrupt' | 'limit_exceeded' | 'ratio' | 'depth_exceeded' | 'empty' | 'archive_no_connection' | 'archive_connection_disabled' | 'archive_reconnect_required' | 'archive_no_template' | 'archive_upload_failed' | 'triage_unrelated' | 'triage_needs_review' | 'triage_irrelevant', required: The closed vocabulary. The SPA has exactly one row per member (a test enforces it). - `retry` 'auto' | 'user' | 'none', required: Whether running the same operation again can change the outcome. - `actions` IngestFaultAction[], required - `params` object - `archive_fault` IngestFaultOut: Why an ingest record failed or is parked, and what removes the cause. - `code` 'transient' | 'quota_held' | 'defect_fixed' | 'platform_defect' | 'bytes_gone' | 'too_large' | 'unreadable' | 'unexplained' | 'unsupported_type' | 'parse_error' | 'format_unknown' | 'not_a_statement' | 'no_account_id' | 'nothing_readable' | 'no_statement_found' | 'fiscal_year_undeterminable' | 'corrupt_archive' | 'empty_archive' | 'ambiguous_tabular' | 'analysis_failed' | 'statement_format_not_importable' | 'statement_beside_invoice' | 'statement_beside_card_bill' | 'accounting_document_not_importable' | 'statement_import_failed' | 'archive_incomplete' | 'encrypted' | 'corrupt' | 'limit_exceeded' | 'ratio' | 'depth_exceeded' | 'empty' | 'archive_no_connection' | 'archive_connection_disabled' | 'archive_reconnect_required' | 'archive_no_template' | 'archive_upload_failed' | 'triage_unrelated' | 'triage_needs_review' | 'triage_irrelevant', required: The closed vocabulary. The SPA has exactly one row per member (a test enforces it). - `retry` 'auto' | 'user' | 'none', required: Whether running the same operation again can change the outcome. - `actions` IngestFaultAction[], required - `params` object - `triage_fault` IngestFaultOut: Why an ingest record failed or is parked, and what removes the cause. - `code` 'transient' | 'quota_held' | 'defect_fixed' | 'platform_defect' | 'bytes_gone' | 'too_large' | 'unreadable' | 'unexplained' | 'unsupported_type' | 'parse_error' | 'format_unknown' | 'not_a_statement' | 'no_account_id' | 'nothing_readable' | 'no_statement_found' | 'fiscal_year_undeterminable' | 'corrupt_archive' | 'empty_archive' | 'ambiguous_tabular' | 'analysis_failed' | 'statement_format_not_importable' | 'statement_beside_invoice' | 'statement_beside_card_bill' | 'accounting_document_not_importable' | 'statement_import_failed' | 'archive_incomplete' | 'encrypted' | 'corrupt' | 'limit_exceeded' | 'ratio' | 'depth_exceeded' | 'empty' | 'archive_no_connection' | 'archive_connection_disabled' | 'archive_reconnect_required' | 'archive_no_template' | 'archive_upload_failed' | 'triage_unrelated' | 'triage_needs_review' | 'triage_irrelevant', required: The closed vocabulary. The SPA has exactly one row per member (a test enforces it). - `retry` 'auto' | 'user' | 'none', required: Whether running the same operation again can change the outcome. - `actions` IngestFaultAction[], required - `params` object - `item_payment` ReceivableItemPayment: Paid / open status of an INGESTED receivable, read off its ledger open item (ZET-422). The open item's two amount pairs, exactly as ``GlOpenItemOut`` carries them since ZCT-872: ``*_amount_currency`` in the item's own ``currency`` (what the document says — also what ``payment_status`` is derived from, as for an authored invoice) and ``*_amount_base`` in ``base_currency`` (what the ledger booked). A base figure is never paired with ``currency``. ``payment_status`` uses the authored arm's labels (open / partial / paid / overdue) plus ``written_off``. - `payment_status` string, nullable, required - `is_overdue` boolean, required - `currency` string, required - `base_currency` string, required - `original_amount_currency` string, nullable, required - `open_amount_currency` string, nullable, required - `original_amount_base` string, required - `open_amount_base` string, required - `total` integer, required ## Other responses - `422`: Validation Error --- [API](https://skmtc.dev/zeno-works/apis/zeno-api.md) · [All operations](https://skmtc.dev/zeno-works/apis/zeno-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zeno-works/apis/zeno-api/revisions/1eb93dde146c?raw)