Schema index
Reusable request, response, error, command, and metadata models from the checksum-pinned OpenAPI snapshots.
This index shows contract structure, not database tables. Resolve schema references from the matching contract version; do not combine models from different Apps because their authority and error vocabularies differ.
Accounting
Owner: Vision Accounting. Lifecycle: preview. Runtime: not-public.
Accounting API 0.32.0
Download the authoritative contract · 55 reusable schemas
| Schema | Type | Required fields | Properties | Description |
|---|---|---|---|---|
| Metadata | object | 5 | 5 | Not described in the approved contract. |
| Money | object | 3 | 3 | Not described in the approved contract. |
| CounterpartyCreate | object | 4 | 7 | Not described in the approved contract. |
| InvoiceDraftCreate | object | 4 | 9 | Not described in the approved contract. |
| InvoiceDraftUpdate | object | 5 | 10 | Not described in the approved contract. |
| SettingsUpdate | object | 10 | 10 | Not described in the approved contract. |
| StripeConnection | object | 3 | 3 | Not described in the approved contract. |
| ImportRunCreate | object | 7 | 7 | Not described in the approved contract. |
| ArtifactRegister | object | 7 | 7 | Not described in the approved contract. |
| CommandResult | object | 7 | 7 | Not described in the approved contract. |
| Error | object | 1 | 1 | Not described in the approved contract. |
| AccountingPeopleAccessContract | object | 7 | 7 | Not described in the approved contract. |
| PeopleBlocker | object | 3 | 3 | Not described in the approved contract. |
| PeoplePrepareRequest | object | 12 | 12 | Not described in the approved contract. |
| PeoplePrepareResponse | object | 17 | 17 | Not described in the approved contract. |
| PeopleCommitRequest | object | 15 | 15 | Not described in the approved contract. |
| PeopleCommitResponse | object | 16 | 16 | Not described in the approved contract. |
| PeopleAbortRequest | object | 15 | 15 | Not described in the approved contract. |
| PeopleAbortResponse | object | 16 | 16 | Not described in the approved contract. |
| PeopleLifecycleError | object | 1 | 1 | Not described in the approved contract. |
| PaymentRecord | object | 4 | 14 | Not described in the approved contract. |
| PaymentAllocate | object | 5 | 6 | Not described in the approved contract. |
| RefundRecord | object | 4 | 8 | Not described in the approved contract. |
| BillingAgreementCreate | object | 12 | 15 | Not described in the approved contract. |
| BillingAgreementCancel | object | 3 | 5 | Not described in the approved contract. |
| BillingAgreementProcess | object | 1 | 2 | Not described in the approved contract. |
| CreditNoteCreate | object | 4 | 5 | Not described in the approved contract. |
| CreditNoteIssue | object | 3 | 3 | Not described in the approved contract. |
| CreditApply | object | 5 | 5 | Not described in the approved contract. |
| InvoiceApprove | object | 3 | 3 | Not described in the approved contract. |
| InvoiceIssue | object | 3 | 3 | Not described in the approved contract. |
| PaymentApply | object | 3 | 5 | Not described in the approved contract. |
| CreditRefund | object | 4 | 5 | Not described in the approved contract. |
| CreditApplyInvoices | object | 3 | 5 | Not described in the approved contract. |
| CreditNoteSend | object | 4 | 5 | Not described in the approved contract. |
| InvoiceSendNow | object | 2 | 4 | Not described in the approved contract. |
| StripeConnectStatus | object | 4 | 25 | The workspace's Stripe Connect status. `available` is false when this Vision has no Stripe platform configured; the other fields are then absent except `reason`. |
| StripeConnectAuthorize | object | 1 | 1 | Not described in the approved contract. |
| StripeConnectAuthorizeResult | object | 3 | 4 | Not described in the approved contract. |
| StripeDisconnect | object | 1 | 1 | Not described in the approved contract. |
| StripeDisconnectResult | object | 2 | 4 | Not described in the approved contract. |
| StripeBranding | object | 2 | 2 | Not described in the approved contract. |
| StripeBrandingResult | object | 3 | 3 | Not described in the approved contract. |
| InvoicePayLinkRequest | object | 1 | 2 | Not described in the approved contract. |
| InvoicePayLink | object | 3 | 4 | Not described in the approved contract. |
| SampleMarkers | object | 0 | 2 | Additive markers for sample data (vision-module-provisioning.v1 seedSample). Every invoice, customer/counterparty, product and payment row or record carries isSample, and so do the overview's recentActivity and topDebtors rows. A page (and the overview) carries includesSample: true when its totalCount or figures counted a sample row. The payment and credit-note pickers never offer a sample customer or invoice, because sample data can't be paid or credited. A client that does not know these keys may ignore them. |
| PaymentSendReceipt | object | 2 | 4 | Not described in the approved contract. |
| PaymentUndo | object | 3 | 3 | Not described in the approved contract. |
| CashSaleRecord | object | 4 | 6 | Not described in the approved contract. |
| InvoicingDetails | object | 4 | 5 | Not described in the approved contract. |
| InvoicingSwitch | object | 3 | 3 | Not described in the approved contract. |
| InvoiceReminder | object | 4 | 4 | Not described in the approved contract. |
| RepeatingInvoiceCreate | object | 4 | 10 | Not described in the approved contract. |
| RepeatingInvoiceSwitch | object | 3 | 4 | Not described in the approved contract. |
| RepeatingInvoiceUpdate | object | 5 | 10 | Not described in the approved contract. |
Calendar
Owner: Vision Calendar. Lifecycle: preview. Runtime: restricted.
Calendar API 1.20.0
Download the authoritative contract · 84 reusable schemas
| Schema | Type | Required fields | Properties | Description |
|---|---|---|---|---|
| ActorReference | string | 0 | 0 | Not described in the approved contract. |
| EventReference | string | 0 | 0 | Not described in the approved contract. |
| OccurrenceReference | string | 0 | 0 | Not described in the approved contract. |
| CollectionReference | string | 0 | 0 | Not described in the approved contract. |
| HoldReference | string | 0 | 0 | Not described in the approved contract. |
| ConflictInterval | object | 4 | 4 | Not described in the approved contract. |
| Error | object | 8 | 9 | Not described in the approved contract. |
| AgendaItemCollection | object | 4 | 4 | The calendar an event belongs to, carried on the event so a client can group, filter and colour without a second request. Returned on availability_only items too: an availability_only event reaches an agenda only through a calendar the same caller can already list, so the calendar is how they were entitled to the row rather than a detail of the commitment. Per-actor authority and preference (permission, writable, isDefault, visible, includeInAvailability) are NOT here — they belong to GET /calendar/v1/collections. |
| AgendaItem | object | 13 | 13 | Not described in the approved contract. |
| ContributionItem | object | 14 | 15 | A `vision-contribution-item.v1` as Core defines it. Core stamps `ownerApp` from the resolved provider and ignores the payload value. |
| ContributionPage | object | 2 | 2 | Not described in the approved contract. |
| Agenda | object | 7 | 7 | Self-contained schedule view response. Includes the actor-authorized collections, eligible people directory, and viewer identity alongside agenda items, so the generic calendar-kind renderer needs no supplementary Calendar-specific fetch. |
| Event | schema | 0 | 0 | Not described in the approved contract. |
| Availability | object | 6 | 11 | Not described in the approved contract. |
| ConflictQuery | object | 3 | 4 | Not described in the approved contract. |
| Conflicts | object | 3 | 3 | Not described in the approved contract. |
| RecurrenceSpec | object | 4 | 4 | Count-bounded recurrence. The frequency, interval, and count combination must expand no farther than two years; byWeekday is required only for weekly rules. Recurring all-day events are not accepted in v1. |
| EventReminderInput | object | 2 | 2 | A Calendar-owned reminder trigger. Duplicate channel/offset pairs are rejected and an event may have at most five reminders. |
| EventReminder | schema | 0 | 0 | Not described in the approved contract. |
| EventFields | object | 0 | 13 | Not described in the approved contract. |
| EventCommand | schema | object | object | 0 | 0 | Not described in the approved contract. |
| HoldCommand | object | object | 0 | 0 | Not described in the approved contract. |
| AttendanceCommand | object | 5 | 5 | Not described in the approved contract. |
| RecurrenceExceptionCommand | object | object | object | 0 | 0 | Not described in the approved contract. |
| ActorBindingInput | object | 3 | 3 | Not described in the approved contract. |
| ActorBinding | object | 7 | 7 | Not described in the approved contract. |
| CommandResult | object | 6 | 6 | Not described in the approved contract. |
| AvailabilitySlotsQuery | object | 4 | 7 | Not described in the approved contract. |
| AvailabilitySlots | object | 5 | 5 | Not described in the approved contract. |
| WeeklyScheduleWeek | object | 0 | 7 | Not described in the approved contract. |
| AvailabilityCommand | object | object | object | object | 0 | 0 | Not described in the approved contract. |
| CalendarPresentation | object | 6 | 6 | Not described in the approved contract. |
| PresentationSection | object | 7 | 7 | Not described in the approved contract. |
| Health | object | 3 | 3 | Not described in the approved contract. |
| CollectionKind | personal | shared | resource | provider_mapped | subscribed | 0 | 0 | What the calendar is. All five are representable, listable and permission-correct; `subscribed` is read-only whoever owns it. Only personal, shared and resource can be CREATED through this API: provider_mapped and subscribed name an external provider, and this version implements no provider OAuth or synchronisation. |
| CollectionPermission | owner | writer | reader | 0 | 0 | The effective permission for the CALLING actor. `owner` is calendar ownership, `writer` an explicit grant, `reader` either an explicit grant or workspace visibility. A subscribed calendar reports `reader` even to its owner. |
| HexColour | string | 0 | 0 | #RGB, #RGBA, #RRGGBB or #RRGGBBAA. Matches the calendar_hex_colour domain used for event colours, because a calendar colour and an event colour override each other in the same renderer. |
| Collection | object | 12 | 12 | Not described in the approved contract. |
| Collections | object | 2 | 2 | Not described in the approved contract. |
| EligiblePerson | object | 4 | 4 | Not described in the approved contract. |
| EligiblePeopleViewer | object | 1 | 1 | The authenticated viewer's opaque Calendar actor reference. Lets a client highlight 'you' in the eligible-people list without a second lookup. |
| EligiblePeople | object | 3 | 3 | Not described in the approved contract. |
| CollectionCommand | object | object | object | object | object | object | 0 | 0 | Not described in the approved contract. |
| ExternalAttendeeInput | object | 2 | 3 | Not described in the approved contract. |
| EventAttendee | object | 7 | 7 | Exactly one of actorReference or externalAddress is non-null. Authenticated attendance responses apply only to actorReference attendees. |
| InvitationNotificationIntent | object | 8 | 10 | A durable Calendar-owned notification intent emitted to the outbox. It requests downstream notification processing and does not assert that an invitation was delivered. |
| ReminderNotificationIntent | object | 11 | 11 | A scheduled Calendar-owned notification intent. available_at is the future event or occurrence start minus minutesBeforeStart; elapsed triggers are not enqueued. Delivery belongs to centralized Vision Notifications. Cancelled and superseded intents are terminal and must not be claimed. |
| Provider | google_calendar | microsoft_365 | 0 | 0 | Not described in the approved contract. |
| ProviderConnection | object | 13 | 13 | Actor-owned provider-neutral connection metadata. Availability is operational readiness, distinct from persisted connectionState. No protected references are emitted. |
| ProviderConnections | object | 2 | 2 | Not described in the approved contract. |
| ProviderCalendar | object | 9 | 9 | Discovered or mapped calendar metadata; presence is not synchronization evidence. |
| ProviderCalendars | object | 3 | 3 | Not described in the approved contract. |
| RequestCallCommand | object | object | object | object | 0 | 0 | Calendar-owned orchestration contract. Qualification and CRM record fields are deliberately absent. |
| RequestCallNotificationIntent | object | 4 | 6 | A durable delivery intent, not evidence that a notification was delivered. |
| AgendaViewer | object | 1 | 1 | The authenticated actor viewing this schedule. |
| SyncConnectionProvider | google_calendar | microsoft_365 | zoom | 0 | 0 | Not described in the approved contract. |
| SyncCalendarProvider | google_calendar | microsoft_365 | 0 | 0 | Not described in the approved contract. |
| ConferencingProvider | google_meet | microsoft_teams | zoom | custom_link | phone | 0 | 0 | Not described in the approved contract. |
| SyncCalendarReference | string | 0 | 0 | Not described in the approved contract. |
| SyncCalendar | object | 10 | 10 | Not described in the approved contract. |
| SyncConnection | object | 13 | 13 | Not described in the approved contract. |
| SyncConnections | object | 2 | 2 | Not described in the approved contract. |
| SyncConnectionCommand | object | object | object | object | 0 | 0 | Not described in the approved contract. |
| SyncConnectionResult | object | 2 | 5 | Not described in the approved contract. |
| IcsSubscription | object | 8 | 8 | Not described in the approved contract. |
| IcsSubscriptions | object | 2 | 2 | Not described in the approved contract. |
| IcsSubscriptionCommand | object | object | object | 0 | 0 | Not described in the approved contract. |
| IcsSubscriptionResult | object | 2 | 2 | Not described in the approved contract. |
| IcsFeed | object | 9 | 9 | Not described in the approved contract. |
| IcsFeeds | object | 2 | 2 | Not described in the approved contract. |
| IcsFeedCommand | object | object | object | 0 | 0 | Not described in the approved contract. |
| IcsFeedResult | object | 2 | 3 | Not described in the approved contract. |
| DialIn | object | 3 | 3 | Not described in the approved contract. |
| ConferencingOption | object | 3 | 3 | Not described in the approved contract. |
| ConferencingPreferences | object | 7 | 7 | Not described in the approved contract. |
| ConferencingPreferenceCommand | object | 2 | 5 | Not described in the approved contract. |
| ConferencingPreferenceResult | object | 2 | 2 | Not described in the approved contract. |
| ConferencingCommand | object | object | 0 | 0 | Not described in the approved contract. |
| Conference | object | 9 | 9 | Not described in the approved contract. |
| PresentationView | object | 12 | 19 | One screen of the module, as Core draws it. Generated from the descriptor schema the service validates its own answer against. |
| PresentationAction | object | 8 | 13 | One thing a person can do from a view, and the form Core shows for it. Generated from the descriptor schema the service validates its own answer against. |
| PersonSharingCommand | object | 2 | 2 | Not described in the approved contract. |
| PeopleAgendaQuery | object | 3 | 3 | Not described in the approved contract. |
| PeopleAgenda | object | 4 | 4 | Not described in the approved contract. |
CRM
Owner: Vision CRM. Lifecycle: preview. Runtime: restricted.
CRM API 9.12.1
Download the authoritative contract · 59 reusable schemas
| Schema | Type | Required fields | Properties | Description |
|---|---|---|---|---|
| ApiMetadata | object | 5 | 5 | Not described in the approved contract. |
| Error | object | 8 | 9 | A request that would send something about a sample record (0056) to a person or another system (email.send for a sample deal or a deal whose contact is a sample) is refused 409 INVALID_STATE with refusal "sample_record_outbound_blocked", the same code in fieldIssues [{"path":"data","code":"sample_record_outbound_blocked"}], and a plain message; nothing is recorded or sent. |
| Priority | object | 3 | 3 | Not described in the approved contract. |
| AttentionItem | object | 8 | 26 | Not described in the approved contract. |
| Today | object | 6 | 12 | Not described in the approved contract. |
| RecordOwner | object | 2 | 2 | Not described in the approved contract. |
| OpportunityStage | new | review_needed | exploring | qualified | solution_shaping | proposal_or_decision | won | deferred | closed_not_proceeding | 0 | 0 | Not described in the approved contract. |
| PeoplePage | object | 4 | 5 | Exact item fields are enforced by the v1 runtime schema and compatibility fixture. |
| PersonDetail | object | 8 | 9 | Canonical person and bounded organization, opportunity, and open-task links. Exact fields are enforced by the v1 runtime schema and fixture. |
| OrganizationsPage | object | 4 | 5 | Not described in the approved contract. |
| OrganizationDetail | object | 8 | 9 | Canonical organization and bounded people, opportunity, and open-task links. Exact fields are enforced by the v1 runtime schema and fixture. |
| OpportunitiesPage | object | 4 | 10 | Items additionally carry stageKey and stageKind (Phase 4 board grouping). pipeline, pipelines, summary and viewCounts are optional Phase 4 additions. |
| OpportunityDetail | object | 8 | 24 | Authoritative opportunity state, participants, and open work. Exact fields are enforced by the v1 runtime schema and fixture. |
| TasksPage | object | 4 | 5 | Not described in the approved contract. |
| TaskDetail | object | 9 | 15 | One task, the same shape as a tasks-page item plus schemaVersion. Exact fields are enforced by the v1 runtime schema. |
| Search | object | 3 | 3 | Not described in the approved contract. |
| IntakeStatus | received | screening | review_needed | accepted | dismissed | failed | 0 | 0 | Not described in the approved contract. |
| IntakeQueueItem | object | 17 | 24 | Not described in the approved contract. |
| IntakeQueue | object | 4 | 6 | Not described in the approved contract. |
| IntakeDetail | object | 14 | 18 | Full quarantined intake, consent evidence, source attribution and processing history. The field-level contract is additionally enforced by the published Zod schema and compatibility fixture. |
| CrmCommand | object | 3 | 8 | Strict discriminated command. Runtime validation applies command-specific data fields and reference formats. record.assign data: assignTo (Core user uuid from the caller's Core assignablePeople, or null to return the record to the pool), optional reasonCode (default "reassigned") and optional reasonDetail note (becomes the assignment activity body); an assignee outside the caller's assignablePeople is refused with INVALID_STATE. opportunity.create data.pipelineId (optional uuid): open in that workspace pipeline at its first enabled open stage; unknown -> INVALID_STATE (data.pipelineId, pipeline_not_found). opportunity.stage: data.wonDecisionReference is optional; a Won move without it records reasonDetail, else reasonCode, as the reference. opportunity.move data {stageKey}: one click, an OPEN stage of the deal's own pipeline only; stage event reason board_move; clears won_at when leaving won. opportunity.close data {stageKey, note?, reasonCode?, reasonDetail?}: a won or lost stage of the deal's own pipeline; won stores note (default "Won") as the won decision reference; lost requires reasonCode in budget|timing|chose_competitor|no_decision|not_a_fit|other. Stage refusals are INVALID_STATE with a fieldIssue: stage_not_in_pipeline, stage_kind_not_allowed, next_step_required (data.stageKey/data.nextAction) or required (data.reasonCode). |
| CrmCommandResult | object | 6 | 6 | Not described in the approved contract. |
| IntakeReviewCommand | object | 5 | 5 | Strict discriminated command. See the compatibility request fixture and runtime schema for action-specific fields. |
| IntakeReviewResult | object | 7 | 7 | Not described in the approved contract. |
| Timeline | object | 4 | 4 | Not described in the approved contract. |
| TimelineEntry | object | 10 | 11 | Not described in the approved contract. |
| FunnelStage | object | 9 | 12 | Not described in the approved contract. |
| Funnel | object | 5 | 8 | Not described in the approved contract. |
| Actor | object | 8 | 9 | One of Core's assignablePeople for the signed-in user, with CRM workload layered on. CRM has no users of its own. |
| Actors | object | 3 | 3 | Not described in the approved contract. |
| PresentationBadge | object | 4 | 4 | A live count the shell may render beside a navigation label. Nav that carries counts is a work surface rather than a menu. |
| PresentationSection | object | 7 | 7 | Not described in the approved contract. |
| PresentationField | object | 6 | 19 | Not described in the approved contract. |
| PresentationView | object | 13 | 23 | Not described in the approved contract. |
| PresentationAction | object | 9 | 10 | Not described in the approved contract. |
| Presentation | object | 7 | 7 | CRM's interface, described rather than shipped. Nothing here is executable and nothing names a colour, a pixel or an asset: the core owns the design system, and a module that could ship code into the core has shipped UI into the core. Because it is declarative it is also legible to an agent, which a compiled bundle is not. |
| Pipelines | object | 3 | 3 | Not described in the approved contract. |
| SchedulingSettings | object | 6 | 6 | Not described in the approved contract. |
| ServiceLineDetail | object | 6 | 6 | Not described in the approved contract. |
| MeetingLengthDetail | object | 8 | 8 | Not described in the approved contract. |
| AgendaItem | object | 11 | 11 | Not described in the approved contract. |
| TriageCommand | object | 4 | 5 | Not described in the approved contract. |
| TriageResult | object | 3 | 3 | Not described in the approved contract. |
| TodayContributionPage | object | 2 | 2 | Core-owned shape vision-contribution-page.v1; Core validates it strictly. |
| TodayContributionWidgets | object | 2 | 2 | Core-owned shape vision-contribution-widgets.v1; Core validates it strictly. |
| PipelineOverview | object | 2 | 3 | Not described in the approved contract. |
| LeadFormSubmission | object | 4 | 15 | vision-crm-lead-form.v1. Standard fields plus any number (up to 100) of labelled answers. Needs an email address or a phone number. Lands in the review queue; a person accepts it. |
| LeadFormReceipt | object | 7 | 7 | Not described in the approved contract. |
| AccessSettings | object | 5 | 5 | Not described in the approved contract. |
| ImportSummary | object | 10 | 20 | Not described in the approved contract. |
| ImportOverview | object | 0 | 3 | Not described in the approved contract. |
| ImportCreate | object | 6 | 6 | Not described in the approved contract. |
| ImportCreated | object | 0 | 2 | Not described in the approved contract. |
| ImportRows | object | 3 | 3 | Not described in the approved contract. |
| ImportRowsStaged | object | 0 | 4 | Not described in the approved contract. |
| ImportStart | object | 4 | 5 | Not described in the approved contract. |
| ImportUndo | object | 2 | 2 | Not described in the approved contract. |
| ImportDetail | schema | 0 | 0 | Not described in the approved contract. |
| ImportRowsPage | object | 0 | 5 | Not described in the approved contract. |
People & Companies
Owner: Vision People & Companies. Lifecycle: preview. Runtime: restricted.
People & Companies API 1.5.0
Download the authoritative contract · 17 reusable schemas
| Schema | Type | Required fields | Properties | Description |
|---|---|---|---|---|
| object | 0 | 5 | Not described in the approved contract. | |
| Phone | object | 0 | 6 | Not described in the approved contract. |
| SocialLink | object | 0 | 3 | Not described in the approved contract. |
| Address | object | 0 | 11 | Not described in the approved contract. |
| Affiliation | object | 0 | 10 | Not described in the approved contract. |
| Consent | object | 0 | 5 | The newest answer per channel and purpose; the full history is kept. |
| Person | object | 0 | 25 | Not described in the approved contract. |
| Company | object | 0 | 25 | Not described in the approved contract. |
| PersonSummary | object | 0 | 7 | Not described in the approved contract. |
| CompanySummary | object | 0 | 9 | Not described in the approved contract. |
| PersonPage | object | 3 | 4 | Not described in the approved contract. |
| CompanyPage | object | 3 | 4 | Not described in the approved contract. |
| DuplicateHint | object | 0 | 6 | Not described in the approved contract. |
| Deleted | object | 0 | 2 | Not described in the approved contract. |
| ChangeEvent | object | 0 | 8 | Events about sample data never appear in the feed. A sample record a person changed and the owner chose to keep appears then, as created (detail.fromSample). |
| CommandEnvelope | object | 3 | 3 | Not described in the approved contract. |
| Error | object | 1 | 1 | Every error, including unknown paths (404 not_found), malformed JSON (400 invalid_request), an oversized body (413) and an unsupported content type (415), uses this envelope; the X-Request-ID response header equals error.requestId. retryable is true only for dependency_unavailable. |
To Do
Owner: Vision To Do. Lifecycle: preview. Runtime: restricted.
To Do module API 1.9.0
Download the authoritative contract · 0 reusable schemas
No reusable component schemas are declared.
Vision Core
Owner: Vision Core. Lifecycle: preview. Runtime: acceptance-gated.
Platform API 1.0.0-preview.8
Download the authoritative contract · 8 reusable schemas
| Schema | Type | Required fields | Properties | Description |
|---|---|---|---|---|
| TokenResponse | object | 4 | 4 | Not described in the approved contract. |
| AccessTokenClaims | object | 16 | 18 | Claims of a JWT access token from /oauth/token. App tokens also carry `installation_id`. |
| AuthorizationServerMetadata | object | 6 | 6 | Not described in the approved contract. |
| OAuthError | object | 1 | 2 | Not described in the approved contract. |
| ApiError | object | 1 | 1 | Not described in the approved contract. |
| OrganizationBasics | object | 3 | 3 | Not described in the approved contract. |
| PublicationProjection | object | 8 | 8 | Not described in the approved contract. |
| AppList | object | 3 | 3 | Not described in the approved contract. |