PermitOS concepts
Glossary of the entities PermitOS works with: projects, packets, documents, prechecks, issues, scores, corrections, zoning checks, and activity.
Last updated 2026-05-11
Organization
A workspace that owns all projects, documents, and reports. Users belong to an organization through a membership row, and Row-Level Security keeps data scoped to that organization.
Project
A permit effort: address, jurisdiction, project type, work description, optional construction value. Every other PermitOS record (documents, reports, issues, corrections, zoning checks) hangs off a project.
Permit packet
The collection of documents and metadata you intend to submit to a jurisdiction. PermitOS does not file packets — it helps you assemble and check them.
Document
A file uploaded into a private storage bucket, with metadata like filename, size, mime type, category, and extraction_status. Categories drive checklist matching.
Precheck report
The output of a rules-only readiness check. Contains analysis_mode, readiness_score, confidence, generated_at, and the rule set version.
Issue
A single finding inside a precheck report. Each issue has a severity, source (which rule produced it), recommendation, and human_review_status.
Readiness score
0–100 number combining required-field completeness and expected-document coverage. See the Readiness Reports doc for bands.
Correction task
A trackable fix. Can be created from a reviewer comment, an issue, or directly. Links back to the project and optionally to the issue that produced it.
Reviewer note
A short, signed annotation a reviewer attaches when they confirm, dismiss, or ask for more information on an issue.
Zoning check
A user-recorded zoning question with parcel/context notes and source links. PermitOS does not perform official zoning determinations.
Activity log
An append-only record of who did what, when, against which entity. Used for audit and the recent-activity feed.
Related docs
Data model
The Supabase tables that back PermitOS and how they relate.
Projects and permit packets
Project setup fields and how a project ties documents, reports, issues, corrections, zoning checks, and activity together.
Rules-only Permit Precheck
Deterministic readiness check that runs against project fields and uploaded document categories. No AI required.