> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quivly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Core Objects

> Standard objects included in Quivly

## Overview

Core objects are pre-built objects that come with Quivly. They cannot be deleted or renamed, but you can add custom fields to them.

All core objects share a set of standard system fields (`id`, `external_id`, `organization_id`, `is_active`, `metadata`, `created_at`, `updated_at`) which are omitted from the tables below for brevity.

***

## Customers

The central object representing your customer accounts. All other objects reference back to a customer.

**Data sources:** CRM (Salesforce Accounts, HubSpot Companies), enriched by billing, support, and enrichment data

<Tabs>
  <Tab title="Basic Info">
    | Field | Type | Description |
    | - | - | - |
    | `customer_name` | text | Name of the company |
    | `customer_domain` | text | Website domain |
    | `customer_id` | text | Customer identifier from external systems |
    | `long_description` | text | Description of the company |
    | `logo_url` | text | URL to company logo |
  </Tab>

  <Tab title="Enrichment">
    | Field | Type | Description |
    | - | - | - |
    | `industry` | text | Industry classification |
    | `country` | text | Country where company is located |
    | `country_code` | text | ISO country code |
    | `city` | text | City location |
    | `linkedin_id` | text | LinkedIn company ID |
    | `linkedin_url` | text | URL to LinkedIn company page |
  </Tab>

  <Tab title="Financial">
    | Field | Type | Description |
    | - | - | - |
    | `employee_count` | number | Number of employees |
    | `employee_count_range` | text | Employee count range (e.g., "11-50") |
    | `founded_year` | number | Year company was founded |
    | `annual_revenue_usd` | number | Annual revenue in USD |
    | `total_funding_usd` | number | Total funding received in USD |
    | `last_funding_round_date` | date | Date of last funding round |
    | `funding_stage` | text | Current funding stage |
  </Tab>

  <Tab title="CS Fields">
    | Field | Type | Description |
    | - | - | - |
    | `lifecycle_stage` | select | Customer lifecycle stage |
    | `segment` | select | Customer segment |
    | `tier` | select | Service tier |
    | `csm_owner_id` | reference | Customer Success Manager |
    | `ae_owner_id` | reference | Account Executive |
    | `customer_since` | date | When customer relationship started |
    | `primary_source` | text | Primary data source |
    | `parent_external_id` | text | External ID of parent company |

    **Allowed values:**

    * **Lifecycle Stage:** `prospect`, `onboarding`, `active`, `renewing`, `at_risk`, `churned`
    * **Segment:** `startup`, `smb`, `mid_market`, `enterprise`, `strategic`
    * **Tier:** `strategic`, `high_touch`, `mid_touch`, `low_touch`, `self_serve`
    * **Primary Source:** `salesforce`, `hubspot`, `chargebee`, `stripe`, `manual`
  </Tab>
</Tabs>

***

## Contacts

Individual people within customer organizations.

**Data sources:** CRM (Salesforce Contacts, HubSpot Contacts)

<Tabs>
  <Tab title="Basic Info">
    | Field | Type | Description |
    | - | - | - |
    | `email` | text | Primary email address |
    | `first_name` | text | Given name |
    | `last_name` | text | Family name |
    | `full_name` | text | Complete name (first + last) |
    | `phone` | text | Primary phone number |
    | `photo_url` | text | URL to profile photo |
    | `linkedin_url` | text | LinkedIn profile URL |
  </Tab>

  <Tab title="Job Info">
    | Field | Type | Description |
    | - | - | - |
    | `title` | text | Job title |
    | `department` | text | Department or team name |
    | `source_system` | text | Source system (salesforce, hubspot, etc.) |
  </Tab>

  <Tab title="CS Fields">
    | Field | Type | Description |
    | - | - | - |
    | `customer_id` | reference | Customer account this contact belongs to |
    | `role_type` | text | CS role type |
    | `last_activity_at` | date | Timestamp of last recorded activity |
    | `last_contacted_at` | date | Timestamp when contact was last reached out to |

    **Allowed values:**

    * **Role Type:** `champion`, `decision_maker`, `economic_buyer`, `influencer`, `end_user`, `detractor`
  </Tab>
</Tabs>

***

## Opportunities

Sales opportunities including new deals, renewals, and expansions.

**Data sources:** CRM (Salesforce Opportunities, HubSpot Deals)

<Tabs>
  <Tab title="Basic Info">
    | Field | Type | Description |
    | - | - | - |
    | `name` | text | Name or title of the opportunity |
    | `description` | text | Detailed description |
    | `opportunity_type` | text | Classification of the opportunity |
    | `stage` | text | Stage in sales/CS process |
    | `status` | text | Current status |

    **Allowed values:**

    * **Opportunity Type:** `new`, `expansion`, `renewal`, `retention`
    * **Stage:** `qualification`, `proposal`, `negotiation`, `closed_won`, `closed_lost`
    * **Status:** `open`, `won`, `lost`, `abandoned`
  </Tab>

  <Tab title="Details">
    | Field | Type | Description |
    | - | - | - |
    | `amount` | number | Monetary value of the opportunity |
    | `currency` | text | ISO 4217 currency code (e.g., USD, EUR) |
    | `close_date` | date | Expected or actual close date |
    | `last_activity_at` | date | Timestamp of last recorded activity |
    | `source_system` | text | Source system (salesforce, hubspot) |
  </Tab>

  <Tab title="Relationships">
    | Field | Type | Description |
    | - | - | - |
    | `customer_id` | reference | Customer account this opportunity belongs to |
    | `primary_contact_id` | reference | Main contact person |
    | `owner_id` | reference | Assigned owner |
  </Tab>
