Pricing & cost sheets

PATCH/v1/charge-templates/{id}

Change a charge template (published price lists keep the config frozen with them)

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
config: ChargeTemplateConfig2
One basic sale price; at most one PLC, floor rise and parking.
is_default: boolean
archived: boolean

Response · 200

datarequired: ChargeTemplate
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/charge-templates/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","config":{"area_basis":"carpet","heads":[{"code":"string","label":"string","kind":"bsp","basis":"fixed","gst_bp":0,"in_agreement_value":true,"months":1}],"stamp":{"state":null,"include":true,"stamp_duty_bp":0,"registration_bp":0,"registration_cap":null}},"is_default":true,"archived":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "is_default": true,
    "archived": true,
    "config": {
      "area_basis": "carpet",
      "heads": [
        {
          "code": "string",
          "label": "string",
          "kind": "bsp",
          "basis": "fixed",
          "gst_bp": 0,
          "in_agreement_value": true,
          "months": 1
        }
      ],
      "stamp": {
        "state": null,
        "include": true,
        "stamp_duty_bp": 0,
        "registration_bp": 0,
        "registration_cap": null
      }
    },
    "price_lists": 0,
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/cost-sheets

Cost sheets (quotes), newest first — by project, unit, lead, status or your own

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing or units.cost_sheet.

Parameters

project_idquery: Id
Opaque record id.
unit_idquery: Id
Opaque record id.
lead_idquery: Id
Opaque record id.
statusquery: "draft" | "issued" | "accepted" | "expired" | "cancelled"
minequery: string
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of CostSheet
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/cost-sheets' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/cost-sheets

Draft a cost sheet for a unit (available or on hold)

Access: Signed-in members only (web or Android session) — not for API keys. Permission units.cost_sheet.

Request body

unit_idrequired: Id
Opaque record id.
price_list_id: Id or null
Default: the version in force today.
discounts: array of CostSheetDiscountInput
lead_id: Id or null
Opaque record id.
note: string or null

Response · 201

datarequired: CostSheet
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cost-sheets' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"unit_id":"cmusrceel0000q7kaafxqi1om","price_list_id":"cmusrceel0000q7kaafxqi1om","discounts":[{"label":"string","kind":"percent_bsp","value":1}],"lead_id":"cmusrceel0000q7kaafxqi1om","note":"string"}'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/cost-sheets/preview

Compute a unit’s cost sheet without saving it (the builder’s live preview)

Access: Signed-in members only (web or Android session) — not for API keys. Permission units.cost_sheet.

Request body

unit_idrequired: Id
Opaque record id.
price_list_id: Id or null
Default: the version in force today.
discounts: array of CostSheetDiscountInput

Response · 200

datarequired: object
data.sheetrequired: ComputedCostSheet or null
data.errorrequired: string or null
data.caprequired: object
data.cap.cap_bprequired: integer or null
null: not capped.
data.cap.discount_bprequired: integer
data.cap.above_caprequired: boolean
data.price_listrequired: object
data.price_list.idrequired: Id
Opaque record id.
data.price_list.versionrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cost-sheets/preview' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"unit_id":"cmusrceel0000q7kaafxqi1om","price_list_id":"cmusrceel0000q7kaafxqi1om","discounts":[{"label":"string","kind":"percent_bsp","value":1}]}'

Response example

