Bookings

GET/v1/bookings

Bookings you can see, newest first

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

Parameters

project_idquery: Id
Opaque record id.
lead_idquery: Id
Opaque record id.
unit_idquery: Id
Opaque record id.
statusquery: string
approvalquery: "draft" | "pending" | "approved" | "rejected"
collections_offquery: "true" | "false"
BLD-24: only migrated bookings whose collections are still off.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of BookingSummary
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0,
      "ref": "string",
      "status": "string",
      "approval": "draft",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "unit": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "unit_no": "string",
        "label": "string",
        "floor": 0
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": 0
      },
      "primary_applicant": "string",
      "booking_date": "2026-10-06",
      "agreement_value": 850000000,
      "confirmed_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "migrated": {
        "at": "2026-10-06T05:30:00.000Z",
        "collections_from": "2026-10-06"
      }
    }
  ],
  "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/bookings

Book the unit of a cost sheet the customer accepted (the unit is booked at once)

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

Request body

cost_sheet_idrequired: Id
Opaque record id.
payment_plan_id: Id or null
Opaque record id.
booking_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.

Response · 201

datarequired: Booking
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bookings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"cost_sheet_id":"cmusrceel0000q7kaafxqi1om","payment_plan_id":"cmusrceel0000q7kaafxqi1om","booking_date":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "string",
    "status": "string",
    "approval": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string",
      "label": "string",
      "floor": 0
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "primary_applicant": "string",
    "booking_date": "2026-10-06",
    "agreement_value": 850000000,
    "confirmed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "migrated": {
      "at": "2026-10-06T05:30:00.000Z",
      "collections_from": "2026-10-06"
    },
    "cost_sheet": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "content_hash": "string",
      "accepted_at": "string",
      "accepted_name": "string",
      "sheet": null
    },
    "payment_plan": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "schedule": [
      {
        "seq": 0,
        "milestone": "string",
        "trigger": "string",
        "percent": 0,
        "amount": 850000000,
        "gst_amount": 850000000,
        "due_date": "2026-10-06",
        "status": "string"
      }
    ],
    "booking_amount": 850000000,
    "gst_amount": 850000000,
    "stamp_duty": 850000000,
    "registration_fee": 850000000,
    "loan": {
      "bank": "string",
      "amount": 850000000,
      "status": "string"
    },
    "notes": "string",
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "is_primary": true,
        "name": "string",
        "relation": "string",
        "pan_masked": "string",
        "aadhaar_last4": "string",
        "dob": "2026-10-06",
        "address": "string",
        "phone": "string",
        "email": "string",
        "has_contact": true
      }
    ],
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string"
    },
    "document_kinds": [
      "string"
    ],
    "gaps": [
      "string"
    ],
    "editable": true,
    "approval_chain_id": "cmusrceel0000q7kaafxqi1om",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "confirmed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancelled": {
      "at": "2026-10-06T05:30:00.000Z",
      "reason": "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.

GET/v1/bookings/receipts/by-token/{token}

A booking receipt PDF by its signed portal link

Minted by the customer portal for an applicant of the booking (10 minutes). Unknown, expired or tampered links answer 404.

Access: No authentication.

Parameters

tokenpathrequired: string

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/bookings/receipts/by-token/{token}'

Response example

"string"

Errors

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/bookings/{id}

One booking: the form, the frozen cost sheet, the schedule, the approval

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Booking
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "string",
    "status": "string",
    "approval": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string",
      "label": "string",
      "floor": 0
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "primary_applicant": "string",
    "booking_date": "2026-10-06",
    "agreement_value": 850000000,
    "confirmed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "migrated": {
      "at": "2026-10-06T05:30:00.000Z",
      "collections_from": "2026-10-06"
    },
    "cost_sheet": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "content_hash": "string",
      "accepted_at": "string",
      "accepted_name": "string",
      "sheet": null
    },
    "payment_plan": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "schedule": [
      {
        "seq": 0,
        "milestone": "string",
        "trigger": "string",
        "percent": 0,
        "amount": 850000000,
        "gst_amount": 850000000,
        "due_date": "2026-10-06",
        "status": "string"
      }
    ],
    "booking_amount": 850000000,
    "gst_amount": 850000000,
    "stamp_duty": 850000000,
    "registration_fee": 850000000,
    "loan": {
      "bank": "string",
      "amount": 850000000,
      "status": "string"
    },
    "notes": "string",
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "is_primary": true,
        "name": "string",
        "relation": "string",
        "pan_masked": "string",
        "aadhaar_last4": "string",
        "dob": "2026-10-06",
        "address": "string",
        "phone": "string",
        "email": "string",
        "has_contact": true
      }
    ],
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string"
    },
    "document_kinds": [
      "string"
    ],
    "gaps": [
      "string"
    ],
    "editable": true,
    "approval_chain_id": "cmusrceel0000q7kaafxqi1om",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "confirmed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancelled": {
      "at": "2026-10-06T05:30:00.000Z",
      "reason": "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.
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/bookings/{id}

Change a draft booking: payment plan, booking date, loan, notes

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

payment_plan_id: Id or null
Opaque record id.
booking_date: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
loan_bank: string or null
loan_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
loan_status: "applied" | "sanctioned" | "disbursed" | "rejected" | "not_needed" or null
notes: string or null

Response · 200

datarequired: Booking
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/bookings/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"payment_plan_id":"cmusrceel0000q7kaafxqi1om","booking_date":"2026-10-06","loan_bank":"string","loan_amount":0,"loan_status":"applied","notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "string",
    "status": "string",
    "approval": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string",
      "label": "string",
      "floor": 0
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "primary_applicant": "string",
    "booking_date": "2026-10-06",
    "agreement_value": 850000000,
    "confirmed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "migrated": {
      "at": "2026-10-06T05:30:00.000Z",
      "collections_from": "2026-10-06"
    },
    "cost_sheet": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "content_hash": "string",
      "accepted_at": "string",
      "accepted_name": "string",
      "sheet": null
    },
    "payment_plan": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "schedule": [
      {
        "seq": 0,
        "milestone": "string",
        "trigger": "string",
        "percent": 0,
        "amount": 850000000,
        "gst_amount": 850000000,
        "due_date": "2026-10-06",
        "status": "string"
      }
    ],
    "booking_amount": 850000000,
    "gst_amount": 850000000,
    "stamp_duty": 850000000,
    "registration_fee": 850000000,
    "loan": {
      "bank": "string",
      "amount": 850000000,
      "status": "string"
    },
    "notes": "string",
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "is_primary": true,
        "name": "string",
        "relation": "string",
        "pan_masked": "string",
        "aadhaar_last4": "string",
        "dob": "2026-10-06",
        "address": "string",
        "phone": "string",
        "email": "string",
        "has_contact": true
      }
    ],
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string"
    },
    "document_kinds": [
      "string"
    ],
    "gaps": [
      "string"
    ],
    "editable": true,
    "approval_chain_id": "cmusrceel0000q7kaafxqi1om",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "confirmed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancelled": {
      "at": "2026-10-06T05:30:00.000Z",
      "reason": "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.
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/bookings/{id}/allotment-letter

The allotment letter as PDF (a DRAFT preview until the booking is confirmed)

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/bookings/{id}/allotment-letter' \
  -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.

PUT/v1/bookings/{id}/applicants

Replace the applicants (PAN stored encrypted, only the last four of Aadhaar kept)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

applicantsrequired: array of object
applicants[].id: Id or null
Opaque record id.
applicants[].namerequired: string
applicants[].relation: "self" | "spouse" | "parent" | "child" | "sibling" | "other"
applicants[].is_primary: boolean
applicants[].pan: string or null
Send only to set or change it.
applicants[].aadhaar: string or null
The full number or its last four.
applicants[].dob: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
applicants[].address: string or null
applicants[].phone: string or null
applicants[].email: string or null

Response · 200

datarequired: Booking
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/bookings/{id}/applicants' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"applicants":[{"id":"cmusrceel0000q7kaafxqi1om","name":"string","relation":"self","is_primary":true,"pan":"string","aadhaar":"string","dob":"2026-10-06","address":"string","phone":"string","email":"string"}]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "string",
    "status": "string",
    "approval": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string",
      "label": "string",
      "floor": 0
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "primary_applicant": "string",
    "booking_date": "2026-10-06",
    "agreement_value": 850000000,
    "confirmed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "migrated": {
      "at": "2026-10-06T05:30:00.000Z",
      "collections_from": "2026-10-06"
    },
    "cost_sheet": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "content_hash": "string",
      "accepted_at": "string",
      "accepted_name": "string",
      "sheet": null
    },
    "payment_plan": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "schedule": [
      {
        "seq": 0,
        "milestone": "string",
        "trigger": "string",
        "percent": 0,
        "amount": 850000000,
        "gst_amount": 850000000,
        "due_date": "2026-10-06",
        "status": "string"
      }
    ],
    "booking_amount": 850000000,
    "gst_amount": 850000000,
    "stamp_duty": 850000000,
    "registration_fee": 850000000,
    "loan": {
      "bank": "string",
      "amount": 850000000,
      "status": "string"
    },
    "notes": "string",
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "is_primary": true,
        "name": "string",
        "relation": "string",
        "pan_masked": "string",
        "aadhaar_last4": "string",
        "dob": "2026-10-06",
        "address": "string",
        "phone": "string",
        "email": "string",
        "has_contact": true
      }
    ],
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string"
    },
    "document_kinds": [
      "string"
    ],
    "gaps": [
      "string"
    ],
    "editable": true,
    "approval_chain_id": "cmusrceel0000q7kaafxqi1om",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "confirmed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancelled": {
      "at": "2026-10-06T05:30:00.000Z",
      "reason": "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.
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/bookings/{id}/applicants/{applicantId}/reveal-pan

An applicant’s full PAN (audited)

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

Parameters

idpathrequired: Id
Opaque record id.
applicantIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.panrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bookings/{id}/applicants/{applicantId}/reveal-pan' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "pan": "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.
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/bookings/{id}/documents

KYC documents of a booking

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of BookingDocument
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "pan",
      "applicant_id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "content_type": "string",
      "size": 0,
      "uploaded_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "uploaded_at": "2026-10-06T05:30:00.000Z",
      "scan_status": "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.
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/bookings/{id}/documents

Attach an uploaded KYC document

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

keyrequired: string
kindrequired: "pan" | "aadhaar" | "photo" | "address_proof" | "booking_cheque" | "loan_sanction" | …
filenamerequired: string
content_typerequired: string
sizerequired: integer
applicant_id: Id or null
Opaque record id.

Response · 201

datarequired: BookingDocument
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bookings/{id}/documents' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"key":"string","kind":"pan","filename":"string","content_type":"string","size":0,"applicant_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "pan",
    "applicant_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "content_type": "string",
    "size": 0,
    "uploaded_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "uploaded_at": "2026-10-06T05:30:00.000Z",
    "scan_status": "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.
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/bookings/{id}/documents/upload

A presigned private upload for a KYC document

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

filenamerequired: string
content_typerequired: string
sizerequired: integer

Response · 200

datarequired: object
data.keyrequired: string
data.urlrequired: string
data.methodrequired: string
data.headersrequired: map of string
data.expires_atrequired: string
data.max_bytesrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bookings/{id}/documents/upload' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"string","content_type":"string","size":0}'

Response example

{
  "data": {
    "key": "string",
    "url": "string",
    "method": "string",
    "headers": {},
    "expires_at": "string",
    "max_bytes": 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.
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/bookings/{id}/documents/{documentId}

A 60-second signed download link (audited)

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

Parameters

idpathrequired: Id
Opaque record id.
documentIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.urlrequired: string
data.expires_atrequired: string
metarequired: object

Request

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

Response example

{
  "data": {
    "url": "string",
    "expires_at": "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.
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.

DELETE/v1/bookings/{id}/documents/{documentId}

Remove a KYC document from a draft booking

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

Parameters

idpathrequired: Id
Opaque record id.
documentIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/bookings/{id}/documents/{documentId}' \
  -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.

PUT/v1/bookings/{id}/partner

Credit a booking not yet confirmed to a channel partner, change or remove the credit (audited, with a reason)

A booking is credited at creation to the partner whose registration lock is live; a partner manager corrects it before confirmation. Brokerage follows at once.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

partner_idrequired: Id or null
Opaque record id.
reasonrequired: string

Response · 200

datarequired: Booking
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/bookings/{id}/partner' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"partner_id":"cmusrceel0000q7kaafxqi1om","reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "string",
    "status": "string",
    "approval": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string",
      "label": "string",
      "floor": 0
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "primary_applicant": "string",
    "booking_date": "2026-10-06",
    "agreement_value": 850000000,
    "confirmed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "migrated": {
      "at": "2026-10-06T05:30:00.000Z",
      "collections_from": "2026-10-06"
    },
    "cost_sheet": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "content_hash": "string",
      "accepted_at": "string",
      "accepted_name": "string",
      "sheet": null
    },
    "payment_plan": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "schedule": [
      {
        "seq": 0,
        "milestone": "string",
        "trigger": "string",
        "percent": 0,
        "amount": 850000000,
        "gst_amount": 850000000,
        "due_date": "2026-10-06",
        "status": "string"
      }
    ],
    "booking_amount": 850000000,
    "gst_amount": 850000000,
    "stamp_duty": 850000000,
    "registration_fee": 850000000,
    "loan": {
      "bank": "string",
      "amount": 850000000,
      "status": "string"
    },
    "notes": "string",
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "is_primary": true,
        "name": "string",
        "relation": "string",
        "pan_masked": "string",
        "aadhaar_last4": "string",
        "dob": "2026-10-06",
        "address": "string",
        "phone": "string",
        "email": "string",
        "has_contact": true
      }
    ],
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string"
    },
    "document_kinds": [
      "string"
    ],
    "gaps": [
      "string"
    ],
    "editable": true,
    "approval_chain_id": "cmusrceel0000q7kaafxqi1om",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "confirmed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancelled": {
      "at": "2026-10-06T05:30:00.000Z",
      "reason": "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.
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/bookings/{id}/submit

Send a complete booking to its approval chain (the company owner confirms at once)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body (optional)

note: string or null

Response · 200

datarequired: Booking
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "string",
    "status": "string",
    "approval": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string",
      "label": "string",
      "floor": 0
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "primary_applicant": "string",
    "booking_date": "2026-10-06",
    "agreement_value": 850000000,
    "confirmed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "migrated": {
      "at": "2026-10-06T05:30:00.000Z",
      "collections_from": "2026-10-06"
    },
    "cost_sheet": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "content_hash": "string",
      "accepted_at": "string",
      "accepted_name": "string",
      "sheet": null
    },
    "payment_plan": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "schedule": [
      {
        "seq": 0,
        "milestone": "string",
        "trigger": "string",
        "percent": 0,
        "amount": 850000000,
        "gst_amount": 850000000,
        "due_date": "2026-10-06",
        "status": "string"
      }
    ],
    "booking_amount": 850000000,
    "gst_amount": 850000000,
    "stamp_duty": 850000000,
    "registration_fee": 850000000,
    "loan": {
      "bank": "string",
      "amount": 850000000,
      "status": "string"
    },
    "notes": "string",
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "is_primary": true,
        "name": "string",
        "relation": "string",
        "pan_masked": "string",
        "aadhaar_last4": "string",
        "dob": "2026-10-06",
        "address": "string",
        "phone": "string",
        "email": "string",
        "has_contact": true
      }
    ],
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string"
    },
    "document_kinds": [
      "string"
    ],
    "gaps": [
      "string"
    ],
    "editable": true,
    "approval_chain_id": "cmusrceel0000q7kaafxqi1om",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "confirmed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancelled": {
      "at": "2026-10-06T05:30:00.000Z",
      "reason": "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.
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/bookings/{id}/withdraw

Withdraw a booking not yet confirmed (the unit returns to sale)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body (optional)

reason: string or null

Response · 200

datarequired: Booking
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "string",
    "status": "string",
    "approval": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string",
      "label": "string",
      "floor": 0
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "primary_applicant": "string",
    "booking_date": "2026-10-06",
    "agreement_value": 850000000,
    "confirmed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "migrated": {
      "at": "2026-10-06T05:30:00.000Z",
      "collections_from": "2026-10-06"
    },
    "cost_sheet": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "content_hash": "string",
      "accepted_at": "string",
      "accepted_name": "string",
      "sheet": null
    },
    "payment_plan": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string"
    },
    "schedule": [
      {
        "seq": 0,
        "milestone": "string",
        "trigger": "string",
        "percent": 0,
        "amount": 850000000,
        "gst_amount": 850000000,
        "due_date": "2026-10-06",
        "status": "string"
      }
    ],
    "booking_amount": 850000000,
    "gst_amount": 850000000,
    "stamp_duty": 850000000,
    "registration_fee": 850000000,
    "loan": {
      "bank": "string",
      "amount": 850000000,
      "status": "string"
    },
    "notes": "string",
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "is_primary": true,
        "name": "string",
        "relation": "string",
        "pan_masked": "string",
        "aadhaar_last4": "string",
        "dob": "2026-10-06",
        "address": "string",
        "phone": "string",
        "email": "string",
        "has_contact": true
      }
    ],
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string"
    },
    "document_kinds": [
      "string"
    ],
    "gaps": [
      "string"
    ],
    "editable": true,
    "approval_chain_id": "cmusrceel0000q7kaafxqi1om",
    "submitted_at": "2026-10-06T05:30:00.000Z",
    "confirmed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancelled": {
      "at": "2026-10-06T05:30:00.000Z",
      "reason": "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.
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.

PATCH/v1/payment-plans/{id}

Change a payment plan or switch it off (confirmed bookings keep their schedule)

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
type: "clp" | "down_payment" | "subvention" | "flexi" | "possession_linked" | "custom"
milestones: array of PaymentMilestoneInput
is_active: boolean

Response · 200

datarequired: PaymentPlan
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/payment-plans/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","type":"clp","milestones":[{"name":"string","percent":0,"trigger":"booking","days":0,"date":"2026-10-06","stage":"string"}],"is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "type": "clp",
    "milestones": [
      {
        "name": "string",
        "percent": 0,
        "trigger": "booking",
        "days": 0,
        "date": "2026-10-06",
        "stage": "string"
      }
    ],
    "is_active": true,
    "bookings": 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.
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}/payment-plans

Payment plans of a project

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of PaymentPlan
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "clp",
      "milestones": [
        {
          "name": "string",
          "percent": 0,
          "trigger": "booking",
          "days": 0,
          "date": "2026-10-06",
          "stage": "string"
        }
      ],
      "is_active": true,
      "bookings": 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.
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}/payment-plans

Add a payment plan (milestones add up to exactly 100 %)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

namerequired: string
typerequired: "clp" | "down_payment" | "subvention" | "flexi" | "possession_linked" | "custom"
milestonesrequired: array of PaymentMilestoneInput

Response · 201

datarequired: PaymentPlan
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/payment-plans' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","type":"clp","milestones":[{"name":"string","percent":0,"trigger":"booking","days":0,"date":"2026-10-06","stage":"string"}]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "type": "clp",
    "milestones": [
      {
        "name": "string",
        "percent": 0,
        "trigger": "booking",
        "days": 0,
        "date": "2026-10-06",
        "stage": "string"
      }
    ],
    "is_active": true,
    "bookings": 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.
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.