# PriceList

object type

A PriceList — a named ALTERNATE base-price plane (a 'price book'): the pipeline STEP-1 base for eligible customers, resolved at line capture ContractPrice → assigned PriceList → SalePrice and snapshotted IMMUTABLE at capture. ≠ step-2 discounts (promos/coupons/loyalty/employee compute OFF the captured base); ≠ markdowns (which WRITE SalePrice records — a list is READ-THROUGH at capture: nothing moves on a date, ZERO SCHEDULED_DUE growth; the resolve-time window IS the gating). THE CONTRACT SCOPE: orgCustomerId? — the lock's ContractPrice IS a PriceList scoped to ONE OrgCustomer, NOT a third construct: set at create, IMMUTABLE thereafter (the Edit shape excludes it — author a new list); a SCOPED list REQUIRES both window bounds (the contract TERM — STRICT). The effective window \[startAt, endAt) is half-open and optional-per-side on an UNSCOPED list (absent = boundless); non-ACTIVE / out-of-window / org-unselected ⇒ the whole plane FALLS THROUGH silently at capture (the / degrade class — the LAPSE law STANDS: the effective SalePrice window remains REQUIRED, a plane hit overrides the captured VALUE only). Entries are child PriceListEntry dated windows (≤ 500 live per list); carrier law: a scoped list may be carried ONLY by its scoped OrgCustomer's priceListId, a CustomerPriceGroup carries UNSCOPED lists only. Org participation is the canned-pool selection (≤ 32; ABSENT = every org); at most 32 ACTIVE per org group (the create/reactivate gate). SEARCHABLE (the book law — the Promotion/LP/CPG/Affiliate operational-master class). Doom ← non-doomed OrgCustomer/CustomerPriceGroup carriers (the THIRD carrier-gated doom family); its OWN entries never block (they die with the plane at purge). NO UNIQ marker (captions are non-unique; nothing bearer-resolvable).

## Fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
| `sysId` | [String](/types/#scalars) `String!` | The group-scoped human-facing system id (PB-…). |
| `type` | [String](/types/#scalars) `String!` | The kind of record — always `PriceList` here. |
| `caption` | [String](/types/#scalars) `String!` | The record’s display name — what people see it called. |
| `status` | [String](/types/#scalars) `String!` | The FSM state: active \| inactive \| doomed. |
| `parentId` | [ID](/types/#scalars) `ID!` | The parent org group; for a PriceList parentId === rootId. |
| `rootId` | [ID](/types/#scalars) `ID!` | The org-group family root. |
| `createdAt` | [String](/types/#scalars) `String!` | When the record was created, as a UTC timestamp. |
| `updatedAt` | [String](/types/#scalars) `String!` | When the record last changed, as a UTC timestamp. |
| `revisionNum` | [Int](/types/#scalars) `Int!` | How many times this record has been edited; the first save is 0. |
| `revision` | [ID](/types/#scalars) `ID!` | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
| `refCaptions` | [RefCaption](/types/RefCaption/) `[RefCaption!]!` | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
| `organizationIds` | [ID](/types/#scalars) `[ID!]` | The canned-pool org selection — ABSENT = every org in the group; an org outside the pool makes the plane fall through at capture. |
| `startAt` | [String](/types/#scalars) | The effective-window start (INCLUSIVE; UTC ISO-8601) — ABSENT = boundless below. Editable (a term renegotiation is an ordinary revision — the ENTRIES are the immutable price facts); REQUIRED on a scoped (contract) list. |
| `endAt` | [String](/types/#scalars) | The effective-window end (EXCLUSIVE; UTC ISO-8601) — ABSENT = boundless above. Editable; REQUIRED on a scoped list (the contract term). |
| `orgCustomerId` | [ID](/types/#scalars) | THE CONTRACT SCOPE: the ONE OrgCustomer this list is negotiated for. Set at create, IMMUTABLE; ABSENT = a general (assignable) list. |

## Used by

- [createPriceList](/reference/price-list/createPriceList/)
- [deactivatePriceList](/reference/price-list/deactivatePriceList/)
- [doomPriceList](/reference/price-list/doomPriceList/)
- [priceList](/reference/price-list/priceList/)
- [reactivatePriceList](/reference/price-list/reactivatePriceList/)
- [updatePriceList](/reference/price-list/updatePriceList/)