PriceList

object

idrequired: Id
Opaque record id.
project_idrequired: Id
Opaque record id.
templaterequired: object
template.idrequired: Id
Opaque record id.
template.namerequired: string
versionrequired: integer
namerequired: string
statusrequired: "draft" | "published" | "archived"
effective_fromrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
effective_torequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
in_forcerequired: boolean
ratesrequired: PriceRates or null
Pricing admins only.
validrequired: boolean
notesrequired: string or null
published_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
cost_sheetsrequired: integer
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "project_id": "cmusrceel0000q7kaafxqi1om",
  "template": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "version": 0,
  "name": "string",
  "status": "draft",
  "effective_from": "2026-10-06",
  "effective_to": "2026-10-06",
  "in_force": true,
  "rates": {
    "bsp_rate": 0,
    "bsp_overrides": [
      {
        "tower_id": "cmusrceel0000q7kaafxqi1om",
        "configuration_id": "cmusrceel0000q7kaafxqi1om",
        "rate": 0
      }
    ],
    "plc": [
      {
        "label": "string",
        "facings": [
          "string"
        ],
        "views": [
          "string"
        ],
        "corner": true,
        "floor_min": 0,
        "floor_max": 0,
        "basis": "per_area",
        "amount": 0
      }
    ],
    "floor_rise": {
      "mode": "none",
      "start_floor": 1,
      "rate": 0,
      "slabs": [
        {
          "from_floor": 0,
          "to_floor": 0,
          "rate": 0
        }
      ]
    },
    "parking": {},
    "heads": {}
  },
  "valid": true,
  "notes": "string",
  "published_at": "2026-10-06T05:30:00.000Z",
  "cost_sheets": 0,
  "updated_at": "2026-10-06T05:30:00.000Z"
}