{
  "data": {
    "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
    },
    "price_list": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "version": 0
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/cost-sheets/{id}

One cost sheet with its sheet, acceptance and pending approval

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing or units.cost_sheet.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: CostSheet
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/cost-sheets/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/cost-sheets/{id}

Change a draft: discounts, lead, note or the price-list version

Access: Signed-in members only (web or Android session) — not for API keys. Permission units.cost_sheet.

Parameters

idpathrequired: Id
Opaque record id.

Request body

discounts: array of CostSheetDiscountInput
lead_id: Id or null
Opaque record id.
note: string or null
price_list_id: Id or null
Opaque record id.

Response · 200

datarequired: CostSheet
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/cost-sheets/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"discounts":[{"label":"string","kind":"percent_bsp","value":1}],"lead_id":"cmusrceel0000q7kaafxqi1om","note":"string","price_list_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/cost-sheets/{id}/cancel

Cancel a draft or an issued sheet (an accepted one stays for the booking)

Access: Signed-in members only (web or Android session) — not for API keys. Permission units.cost_sheet.

Parameters

idpathrequired: Id
Opaque record id.

Request body (optional)

reason: string or null

Response · 200

datarequired: CostSheet
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cost-sheets/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/cost-sheets/{id}/issue

Issue (freeze) a draft

A discount above your role cap answers 409 approval_required; with `request_approval` the chain is raised (data null, the chain in meta.approval) and the sheet is issued once approved.

Access: Signed-in members only (web or Android session) — not for API keys. Permission units.cost_sheet.

Parameters

idpathrequired: Id
Opaque record id.

Request body (optional)

request_approval: object or null
Ask for approval when a policy requires it: the chain is raised and returned in meta.approval.
request_approval.note: string or null

Response · 200

datarequired: CostSheet or null
metarequired: ApprovalRequestedMeta

Request

curl -X POST 'https://api.propzolo.com/v1/cost-sheets/{id}/issue' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"request_approval":{"note":"string"}}'

Response example

{
  "data": {
    "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"
  },
  "meta": {
    "approval": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "kind_label": "string",
      "status": "pending",
      "title": "string",
      "reason": "string",
      "summary": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "level": 0,
      "levels": [
        {
          "level": 0,
          "name": "string",
          "status": "string",
          "decided_by": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "decided_at": "2026-10-06T05:30:00.000Z",
          "decision_note": "string",
          "channel": "string",
          "hold_reason": "string",
          "escalated": true,
          "due_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requested_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "request_note": "string",
      "action_status": "waiting",
      "action_error": "string",
      "applied_at": "2026-10-06T05:30:00.000Z",
      "entity": {
        "type": "string",
        "id": "cmusrceel0000q7kaafxqi1om"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "decided_at": "2026-10-06T05:30:00.000Z",
      "can_cancel": true
    }
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/cost-sheets/{id}/pdf

The cost sheet as PDF (a draft prints with a DRAFT watermark)

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing or units.cost_sheet.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/cost-sheets/{id}/pdf' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/cost-sheets/{id}/send

Send an issued sheet to the lead’s contact (a signed link minted at delivery)

Access: Signed-in members only (web or Android session) — not for API keys. Permission units.cost_sheet.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.statusrequired: "sent" | "blocked"
data.reasonrequired: string or null
data.cost_sheetrequired: CostSheet
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cost-sheets/{id}/send' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "status": "sent",
    "reason": "string",
    "cost_sheet": {
      "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"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/price-lists/{id}

Edit a draft price list (published versions are frozen: 409)

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Parameters

idpathrequired: Id
Opaque record id.

Request body

template_id: Id
Opaque record id.
name: string
effective_from: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
rates: PriceRatesInput
BSP per area unit (overrides per tower / configuration), PLC rules, floor rise, parking by type and each other charge by template code (per_area: paise per area unit · fixed: paise · percent_bsp: basis points).
notes: string or null

Response · 200

datarequired: PriceList
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/price-lists/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"template_id":"cmusrceel0000q7kaafxqi1om","name":"string","effective_from":"2026-10-06","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":{}},"notes":"string"}'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/price-lists/{id}

Delete a draft price list

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/price-lists/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/price-lists/{id}/archive

Withdraw a published version from new cost sheets (sheets quoted on it keep it)

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PriceList
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/price-lists/{id}/archive' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/price-lists/{id}/publish

Publish a draft from its effective date (today or later); its rates and template config freeze

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PriceList
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/price-lists/{id}/publish' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/pricing/stamp-duty-states

Stamp duty and registration estimates by state (unverified starting points)

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing or units.cost_sheet.

Response · 200

datarequired: array of object
data[].staterequired: string
data[].namerequired: string
data[].stamp_duty_bprequired: integer
data[].registration_bprequired: integer
data[].registration_caprequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
data[].noterequired: string
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/pricing/stamp-duty-states' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "state": "string",
      "name": "string",
      "stamp_duty_bp": 0,
      "registration_bp": 0,
      "registration_cap": 850000000,
      "note": "string"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/projects/{id}/charge-templates

Charge templates of a project

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing or units.cost_sheet.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of ChargeTemplate
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/projects/{id}/charge-templates' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_default": true,
      "archived": true,
      "config": {
        "area_basis": "carpet",
        "heads": [
          {
            "code": "string",
            "label": "string",
            "kind": "bsp",
            "basis": "fixed",
            "gst_bp": 0,
            "in_agreement_value": true,
            "months": 1
          }
        ],
        "stamp": {
          "state": null,
          "include": true,
          "stamp_duty_bp": 0,
          "registration_bp": 0,
          "registration_cap": null
        }
      },
      "price_lists": 0,
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/projects/{id}/charge-templates

Add a charge template (the starter set with the state’s estimate when no config is sent)

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
config: ChargeTemplateConfigInput
One basic sale price; at most one PLC, floor rise and parking.
is_default: boolean

Response · 201

datarequired: ChargeTemplate
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/charge-templates' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","config":{"area_basis":"carpet","heads":[{"code":"string","label":"string","kind":"bsp","basis":"fixed","gst_bp":0,"in_agreement_value":true,"months":1}],"stamp":{"state":null,"include":true,"stamp_duty_bp":0,"registration_bp":0,"registration_cap":null}},"is_default":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "is_default": true,
    "archived": true,
    "config": {
      "area_basis": "carpet",
      "heads": [
        {
          "code": "string",
          "label": "string",
          "kind": "bsp",
          "basis": "fixed",
          "gst_bp": 0,
          "in_agreement_value": true,
          "months": 1
        }
      ],
      "stamp": {
        "state": null,
        "include": true,
        "stamp_duty_bp": 0,
        "registration_bp": 0,
        "registration_cap": null
      }
    },
    "price_lists": 0,
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/projects/{id}/price-lists

Price-list versions of a project, newest first

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing or units.cost_sheet.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of PriceList
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/projects/{id}/price-lists' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "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": [
              null
            ],
            "views": [
              null
            ],
            "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": null,
              "to_floor": null,
              "rate": null
            }
          ]
        },
        "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"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/projects/{id}/price-lists