</Tabs>

***

## Subscriptions

Recurring billing subscriptions from your payment platform.

**Data sources:** Stripe Subscriptions

<Tabs>
  <Tab title="Subscription Info">
    | Field | Type | Description |
    | - | - | - |
    | `description` | text | Description or memo |
    | `status` | text | Subscription status |
    | `currency` | text | ISO 4217 currency code |
    | `collection_method` | text | How payment is collected |
    | `items` | json | Array of subscription items with price, quantity, and product info |

    **Allowed values:**

    * **Status:** `active`, `past_due`, `canceled`, `unpaid`, `trialing`, `incomplete`, `incomplete_expired`, `paused`
    * **Collection Method:** `charge_automatically`, `send_invoice`
  </Tab>

  <Tab title="Period & Dates">
    | Field | Type | Description |
    | - | - | - |
    | `start_date` | date | When the subscription originally started |
    | `current_period_start` | date | When the current billing period started |
    | `current_period_end` | date | When the current billing period ends |
    | `billing_cycle_anchor` | date | Day of month when billing cycle resets |
    | `trial_start` | date | When the trial period started |
    | `trial_end` | date | When the trial period ends |
    | `days_until_due` | number | Days after invoice creation before payment is due |
  </Tab>

  <Tab title="Cancellation">
    | Field | Type | Description |
    | - | - | - |
    | `cancel_at_period_end` | boolean | If true, subscription cancels at end of current period |
    | `cancel_at` | date | When the subscription is scheduled to cancel |
    | `canceled_at` | date | When subscription was marked for cancellation |
    | `ended_at` | date | When subscription actually ended |
    | `cancellation_details` | json | Reason, feedback, and comments about cancellation |
  </Tab>

  <Tab title="Relationships">
    | Field | Type | Description |
    | - | - | - |
    | `customer_id` | reference | Customer account this subscription belongs to |
    | `source_system` | text | Billing provider source |
  </Tab>
</Tabs>

***

## Invoices

Billing transactions and payment history.

**Data sources:** Stripe Invoices

<Tabs>
  <Tab title="Invoice Info">
    | Field | Type | Description |
    | - | - | - |
    | `number` | text | Human-readable invoice number |
    | `status` | text | Invoice status |
    | `billing_reason` | text | Why this invoice was created |
    | `collection_method` | text | How payment is collected |
    | `currency` | text | ISO 4217 currency code |

    **Allowed values:**

    * **Status:** `draft`, `open`, `paid`, `uncollectible`, `void`
    * **Billing Reason:** `subscription_create`, `subscription_cycle`, `subscription_update`, `manual`
    * **Collection Method:** `charge_automatically`, `send_invoice`
  </Tab>

  <Tab title="Amounts">
    | Field | Type | Description |
    | - | - | - |
    | `subtotal` | number | Total before tax |
    | `subtotal_excluding_tax` | number | Subtotal without tax |
    | `tax` | number | Total tax |
    | `total` | number | Total amount including tax |
    | `total_excluding_tax` | number | Total without tax |
    | `amount_due` | number | Amount currently owed |
    | `amount_paid` | number | Amount that has been paid |
    | `amount_remaining` | number | Amount still to be paid |
  </Tab>

  <Tab title="Dates & Status">
    | Field | Type | Description |
    | - | - | - |
    | `due_date` | date | When payment is due |
    | `period_start` | date | Start of billing period covered |
    | `period_end` | date | End of billing period covered |
    | `source_created_at` | date | Original creation date from billing provider |
    | `status_transitions` | json | Timestamps for status changes (finalized, paid, voided, etc.) |
    | `attempt_count` | number | How many times payment has been attempted |
  </Tab>

  <Tab title="Items & Links">
    | Field | Type | Description |
    | - | - | - |
    | `line_items` | json | Array of line items with description, amount, quantity |
    | `hosted_invoice_url` | text | Link to view invoice online |
    | `invoice_pdf` | text | Link to download invoice as PDF |
  </Tab>

  <Tab title="Relationships">
    | Field | Type | Description |
    | - | - | - |
    | `customer_id` | reference | Customer account this invoice belongs to |
    | `subscription_id` | reference | Subscription this invoice is for |
    | `source_system` | text | Billing provider source |
  </Tab>
</Tabs>

***

## Support Tickets

Customer support requests and issues.

**Data sources:** Pylon Issues

