@zeyos/client 0.3.0 → 0.4.0

package/okf/entities/messages.md

@@ -0,0 +1,104 @@
+---
+type: ZeyOS Entity
+title: Messages
+description: Email and message records.
+resource: zeyos://api/messages
+tags: [messaging, generated]
+api_backed: true
+list_operation: listMessages
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `owneruser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `mailserver` | integer | yes | — | yes | [mailservers](/entities/mailservers.md) |
+| `ticket` | integer | yes | — | yes | [tickets](/entities/tickets.md) |
+| `opportunity` | integer | yes | — | yes | [opportunities](/entities/opportunities.md) |
+| `mailinglist` | integer | yes | — | yes | [mailinglists](/entities/mailinglists.md) |
+| `reference` | integer | yes | — | yes | [messages](/entities/messages.md) |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `mailbox` | smallint | no | `0` | — | — |
+| `verified` | smallint | no | `0` | — | — |
+| `date` | bigint | no | `date_part('epoch', now())` | yes | — |
+| `subject` | text | no | `''` | yes | — |
+| `sender` | text | no | `''` | yes | — |
+| `sender_email` | text | no | `''` | — | — |
+| `sender_name` | text | no | `''` | — | — |
+| `to` | text | no | `''` | yes | — |
+| `to_email` | text | no | `''` | — | — |
+| `to_name` | text | no | `''` | — | — |
+| `to_count` | integer | no | `0` | — | — |
+| `cc` | text | no | `''` | — | — |
+| `bcc` | text | no | `''` | — | — |
+| `contenttype` | text | no | `''` | — | — |
+| `text` | text | no | `''` | — | — |
+| `attachments` | text[] | yes | — | — | — |
+| `senddate` | bigint | yes | — | — | — |
+| `senderror` | text | no | `''` | — | — |
+| `messageid` | text | no | `''` | yes | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `owneruser` → [users](/entities/users.md) (`users.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `mailserver` → [mailservers](/entities/mailservers.md) (`mailservers.ID`)
+- `ticket` → [tickets](/entities/tickets.md) (`tickets.ID`)
+- `opportunity` → [opportunities](/entities/opportunities.md) (`opportunities.ID`)
+- `mailinglist` → [mailinglists](/entities/mailinglists.md) (`mailinglists.ID`)
+- `reference` → [messages](/entities/messages.md) (`messages.ID`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `mailbox`
+
+`0` = INBOX · `1` = DRAFTS · `2` = SENT · `3` = TEMPLATES · `4` = MAILINGS · `5` = ARCHIVE · `6` = TRASH · `7` = JUNK
+
+# Indexes
+
+- `fk_messages_binfile` — btree, partial on `binfile`
+- `fk_messages_fork` — gin, partial on `fork`
+- `fk_messages_mailinglist` — gin, partial on `mailinglist`
+- `fk_messages_mailserver` — gin, partial on `mailserver`
+- `fk_messages_opportunity` — btree, partial on `opportunity`
+- `fk_messages_ownergroup` — gin, partial on `ownergroup`
+- `fk_messages_owneruser` — gin, partial on `owneruser`
+- `fk_messages_reference` — btree, partial on `reference`
+- `fk_messages_ticket` — btree, partial on `ticket`
+- `i_messages_inbox_date` — btree, partial on `date`
+- `i_messages_messageid` — btree, partial on `messageid`
+- `i_messages_nofork` — gin, partial on `fork`
+- `i_messages_noowner` — gin, partial on `ownergroup`
+- `i_messages_regular_date` — btree, partial on `date`
+- `i_messages_sendmail` — btree, partial on `mailserver`
+- `i_messages_trash_date` — btree, partial on `date`
+- `s_messages_sender` — gin, partial on `sender`
+- `s_messages_subject` — gin, partial on `subject`
+- `s_messages_to` — gin, partial on `to`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listMessages`
+- get: `getMessage`
+- create: `createMessage`
+- update: `updateMessage`
+- delete: `deleteMessage`
+- exists: `existsMessage`
+<!-- okf:generated:end -->
+
+# Notes
+
+No direct `account` foreign key — link via `ticket`/`opportunity`/`mailinglist`/`reference`, or resolve customer email addresses first. Reconstruct threads via `reference`/`messageid`/`subject`.

package/okf/entities/notes.md

@@ -0,0 +1,73 @@
+---
+type: ZeyOS Entity
+title: Notes
+description: Text-centric internal knowledge items.
+resource: zeyos://api/notes
+tags: [knowledge, generated]
+api_backed: true
+list_operation: listNotes
+visibility_column: true
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `owneruser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `assigneduser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `status` | smallint | no | `0` | — | — |
+| `contenttype` | text | no | `''` | — | — |
+| `text` | text | no | `''` | — | — |
+| `attachments` | text[] | yes | — | — | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `owneruser` → [users](/entities/users.md) (`users.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `status`
+
+`0` = DRAFT · `1` = FEEDBACKREQUIRED · `2` = INREVISION · `3` = AWAITINGAPPROVAL · `4` = FINAL · `5` = OBSOLETE
+
+# Indexes
+
+- `fk_notes_assigneduser` — gin, partial on `assigneduser`
+- `fk_notes_binfile` — btree, partial on `binfile`
+- `fk_notes_fork` — gin, partial on `fork`
+- `fk_notes_ownergroup` — gin, partial on `ownergroup`
+- `fk_notes_owneruser` — gin, partial on `owneruser`
+- `i_notes_nofork` — gin, partial on `fork`
+- `i_notes_noowner` — gin, partial on `ownergroup`
+- `s_notes_name` — gin on `name`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listNotes`
+- get: `getNote`
+- create: `createNote`
+- update: `updateNote`
+- delete: `deleteNote`
+- exists: `existsNote`
+<!-- okf:generated:end -->

package/okf/entities/objects.md

@@ -0,0 +1,70 @@
+---
+type: ZeyOS Entity
+title: Objects
+description: Custom object records with arbitrary JSON payloads.
+resource: zeyos://api/objects
+tags: [platform, generated]
+api_backed: true
+list_operation: listObjects
+visibility_column: true
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `owneruser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `assigneduser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `binfile` | integer | yes | — | yes | [binfiles](/entities/binfiles.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `entity` | text | no | — | yes | — |
+| `date` | bigint | no | `EXTRACT(epoch FROM now())` | yes | — |
+| `description` | text | no | `''` | — | — |
+| `data` | json | yes | — | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `owneruser` → [users](/entities/users.md) (`users.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+- `binfile` → [binfiles](/entities/binfiles.md) (`binfiles.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+# Indexes
+
+- `fk_objects_assigneduser` — gin, partial on `assigneduser`
+- `fk_objects_binfile` — btree, partial on `binfile`
+- `fk_objects_fork` — gin, partial on `fork`
+- `fk_objects_ownergroup` — gin, partial on `ownergroup`
+- `fk_objects_owneruser` — gin, partial on `owneruser`
+- `i_objects_date` — btree on `date`
+- `i_objects_entity` — gin on `entity`
+- `i_objects_nofork` — gin, partial on `fork`
+- `i_objects_noowner` — gin, partial on `ownergroup`
+- `s_objects_name` — gin on `name`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listObjects`
+- get: `getObject`
+- create: `createObject`
+- update: `updateObject`
+- delete: `deleteObject`
+- exists: `existsObject`
+<!-- okf:generated:end -->

package/okf/entities/opportunities.md

@@ -0,0 +1,87 @@
+---
+type: ZeyOS Entity
+title: Opportunities
+description: Sales pipeline and deal records.
+resource: zeyos://api/opportunities
+tags: [crm, generated]
+api_backed: true
+list_operation: listOpportunities
+visibility_column: true
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `assigneduser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `account` | integer | yes | — | yes | [accounts](/entities/accounts.md) |
+| `contact` | integer | yes | — | yes | [contacts](/entities/contacts.md) |
+| `campaign` | integer | yes | — | yes | [campaigns](/entities/campaigns.md) |
+| `visibility` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `opportunitynum` | text | no | `''` | yes | — |
+| `date` | bigint | no | `EXTRACT(epoch FROM now())` | yes | — |
+| `duedate` | bigint | yes | — | — | — |
+| `status` | smallint | no | `0` | — | — |
+| `priority` | smallint | no | `2` | — | — |
+| `probability` | smallint | no | `0` | — | — |
+| `worstcase` | double precision | no | `0` | — | — |
+| `mostlikely` | double precision | no | `0` | — | — |
+| `upside` | double precision | no | `0` | — | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+- `contact` → [contacts](/entities/contacts.md) (`contacts.ID`)
+- `campaign` → [campaigns](/entities/campaigns.md) (`campaigns.ID`)
+
+# Enums
+
+### `visibility`
+
+`0` = REGULAR · `1` = ARCHIVED · `2` = DELETED
+
+### `status`
+
+`0` = UNEVALUATED · `1` = ELIGIBLE · `2` = FEEDBACKREQUIRED · `3` = INNEGOTIATION · `4` = OFFERED · `5` = ACCEPTED · `6` = REJECTED
+
+### `priority`
+
+`0` = LOWEST · `1` = LOW · `2` = MEDIUM · `3` = HIGH · `4` = HIGHEST
+
+# Indexes
+
+- `fk_opportunities_account` — btree, partial on `account`
+- `fk_opportunities_assigneduser` — gin, partial on `assigneduser`
+- `fk_opportunities_campaign` — btree, partial on `campaign`
+- `fk_opportunities_contact` — btree, partial on `contact`
+- `fk_opportunities_fork` — gin, partial on `fork`
+- `fk_opportunities_ownergroup` — gin on `ownergroup`
+- `i_opportunities_date` — btree on `date`
+- `i_opportunities_nofork` — gin, partial on `fork`
+- `i_opportunities_noowner` — gin, partial on `ownergroup`
+- `s_opportunities_name` — gin on `name`
+- `s_opportunities_opportunitynum` — gin, partial on `opportunitynum`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listOpportunities`
+- get: `getOpportunity`
+- create: `createOpportunity`
+- update: `updateOpportunity`
+- delete: `deleteOpportunity`
+- exists: `existsOpportunity`
+<!-- okf:generated:end -->

package/okf/entities/participants.md

@@ -0,0 +1,52 @@
+---
+type: ZeyOS Entity
+title: Participants
+description: Contacts enrolled in campaigns or mailing lists.
+resource: zeyos://api/participants
+tags: [outreach, generated]
+api_backed: true
+list_operation: listParticipants
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | bigint | no | — | yes | — |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `mailinglist` | integer | yes | — | yes | [mailinglists](/entities/mailinglists.md) |
+| `campaign` | integer | yes | — | yes | [campaigns](/entities/campaigns.md) |
+| `contact` | integer | yes | — | yes | [contacts](/entities/contacts.md) |
+| `name` | text | no | — | yes | — |
+| `phone` | text | no | `''` | — | — |
+| `email` | text | no | `''` | yes | — |
+
+# Foreign Keys
+
+- `mailinglist` → [mailinglists](/entities/mailinglists.md) (`mailinglists.ID`)
+- `campaign` → [campaigns](/entities/campaigns.md) (`campaigns.ID`)
+- `contact` → [contacts](/entities/contacts.md) (`contacts.ID`)
+
+# Indexes
+
+- `fk_participants_campaign` — gin, partial on `campaign`
+- `fk_participants_contact` — btree, partial on `contact`
+- `fk_participants_mailinglist` — gin, partial on `mailinglist`
+- `s_participants_email` — gin, partial on `email`
+- `s_participants_name` — gin on `name`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listParticipants`
+- get: `getParticipant`
+- create: `createParticipant`
+- update: `updateParticipant`
+- delete: `deleteParticipant`
+- exists: `existsParticipant`
+<!-- okf:generated:end -->

package/okf/entities/payments.md

@@ -0,0 +1,76 @@
+---
+type: ZeyOS Entity
+title: Payments
+description: Cash movement records.
+resource: zeyos://api/payments
+tags: [billing, generated]
+api_backed: true
+list_operation: listPayments
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `assigneduser` | integer | yes | — | yes | [users](/entities/users.md) |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `ledger` | integer | yes | — | yes | [ledgers](/entities/ledgers.md) |
+| `transaction` | integer | yes | — | yes | [transactions](/entities/transactions.md) |
+| `account` | integer | yes | — | yes | [accounts](/entities/accounts.md) |
+| `date` | bigint | no | `date_part('epoch', now())` | yes | — |
+| `subject` | text | no | `''` | yes | — |
+| `status` | smallint | no | `0` | — | — |
+| `amount` | double precision | no | — | — | — |
+| `autoadvance` | smallint | no | `0` | — | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+- `assigneduser` → [users](/entities/users.md) (`users.ID`)
+- `ledger` → [ledgers](/entities/ledgers.md) (`ledgers.ID`)
+- `transaction` → [transactions](/entities/transactions.md) (`transactions.ID`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+
+# Enums
+
+### `status`
+
+`0` = DRAFT · `1` = COMPLETED · `2` = CANCELLED · `3` = BOOKED
+
+# Indexes
+
+- `fk_payments_account` — btree, partial on `account`
+- `fk_payments_assigneduser` — gin, partial on `assigneduser`
+- `fk_payments_fork` — gin, partial on `fork`
+- `fk_payments_ledger` — gin, partial on `ledger`
+- `fk_payments_ownergroup` — gin on `ownergroup`
+- `fk_payments_transaction` — btree, partial on `transaction`
+- `i_payments_date` — btree on `date`
+- `i_payments_nofork` — gin, partial on `fork`
+- `i_payments_noowner` — gin, partial on `ownergroup`
+- `s_payments_subject` — gin, partial on `subject`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listPayments`
+- get: `getPayment`
+- create: `createPayment`
+- update: `updatePayment`
+- delete: `deletePayment`
+- exists: `existsPayment`
+<!-- okf:generated:end -->
+
+# Notes
+
+Cash basis. Links to a `transaction` or directly to an `account`. Sum `amount` for cash received.

package/okf/entities/permissions.md

@@ -0,0 +1,46 @@
+---
+type: ZeyOS Entity
+title: Permissions
+description: Group-level permission grants.
+resource: zeyos://api/permissions
+tags: [platform, generated]
+api_backed: true
+list_operation: listPermissions
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | bigint | no | — | yes | — |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `group` | integer | no | — | yes | [groups](/entities/groups.md) |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `application` | integer | yes | — | yes | [applications](/entities/applications.md) |
+| `identifier` | character varying(200) | yes | — | yes | — |
+| `writable` | smallint | no | `0` | — | — |
+
+# Foreign Keys
+
+- `group` → [groups](/entities/groups.md) (`groups.ID`)
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `application` → [applications](/entities/applications.md) (`applications.ID`)
+
+# Indexes
+
+- `fk_permissions_application` — gin, partial on `application`
+- `fk_permissions_fork` — gin, partial on `fork`
+- `u_permissions_group_fork_application_identifier` — btree, unique on `group, fork, application, identifier`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listPermissions`
+- get: `getPermission`
+- exists: `existsPermission`
+<!-- okf:generated:end -->

package/okf/entities/pricelists.md

@@ -0,0 +1,70 @@
+---
+type: ZeyOS Entity
+title: Price Lists
+description: Price list definitions.
+resource: zeyos://api/pricelists
+tags: [commerce, generated]
+api_backed: true
+list_operation: listPriceLists
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | integer | no | — | yes | — |
+| `fork` | integer | yes | — | yes | [forks](/entities/forks.md) |
+| `ownergroup` | integer | yes | — | yes | [groups](/entities/groups.md) |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `activity` | smallint | no | `0` | — | — |
+| `name` | text | no | — | yes | — |
+| `type` | smallint | no | `0` | — | — |
+| `currency` | character varying(3) | no | — | — | — |
+| `discount` | double precision | no | `0` | — | — |
+| `datefrom` | bigint | yes | — | — | — |
+| `dateto` | bigint | yes | — | — | — |
+| `applytoall` | smallint | no | `0` | — | — |
+| `description` | text | no | `''` | — | — |
+
+# Foreign Keys
+
+- `fork` → [forks](/entities/forks.md) (`forks.ID`)
+- `ownergroup` → [groups](/entities/groups.md) (`groups.ID`)
+
+# Enums
+
+### `activity`
+
+`0` = ACTIVE · `1` = DEACTIVATED · `2` = DELETED
+
+### `type`
+
+`0` = BILLING_MIN · `1` = BILLING_MAX · `2` = PROCUREMENT_MIN · `3` = PROCUREMENT_MAX · `4` = PRODUCTION_MIN · `5` = PRODUCTION_MAX
+
+# Indexes
+
+- `fk_pricelists_fork` — gin, partial on `fork`
+- `fk_pricelists_ownergroup` — gin on `ownergroup`
+- `i_pricelists_nofork` — gin, partial on `fork`
+- `i_pricelists_noowner` — gin, partial on `ownergroup`
+- `s_pricelists_name` — gin on `name`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listPriceLists`
+- get: `getPriceList`
+- create: `createPriceList`
+- update: `updatePriceList`
+- delete: `deletePriceList`
+- exists: `existsPriceList`
+<!-- okf:generated:end -->
+
+# Notes
+
+operationId: `listPriceLists`.

package/okf/entities/pricelists2accounts.md

@@ -0,0 +1,46 @@
+---
+type: ZeyOS Entity
+title: Price Lists To Accounts
+description: Account-to-price-list assignments.
+resource: zeyos://api/pricelists2accounts
+tags: [commerce, generated]
+api_backed: true
+list_operation: listPriceListsToAccounts
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | bigint | no | — | yes | — |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `EXTRACT(epoch FROM now())` | — | — |
+| `pricelist` | integer | no | — | yes | [pricelists](/entities/pricelists.md) |
+| `account` | integer | no | — | yes | [accounts](/entities/accounts.md) |
+
+# Foreign Keys
+
+- `pricelist` → [pricelists](/entities/pricelists.md) (`pricelists.ID`)
+- `account` → [accounts](/entities/accounts.md) (`accounts.ID`)
+
+# Indexes
+
+- `fk_pricelists2accounts_account` — btree on `account`
+- `u_pricelists2accounts_pricelist_account` — btree, unique on `pricelist, account`
+
+# Operations
+
+- list: `listPriceListsToAccounts`
+- get: `getPriceListToAccount`
+- create: `createPriceListToAccount`
+- update: `updatePriceListToAccount`
+- delete: `deletePriceListToAccount`
+- exists: `existsPriceListToAccount`
+<!-- okf:generated:end -->
+
+# Notes
+
+operationId: `listPriceListsToAccounts`.

package/okf/entities/prices.md

@@ -0,0 +1,49 @@
+---
+type: ZeyOS Entity
+title: Prices
+description: Item prices within a price list.
+resource: zeyos://api/prices
+tags: [commerce, generated]
+api_backed: true
+list_operation: listPrices
+visibility_column: false
+---
+
+<!-- okf:generated:start — rewritten by scripts/generate-okf.mjs; do not edit by hand -->
+# Schema
+
+| Column | Type | Nullable | Default | Indexed | FK |
+|---|---|---|---|---|---|
+| `ID` | bigint | no | — | yes | — |
+| `creator` | integer | yes | — | — | — |
+| `creationdate` | bigint | no | `date_part('epoch', now())` | — | — |
+| `lastmodified` | bigint | no | `date_part('epoch', now())` | — | — |
+| `item` | integer | no | — | yes | [items](/entities/items.md) |
+| `pricelist` | integer | no | — | yes | [pricelists](/entities/pricelists.md) |
+| `price` | double precision | yes | — | — | — |
+| `rebate` | double precision | no | `0` | — | — |
+| `discount` | double precision | yes | — | — | — |
+| `minamount` | double precision | no | `0` | — | — |
+| `costprice` | double precision | yes | — | — | — |
+
+# Foreign Keys
+
+- `item` → [items](/entities/items.md) (`items.ID`)
+- `pricelist` → [pricelists](/entities/pricelists.md) (`pricelists.ID`)
+
+# Indexes
+
+- `fk_prices_item` — btree on `item`
+- `fk_prices_pricelist` — gin on `pricelist`
+
+> Partial/GIN indexes back the `filters` (plural) query form for foreign-key fields. See [filters-vs-filter](/concepts/filters-vs-filter.md).
+
+# Operations
+
+- list: `listPrices`
+- get: `getPrice`
+- create: `createPrice`
+- update: `updatePrice`
+- delete: `deletePrice`
+- exists: `existsPrice`
+<!-- okf:generated:end -->