Draft the next price-list version (copied from the latest unless rates are sent)

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Parameters

idpathrequired: Id
Opaque record id.

Request body

template_id: Id
Opaque record id.
name: string
effective_from: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
rates: PriceRatesInput
BSP per area unit (overrides per tower / configuration), PLC rules, floor rise, parking by type and each other charge by template code (per_area: paise per area unit · fixed: paise · percent_bsp: basis points).
notes: string or null
copy_from_id: Id or null
Opaque record id.

Response · 201

datarequired: PriceList
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/price-lists' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"template_id":"cmusrceel0000q7kaafxqi1om","name":"string","effective_from":"2026-10-06","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":{}},"notes":"string","copy_from_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/cost-sheets

Cost-sheet settings: discount caps per role, validity, terms

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Response · 200

datarequired: CostSheetPolicy
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/cost-sheets' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "default_cap_bp": 0,
    "role_caps_bp": {},
    "validity_days": 1,
    "book_within_days": 1,
    "terms": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/settings/cost-sheets

Change the cost-sheet settings

Access: Signed-in members only (web or Android session) — not for API keys. Permission projects.pricing.

Request body

default_cap_bp: integer
role_caps_bp: map of integer
validity_days: integer
book_within_days: integer or null
Days an accepted sheet keeps its price for the booking; null: as many as validity_days.
terms: string or null

Response · 200

datarequired: CostSheetPolicy
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/settings/cost-sheets' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"default_cap_bp":0,"role_caps_bp":{},"validity_days":1,"book_within_days":1,"terms":"string"}'

Response example

{
  "data": {
    "default_cap_bp": 0,
    "role_caps_bp": {},
    "validity_days": 1,
    "book_within_days": 1,
    "terms": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.