<Tabs>
  <Tab title="Ticket Info">
    | Field | Type | Description |
    | - | - | - |
    | `ticket_number` | text | Human-readable number (e.g., #1234) |
    | `subject` | text | Subject line |
    | `description` | text | Ticket body |
    | `status` | text | Ticket status |
    | `priority` | text | Ticket priority |
    | `ticket_type` | text | Ticket type |
    | `channel` | text | Source channel |
    | `ticket_url` | text | Link to source system |
    | `tags` | json | Array of tag strings |

    **Allowed values:**

    * **Status:** `open`, `pending`, `solved`, `closed`
    * **Priority:** `low`, `normal`, `high`, `urgent`
    * **Type:** `question`, `incident`, `problem`, `task`
    * **Channel:** `email`, `chat`, `phone`, `web`, `slack`
  </Tab>

  <Tab title="People">
    | Field | Type | Description |
    | - | - | - |
    | `requester_email` | text | Email of requester (used to match to contacts) |
    | `requester_name` | text | Display name of requester |
    | `group_name` | text | Team/group handling the ticket |
  </Tab>

  <Tab title="Metrics">
    | Field | Type | Description |
    | - | - | - |
    | `first_response_time_seconds` | number | Time from creation to first reply (seconds) |
    | `full_resolution_time_seconds` | number | Time from creation to resolution (seconds) |
    | `reply_count` | number | Number of agent replies |
    | `satisfaction_score` | number | Normalized CSAT score (0-100 scale) |
    | `first_response_at` | date | When first response was sent |
    | `resolved_at` | date | When ticket was resolved |
  </Tab>

  <Tab title="Relationships">
    | Field | Type | Description |
    | - | - | - |
    | `customer_id` | reference | Resolved from account or requester |
    | `primary_contact_id` | reference | Contact who raised ticket |
    | `assignee_user_id` | reference | Assigned agent |
    | `source_system` | text | Support provider (pylon, zendesk, intercom, freshdesk, etc.) |
  </Tab>
</Tabs>

***

## Call Recordings

Customer call transcripts and summaries.

**Data sources:** Fireflies, Fathom

<Tabs>
  <Tab title="Call Info">
    | Field | Type | Description |
    | - | - | - |
    | `title` | text | Title of the call or meeting |
    | `call_time` | date | When the call happened |
    | `duration_seconds` | number | Total duration in seconds |
    | `meeting_url` | text | Zoom/Teams/Meet link |
    | `calendar_id` | text | ID of the calendar event |
  </Tab>

  <Tab title="Media & Transcript">
    | Field | Type | Description |
    | - | - | - |
    | `recording_url` | text | Dashboard or viewer URL |
    | `audio_url` | text | Direct link to audio file |
    | `video_url` | text | Direct link to video file |
    | `transcript_text` | text | Plain text transcript for search and AI analysis |
    | `summary` | json | AI-generated meeting summary (action items, keywords, overview, topics, meeting type) |
    | `source_insights` | json | Sentiments, categories, and speaker statistics from provider |
  </Tab>

  <Tab title="Participants & Relationships">
    | Field | Type | Description |
    | - | - | - |
    | `participants` | json | Array of participant objects with email and name |
    | `customer_id` | reference | Customer resolved from participant emails |
    | `primary_contact_id` | reference | Contact with most talk time or organizer |
    | `organizer_id` | reference | Team member who organized the call |
    | `source_system` | text | Source system (fireflies, fathom, gong) |
  </Tab>
</Tabs>

***

## Market Signals

External intelligence about customer companies.

**Data sources:** Quivly data enrichment

| Field | Type | Description |
| - | - | - |
| `insight_title` | text | Title of the signal |
| `insight_summary` | text | Summary of the signal |
| `insight_type` | text | Type of signal |
| `insight_data` | json | Core signal data |
| `insight_timestamp` | date | When the signal was recorded |
| `source` | text | Source of the signal |
| `sentiment` | text | Sentiment (positive, negative, neutral) |
| `relevance_level` | text | Level of relevance (high, medium, low) |
| `relevance_reason` | text | Why the signal is relevant |
| `tags` | json | Tags associated with the signal |
| `customer_id` | text | Customer this signal relates to |

**Signal types:** Funding rounds, Hiring, Layoffs, Acquisitions, Leadership changes

***

## Product Usage

Customer usage metrics from your data warehouse.

**Data sources:** BigQuery, Snowflake, ClickHouse

| Field | Type | Description |
| - | - | - |
| `customer_id` | reference | Customer account |
| `product_id` | reference | Billing product (optional - for product-specific usage) |
| `usage_timestamp` | date | When the usage was measured |
| `granularity` | text | Time period: `hourly`, `daily`, `weekly`, `monthly` |
| `metric_key` | text | Metric identifier (e.g., `gb_scanned`, `credits`, `api_calls`, `active_users`) |
| `value` | number | Raw usage value |
| `billed_value` | number | Usage value normalized for billing purposes |
| `source` | text | Origin of data (`clickhouse`, `warehouse`, `metronome_export`, etc.) |
| `properties` | json | Additional metric metadata |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.