CostSheet

object

idrequired: Id
Opaque record id.
numberrequired: integer
refrequired: string
statusrequired: "draft" | "issued" | "accepted" | "expired" | "cancelled"
An issued sheet past its validity, or an accepted one not booked by its book-by date, reads expired.
projectrequired: object
project.idrequired: Id
Opaque record id.
project.namerequired: string
unitrequired: object
unit.idrequired: Id
Opaque record id.
unit.unit_norequired: string
unit.labelrequired: string
unit.floorrequired: integer or null
unit.statusrequired: string
price_listrequired: object
price_list.idrequired: Id
Opaque record id.
price_list.versionrequired: integer
price_list.namerequired: string
price_list.statusrequired: string
leadrequired: object or null
lead.idrequired: Id
Opaque record id.
lead.numberrequired: integer
lead.namerequired: string
contactrequired: object or null
contact.idrequired: Id
Opaque record id.
contact.namerequired: string
discountsrequired: array of CostSheetDiscount
noterequired: string or null
sheetrequired: ComputedCostSheet or null
Frozen once issued; a draft’s live computation.
errorrequired: string or null
caprequired: object
cap.cap_bprequired: integer or null
null: not capped.
cap.discount_bprequired: integer
cap.above_caprequired: boolean
content_hashrequired: string or null
valid_untilrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
issued_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
shared_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
share_countrequired: integer
acceptedrequired: object or null
accepted.atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
accepted.namerequired: string or null
accepted.iprequired: string or null
accepted.user_agentrequired: string or null
accepted.channelrequired: string or null
competing_acceptancesrequired: array of object
Other sheets on the same unit accepted and not booked yet (still inside their book-by date).
competing_acceptances[].idrequired: Id
Opaque record id.
competing_acceptances[].refrequired: string
competing_acceptances[].atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
competing_acceptances[].namerequired: string or null
cancelledrequired: object or null
cancelled.atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
cancelled.reasonrequired: string or null
approvalrequired: object or null
approval.chain_idrequired: Id
Opaque record id.
approval.statusrequired: string
created_byrequired: object or null
created_by.idrequired: Id
Opaque record id.
created_by.namerequired: string
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "number": 0,
  "ref": "string",
  "status": "draft",
  "project": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "unit": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "unit_no": "string",
    "label": "string",
    "floor": 0,
    "status": "string"
  },
  "price_list": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "version": 0,
    "name": "string",
    "status": "string"
  },
  "lead": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "name": "string"
  },
  "contact": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "discounts": [
    {
      "label": "string",
      "kind": "percent_bsp",
      "value": 1
    }
  ],
  "note": "string",
  "sheet": {
    "area_basis": "carpet",
    "area": 0,
    "area_unit": "string",
    "bsp_rate": 850000000,
    "lines": [
      {
        "code": "string",
        "label": "string",
        "kind": "bsp",
        "basis": "string",
        "amount": 850000000,
        "discount": 850000000,
        "net": 850000000,
        "gst_bp": 0,
        "gst": 850000000,
        "in_agreement_value": true
      }
    ],
    "discounts": [
      {
        "label": "string",
        "kind": "percent_bsp",
        "value": 1,
        "amount": 850000000
      }
    ],
    "totals": {
      "list_value": 850000000,
      "discount": 850000000,
      "agreement_value": 850000000,
      "other_charges": 850000000,
      "gst": 850000000,
      "stamp_duty": 850000000,
      "registration": 850000000,
      "grand_total": 850000000,
      "all_in_rate": 850000000,
      "discount_bp": 0
    },
    "stamp": {
      "state": "string",
      "include": true,
      "stamp_duty_bp": 0,
      "registration_bp": 0
    }
  },
  "error": "string",
  "cap": {
    "cap_bp": 0,
    "discount_bp": 0,
    "above_cap": true
  },
  "content_hash": "string",
  "valid_until": "2026-10-06T05:30:00.000Z",
  "issued_at": "2026-10-06T05:30:00.000Z",
  "shared_at": "2026-10-06T05:30:00.000Z",
  "share_count": 0,
  "accepted": {
    "at": "2026-10-06T05:30:00.000Z",
    "name": "string",
    "ip": "string",
    "user_agent": "string",
    "channel": "string"
  },
  "competing_acceptances": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "at": "2026-10-06T05:30:00.000Z",
      "name": "string"
    }
  ],
  "cancelled": {
    "at": "2026-10-06T05:30:00.000Z",
    "reason": "string"
  },
  "approval": {
    "chain_id": "cmusrceel0000q7kaafxqi1om",
    "status": "string"
  },
  "created_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z"
}

{ "id": "cmusrceel0000q7kaafxqi1om", "number": 0, "ref": "string", "status": "draft", "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "unit": { "id": "cmusrceel0000q7kaafxqi1om", "unit_no": "string", "label": "string", "floor": 0, "status": "string" }, "price_list": { "id": "cmusrceel0000q7kaafxqi1om", "version": 0, "name": "string", "status": "string" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "number": 0, "name": "string" }, "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "discounts": [ { "label": "string", "kind": "percent_bsp", "value": 1 } ], "note": "string", "sheet": { "area_basis": "carpet", "area": 0, "area_unit": "string", "bsp_rate": 850000000, "lines": [ { "code": "string", "label": "string", "kind": "bsp", "basis": "string", "amount": 850000000, "discount": 850000000, "net": 850000000, "gst_bp": 0, "gst": 850000000, "in_agreement_value": true } ], "discounts": [ { "label": "string", "kind": "percent_bsp", "value": 1, "amount": 850000000 } ], "totals": { "list_value": 850000000, "discount": 850000000, "agreement_value": 850000000, "other_charges": 850000000, "gst": 850000000, "stamp_duty": 850000000, "registration": 850000000, "grand_total": 850000000, "all_in_rate": 850000000, "discount_bp": 0 }, "stamp": { "state": "string", "include": true, "stamp_duty_bp": 0, "registration_bp": 0 } }, "error": "string", "cap": { "cap_bp": 0, "discount_bp": 0, "above_cap": true }, "content_hash": "string", "valid_until": "2026-10-06T05:30:00.000Z", "issued_at": "2026-10-06T05:30:00.000Z", "shared_at": "2026-10-06T05:30:00.000Z", "share_count": 0, "accepted": { "at": "2026-10-06T05:30:00.000Z", "name": "string", "ip": "string", "user_agent": "string", "channel": "string" }, "competing_acceptances": [ { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "at": "2026-10-06T05:30:00.000Z", "name": "string" } ], "cancelled": { "at": "2026-10-06T05:30:00.000Z", "reason": "string" }, "approval": { "chain_id": "cmusrceel0000q7kaafxqi1om", "status": "string" }, "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }