Playground

Playground

LineItem

/api/v1/crm/line-items

A first-class line item belonging to a Quote.

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.
quote_idstringQuote this line item belongs to. Format: qte-<uuid>.
descriptionstringLine item description.
quantitynumberQuantity.
unit_pricenumberPrice per unit.
discountnumberPer-line discount amount or percentage.
totalnumberLine total after discount.
versionnumberOptimistic-concurrency version counter.
currencystringISO 4217 currency code.

API

Loading manifest…