Playground

Playground

Quote

/api/v1/crm/quotes

A pricing proposal / quote against an account (and optionally a deal).

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
owner_idstringQuote owner / salesperson. Format: usr-<uuid>.
namestringHuman-readable quote name.
quote_numberstringHuman-readable quote number, unique per tenant (e.g. Q-2026-00892).
account_idstringAccount this quote is for. Format: acc-<uuid>.
deal_idstringDeal this quote belongs to, if any. Format: deal-<uuid>.
valuenumberTotal quote value after discounts.
currencystringISO 4217 currency code.
statusstringLifecycle status: draft, sent, accepted, rejected, expired.
date_issueddate-timeWhen the quote was issued.
validity_datedate-timeDate after which the quote expires.
contract_durationstringContract term the quote covers (e.g. '12 months').
is_primarybooleanTrue if this is the primary quote on the deal.
notesstringFree-text notes or special terms.
line_itemsjsonEmbedded line-item summaries. Full records via /api/v1/crm/line-items.
custom_fieldsjsonPer-tenant schema extension.
tagsjsonFree-form string tags.
versionnumberOptimistic-concurrency version counter.
totalnumberTotal quote amount.
valid_untildate-timeDate after which the quote is no longer valid.

API

Loading manifest…