Skip to main content

Database Documentation

ZeyOS features an open database model that gives developers direct access to all business data, from custom reports to integrations and automation.

Entities
82
Views
4
Meta Tables
33

Access Methods

Choose the approach that best fits your use case.

Database Reference

Browse the complete schema, or search by table name and description.

Core Entities

accountsaccounts

Customer and supplier accounts with billing, financial, and contact information.

actionstepsactionsteps

Time-tracked action steps linked to tasks, tickets, or accounts.

addressesaccounts

Billing and shipping addresses linking accounts to contacts.

applicationassetsdev

Static assets and files belonging to ZeyOS applications.

applicationsdev

ZeyOS applications with settings, versioning, and OAuth configuration.

appointmentscalendar

Calendar appointments with recurrence, location, and color coding.

associationsmain

Generic many-to-many relationships between any two entities.

binfilesdev

Binary file storage with hash-based deduplication.

campaignscampaigns

Marketing campaigns with status tracking and date ranges.

categoriesmain

User-defined categories for organizing entities.

changesmain

changes data table.

channelscontrol

Communication channels for entity notifications and updates.

commentsmain

User comments attached to activity records.

componentsinventory

Bill of materials linking parent items to component items.

contactscontacts

Contact records with personal, company, and address information.

contacts2contactscontacts

Junction table linking related contacts to each other.

contractscontracts

Recurring contracts with billing cycles and auto-billing settings.

couponcodescoupons

Individual coupon codes with redemption tracking.

couponscoupons

Discount coupons with value, tax rate, and validity periods.

cpudev

CPU usage statistics for system monitoring.

cpucollectordev

Aggregated CPU metrics from the collector service.

customfieldsadmin

Custom field definitions for extending entity schemas.

davidscontrol

CalDAV/CardDAV sync identifiers for external calendar/contact sync.

davserverscontrol

CalDAV/CardDAV server configurations for sync.

devicesinventory

Serialized inventory devices with charge and expiration tracking.

documentsdocuments

Document records with versioning support.

dunningcollection

Payment reminder notices with dunning levels and status.

dunning2transactionscollection

Junction table linking dunning notices to transactions.

entities2channelscontrol

Junction table linking entities to communication channels.

eventscalendar

Timeline events linked to entities with date ranges and metadata.

extdatafieldsdev

Extended data field definitions for custom entity attributes.

feedidscontrol

RSS/Atom feed item identifiers for deduplication.

feedserverscontrol

RSS/Atom feed server configurations.

filesmain

File attachments linked to records or comments.

followsmain

User follows for entity notifications.

forksadmin

Database fork configurations for multi-tenant setups.

groupsadmin

User groups for permission management and ownership.

groups2usersadmin

Junction table linking users to groups with write permissions.

imapidsmessages

IMAP message identifiers for email deduplication.

importscontrol

Saved import configurations for data migration.

invitationscalendar

Appointment invitations with contact and response status.

itemsinventory

Inventory items with pricing, barcodes, and stock settings.

ledgerspayments

Financial ledgers for payment categorization.

likesmain

User likes on activity records.

linkslinks

Bookmarked URLs with credentials and visit tracking.

loginsadmin

User login session records.

mailinglistsmailinglists

Email mailing lists with sender and campaign associations.

mailingrecipientsmailinglists

Recipients for mailing list campaigns.

mailserverscontrol

Email server configurations for sending and receiving.

messagereadsmessages

Read receipts for messages by user.

messagesmessages

Email messages with threading, attachments, and ticket linking.

notesnotes

Rich text notes with file attachments.

notificationsmain

User notification flags for activity records.

numcountersadmin

Auto-incrementing number counters for document numbering.

objectsobjects

Generic JSON data objects with entity typing.

opportunitiesopportunities

Sales opportunities with probability and revenue forecasting.

participantscampaigns

Campaign and mailing list participants with contact info.

paymentspayments

Payment records linked to ledgers and transactions.

permissionsadmin

Group-based access permissions for views and features.

pricelistspricelists

Price lists with date validity and account assignments.

pricelists2accountspricelists

Junction table linking price lists to accounts.

pricespricelists

Item prices per price list with rebates and discounts.

projectsprojects

Project records for organizing tasks and tickets.

recentmain

Recently accessed entities per user.

recordsmain

Activity feed records with comments, files, and monitor entries.

relateditemsinventory

Related item associations for cross-selling.

resourcesdev

Reusable script resources for applications.

servicesdev

Background services and scheduled jobs.

stocktransactionsinventory

Inventory stock movements with serial and charge tracking.

storagesinventory

Warehouse and storage location definitions.

suppliersinventory

Supplier associations for items with pricing and lead times.

tagnamesdev

Tag name definitions per entity type.

taskstasks

Task records with priority, effort, and project linking.

ticketstickets

Support tickets with status, priority, and billing items.

tokensadmin

API access tokens per user and application.

transactionsbilling

Billing and procurement transactions (quotes, orders, invoices).

usagestatsadmin

Platform usage statistics and metrics.

userfieldsadmin

User-specific field display preferences.

userfiltersadmin

Saved user filters for list views.

usersadmin

User accounts with authentication and session management.

viewsadmin

User view configurations and layout preferences.

webletsdev

UI weblets for embedding custom views in ZeyOS.

Meta Database

meta_citiesmeta

World cities with coordinates and population data.

meta_countriesmeta

ISO country codes with regional and currency data.

meta_countries_bordersmeta

Country border relationships.

meta_countries_languagesmeta

Languages spoken per country.

meta_countries_namesmeta

Localized country names.

meta_currenciesmeta

ISO currency codes with symbols and formatting.

meta_currencies_namesmeta

Localized currency names.

meta_languagesmeta

ISO language codes.

meta_languages_namesmeta

Localized language names.

meta_modulesmeta

ZeyOS module definitions.

meta_modules_namesmeta

Localized module names.

meta_postalcodesmeta

Postal code lookup data by country.

meta_regionsmeta

World regions (continents/areas).

meta_regions_namesmeta

Localized region names.

meta_statesmeta

Country states/provinces.

meta_subregionsmeta

World subregions.

meta_subregions_namesmeta

Localized subregion names.

meta_taxonomy_cnmeta

CN (Combined Nomenclature) product codes.

meta_taxonomy_cn_namesmeta

Localized CN code descriptions.

meta_taxonomy_cpvmeta

CPV (Common Procurement Vocabulary) codes.

meta_taxonomy_cpv_namesmeta

Localized CPV code descriptions.

meta_taxonomy_googlemeta

Google product taxonomy codes.

meta_taxonomy_google_namesmeta

Localized Google taxonomy descriptions.

meta_taxonomy_gpcmeta

GPC (Global Product Classification) codes.

meta_taxonomy_gpc_namesmeta

Localized GPC code descriptions.

meta_taxonomy_htsmeta

HTS (Harmonized Tariff Schedule) codes.

meta_taxonomy_hts_namesmeta

Localized HTS code descriptions.

meta_taxonomy_unspscmeta

UNSPSC product classification codes.

meta_taxonomy_unspsc_namesmeta

Localized UNSPSC code descriptions.

meta_timezonesmeta

Timezone definitions.

meta_timezones_offsetsmeta

Timezone UTC offsets including DST.

meta_tldsmeta

Top-level domain (TLD) codes.

meta_unitsmeta

Unit of measure codes (UN/CEFACT).

AI-Friendly Artifacts