Collections

Builder collections on bookings: construction stages, demand letters and reminders, receipts with 194-IA TDS, late interest, ledger, ageing, cancellation, refunds and transfers.

POST/v1/booking-demands/{id}/cancel

Cancel an open demand raised in error (its instalments can be demanded again)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "cancelled"
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "cancelled"
  },
  "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/booking-demands/{id}/letter

The demand letter as PDF

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/booking-demands/{id}/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.

POST/v1/booking-instalments/{id}/pay-link

The buyer’s signed pay link of an open instalment (UPI to the collection account, then the UTR)

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.urlrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/booking-instalments/{id}/pay-link' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "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/booking-interest/{id}/decide

Charge late interest (it joins the next demand) or waive it with a reason

Needs a fresh second factor (BLD-19). Waiving above the company’s amount waits for the interest_waiver approval chain (409 approval_required; send request_approval to raise it).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

decisionrequired: "charge" | "waive"
reason: string or null
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: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "charged" | "waived" | "approval_pending"
data.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/booking-interest/{id}/decide' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"decision":"charge","reason":"string","request_approval":{"note":"string"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "charged",
    "amount": 850000000
  },
  "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/booking-receipts/{id}/bounce

A payment bounced or was entered in error: its allocations are reversed

Needs a fresh second factor (BLD-19). Cancelling as entered in error (not a bounce) is limited to payments recorded in the last 30 days and, above the company’s amount, waits for the receipt_cancellation approval chain (409 approval_required; send request_approval to raise it). On a cancelled booking the open refund voucher shrinks.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string
status: "bounced" | "cancelled"
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: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "bounced" | "cancelled" | "approval_pending"
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/booking-receipts/{id}/bounce' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string","status":"bounced","request_approval":{"note":"string"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "bounced"
  },
  "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/booking-receipts/{id}/claim

Confirm a UPI payment the buyer reported on the pay link (it is numbered and allocated) or reject it

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

decisionrequired: "confirm" | "reject"
reason: string or null

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "cleared" | "rejected"
data.numberrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/booking-receipts/{id}/claim' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"decision":"confirm","reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "cleared",
    "number": "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/booking-receipts/{id}/clear

A cheque / DD was realised

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

cleared_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "cleared"
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/booking-receipts/{id}/clear' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"cleared_on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "cleared"
  },
  "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/booking-receipts/{id}/pdf

The receipt or refund voucher as PDF

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/booking-receipts/{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/booking-receipts/{id}/refund-paid

A refund voucher was paid out

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

referencerequired: string
paid_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "cleared"
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/booking-receipts/{id}/refund-paid' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reference":"string","paid_on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "cleared"
  },
  "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/booking-receipts/{id}/tds

Record the Form 16B for the TDS on a payment (the TDS then counts as paid)

Needs a fresh second factor (BLD-19). The smaller of the TDS claimed on the receipt and the certificate’s amount counts (BLD-13); `difference` is certificate − claimed.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

form16b_numberrequired: string
form16b_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
form16b_amountrequired: PaiseInput
The TDS amount on the Form 16B.
challan_ref: string or null
Form 26QB acknowledgement.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.tds_statusrequired: "certified"
data.tds_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.differencerequired: integer
Certificate − claimed, paise (0: they match).
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/booking-receipts/{id}/tds' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"form16b_number":"string","form16b_on":"2026-10-06","form16b_amount":0,"challan_ref":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "tds_status": "certified",
    "tds_amount": 850000000,
    "difference": 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.

POST/v1/bookings/{id}/cancel

Cancel an allotted booking: forfeiture kept, the rest refunded, the unit back on sale, brokerage reversed

Needs a fresh second factor. A waived or lowered forfeiture, or a refund above the company’s amount, waits for the booking_cancellation approval chain (409 approval_required; send request_approval to raise it).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string
waive_forfeit: boolean
forfeit_override: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
refund_mode: "upi" | "neft" | "rtgs" | "imps" | "cheque" | "dd" | … or null
refund_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
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: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "cancelled" | "approval_pending"
data.forfeitrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.refundrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.tds_not_refundedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.refund_receiptrequired: object or null
data.refund_receipt.idrequired: Id
Opaque record id.
data.refund_receipt.numberrequired: string
data.brokerage_reversedrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bookings/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string","waive_forfeit":true,"forfeit_override":0,"refund_mode":"upi","refund_on":"2026-10-06","request_approval":{"note":"string"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "cancelled",
    "forfeit": 850000000,
    "refund": 850000000,
    "tds_not_refunded": 850000000,
    "refund_receipt": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": "string"
    },
    "brokerage_reversed": 850000000
  },
  "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}/collections

A booking’s schedule, demands, receipts, interest, TDS, transfers and customer ledger

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: BookingCollections
metarequired: object

Request

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

Response example

{
  "data": {
    "booking": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "status": "string",
      "unit": "string",
      "agreement_value": 850000000,
      "gst_amount": 850000000,
      "buyers": [
        "string"
      ],
      "without_contact": [
        {
          "name": "string",
          "primary": true
        }
      ]
    },
    "totals": {
      "total": 850000000,
      "paid": 850000000,
      "outstanding": 850000000,
      "overdue": 850000000,
      "interest_accrued": 850000000,
      "interest_outstanding": 850000000,
      "advance": 850000000,
      "received": 850000000
    },
    "tds": {
      "section": "string",
      "stamp_duty_value": 850000000,
      "rate_bps": 0,
      "note": "string",
      "expected": 850000000,
      "deducted": 850000000,
      "certified": 850000000,
      "short": 850000000,
      "awaiting_certificate": 0
    },
    "schedule": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "seq": 0,
        "milestone": "string",
        "trigger": "string",
        "stage": "string",
        "amount": 850000000,
        "gst_amount": 850000000,
        "paid": 850000000,
        "outstanding": 850000000,
        "interest_outstanding": 850000000,
        "due_date": "2026-10-06",
        "status": "string",
        "bucket": "not_due",
        "demand": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string"
        }
      }
    ],
    "demands": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "issued_on": "2026-10-06",
        "due_on": "2026-10-06",
        "amount": 850000000,
        "interest": 850000000,
        "status": "issued",
        "trigger": "string",
        "reminders": [
          "string"
        ],
        "sent": true
      }
    ],
    "receipts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "kind": "payment",
        "mode": "string",
        "reference": "string",
        "amount": 850000000,
        "tds_amount": 850000000,
        "tds_section": "string",
        "tds_status": "none",
        "form16b_number": "string",
        "form16b_amount": 850000000,
        "advance": 850000000,
        "received_on": "2026-10-06",
        "cleared_on": "2026-10-06",
        "status": "claimed"
      }
    ],
    "interest": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "schedule_id": "cmusrceel0000q7kaafxqi1om",
        "as_of": "2026-10-06",
        "days": 0,
        "rate_bps": 0,
        "amount": 850000000,
        "status": "accrued",
        "waived_reason": "string"
      }
    ],
    "transfers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "transferred_on": "2026-10-06",
        "fee": 850000000,
        "from": [
          {
            "name": "string",
            "pan_last4": "string"
          }
        ],
        "to": [
          {
            "name": "string",
            "pan_last4": "string"
          }
        ]
      }
    ],
    "ledger": [
      {
        "date": "2026-10-06",
        "kind": "demand",
        "ref": "string",
        "description": "string",
        "debit": 850000000,
        "credit": 850000000,
        "balance": 850000000
      }
    ]
  },
  "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}/demands

Raise a demand letter (default: every instalment due within 30 days and not demanded yet)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body (optional)

schedule_ids: array of Id or null
Opaque record id.
due_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.numberrequired: integer
data.refrequired: string
data.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.interestrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.due_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
data.rowsrequired: integer
data.blockedrequired: string or null
Why the message to the buyer was blocked (null: queued).
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bookings/{id}/demands' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"schedule_ids":["cmusrceel0000q7kaafxqi1om"],"due_on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": 0,
    "ref": "string",
    "amount": 850000000,
    "interest": 850000000,
    "due_on": "2026-10-06",
    "rows": 0,
    "blocked": "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}/milestone-dates

The agreement was signed / possession offered: its instalments fall due and are demanded

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

milestonerequired: "agreement" | "possession"
onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: object
data.demandrequired: object or null
data.demand.idrequired: Id
Opaque record id.
data.demand.numberrequired: integer
data.demand.refrequired: string
data.demand.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.demand.interestrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.demand.due_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
data.demand.rowsrequired: integer
data.demand.blockedrequired: string or null
Why the message to the buyer was blocked (null: queued).
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bookings/{id}/milestone-dates' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"milestone":"agreement","on":"2026-10-06"}'

Response example

{
  "data": {
    "demand": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0,
      "ref": "string",
      "amount": 850000000,
      "interest": 850000000,
      "due_on": "2026-10-06",
      "rows": 0,
      "blocked": "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}/receipts

Record a buyer’s payment (and the TDS they deducted); it settles the oldest demanded instalments first

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

amountrequired: PaiseInput
What reached the account (net of TDS).
tds_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
moderequired: "upi" | "neft" | "rtgs" | "imps" | "cheque" | "dd" | …
reference: string or null
UTR / cheque number (not for cash).
bank: string or null
received_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
notes: string or null

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.numberrequired: string
data.advancerequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.expected_tdsrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.tds_shortrequired: Paise
Money in paise (₹1 = 100), an exact integer.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bookings/{id}/receipts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"amount":0,"tds_amount":0,"mode":"upi","reference":"string","bank":"string","received_on":"2026-10-06","notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "string",
    "advance": 850000000,
    "expected_tds": 850000000,
    "tds_short": 850000000
  },
  "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.

PUT/v1/bookings/{id}/stamp-value

Record the registered stamp-duty value (194-IA tests the higher of it and the consideration)

BLD-09: from 1 Apr 2022 TDS u/s 194-IA applies when the higher of the consideration and the stamp-duty value is ₹50 L or more. null clears it. The answer is the section that now applies to the booking’s payments.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

stamp_duty_valuerequired: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.

Response · 200

datarequired: object
data.booking_idrequired: Id
Opaque record id.
data.stamp_duty_valuerequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
data.tds_sectionrequired: string or null
e.g. 194-IA; null when no TDS applies.
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/bookings/{id}/stamp-value' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"stamp_duty_value":0}'

Response example

{
  "data": {
    "booking_id": "cmusrceel0000q7kaafxqi1om",
    "stamp_duty_value": 850000000,
    "tds_section": "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}/transfer

Transfer an allotted booking to new buyers (endorsement), with an optional transfer fee

With the company setting transfer_fee_blocks (BLD-15) a fee is billed to the current buyers first: the answer is status fee_pending (id null) until that fee is paid, then the same call completes the transfer.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

applicantsrequired: array of object
applicants[].namerequired: string
applicants[].relation: "self" | "spouse" | "parent" | "child" | "sibling" | "other"
applicants[].is_primary: boolean
applicants[].pan: string or null
applicants[].aadhaar: string or null
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
fee: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
transferred_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
notes: string or null

Response · 201

datarequired: object
data.idrequired: Id or null
The transfer (null while the fee is pending).
data.statusrequired: "transferred" | "fee_pending"
data.booking_idrequired: Id
Opaque record id.
data.feerequired: Paise
Money in paise (₹1 = 100), an exact integer.
data.fee_demand_idrequired: Id or null
The demand raised for the transfer fee (with GST).
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "transferred",
    "booking_id": "cmusrceel0000q7kaafxqi1om",
    "fee": 850000000,
    "fee_demand_id": "cmusrceel0000q7kaafxqi1om"
  },
  "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/collections

Ageing of booking instalments, bookings with money outstanding and payments awaiting Form 16B

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

Parameters

project_idquery: Id
Opaque record id.
only_overduequery: string
cursorquery: string
limitquery: integer
queue_limitquery: integer
Entries of the Form 16B and claim queues to return (default 50).

Response · 200

datarequired: CollectionsBoard
metarequired: PageMeta

Request

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

Response example

{
  "data": {
    "ageing": {
      "not_due": {
        "amount": 850000000,
        "count": 0
      },
      "d0_30": {
        "amount": 850000000,
        "count": 0
      },
      "d31_60": {
        "amount": 850000000,
        "count": 0
      },
      "d61_90": {
        "amount": 850000000,
        "count": 0
      },
      "d90_plus": {
        "amount": 850000000,
        "count": 0
      }
    },
    "bookings": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "status": "string",
        "unit": "string",
        "buyer": "string",
        "outstanding": 850000000,
        "overdue": 850000000,
        "oldest_overdue": "2026-10-06",
        "bucket": "not_due"
      }
    ],
    "awaiting_form16b": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "booking_id": "cmusrceel0000q7kaafxqi1om",
        "tds_amount": 850000000,
        "section": "string",
        "received_on": "2026-10-06"
      }
    ],
    "claims": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "booking_id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "utr": "string",
        "paid_on": "2026-10-06"
      }
    ],
    "queues": {
      "awaiting_form16b": 0,
      "claims": 0
    }
  },
  "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.

GET/v1/collections/settings

Demand days, reminder days, late interest, forfeiture and buyer messages

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

Response · 200

datarequired: CollectionsPolicy
metarequired: object

Request

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

Response example

{
  "data": {
    "demand_days": 0,
    "reminder_days": [
      1
    ],
    "interest_bps": 0,
    "interest_grace_days": 0,
    "forfeit_bps": 0,
    "send_demands": true,
    "send_receipts": true,
    "demand_footer": "string",
    "upi_vpa": "",
    "payee_name": "string",
    "gst_after_cc": "keep",
    "transfer_fee_blocks": true,
    "booking_backdate_days": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/collections/settings

Change the collections settings (audited)

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

Request body

demand_daysrequired: integer
Days between a stage certificate (or the agreement / possession date) and the due date.
reminder_daysrequired: array of integer
Default 7, 3, 1.
interest_bpsrequired: integer
Late interest, basis points a year (0: none).
interest_grace_daysrequired: integer
forfeit_bpsrequired: integer
Forfeited of the agreement value.
send_demandsrequired: boolean
send_receiptsrequired: boolean
demand_footerrequired: string
upi_vparequired: "" or string
The collection account’s UPI id for the buyer’s pay link (empty: none).
payee_namerequired: string
gst_after_cc: "keep" | "drop"
Instalments demanded after the completion / occupancy certificate keep or drop their GST (BLD-10).
transfer_fee_blocks: boolean
A transfer with a fee completes only once the fee is paid (BLD-15).
booking_backdate_days: integer
Days a booking may be dated before its cost sheet was accepted (BLD-37).

Response · 200

datarequired: CollectionsPolicy
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/collections/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"demand_days":0,"reminder_days":[1],"interest_bps":0,"interest_grace_days":0,"forfeit_bps":0,"send_demands":true,"send_receipts":true,"demand_footer":"string","upi_vpa":"","payee_name":"string","gst_after_cc":"keep","transfer_fee_blocks":true,"booking_backdate_days":0}'

Response example

{
  "data": {
    "demand_days": 0,
    "reminder_days": [
      1
    ],
    "interest_bps": 0,
    "interest_grace_days": 0,
    "forfeit_bps": 0,
    "send_demands": true,
    "send_receipts": true,
    "demand_footer": "string",
    "upi_vpa": "",
    "payee_name": "string",
    "gst_after_cc": "keep",
    "transfer_fee_blocks": true,
    "booking_backdate_days": 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/projects/{id}/completion

Completion / occupancy certificate dates of a project and its towers

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ProjectCompletion
metarequired: object

Request

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

Response example

{
  "data": {
    "project": "2026-10-06",
    "towers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "cc_on": "2026-10-06"
      }
    ]
  },
  "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/projects/{id}/completion

Record (or clear) the completion / occupancy certificate date of a tower or the whole project

BLD-10: cost sheets priced from that day carry the ready-flat GST; demands from that day follow the company’s gst_after_cc setting. Audited.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

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

Response · 200

datarequired: ProjectCompletion
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/projects/{id}/completion' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"tower_id":"cmusrceel0000q7kaafxqi1om","cc_on":"2026-10-06"}'

Response example

{
  "data": {
    "project": "2026-10-06",
    "towers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "cc_on": "2026-10-06"
      }
    ]
  },
  "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}/construction-stages

Construction stages certified for a project

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of ConstructionStage
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "stage": "string",
      "tower": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "name": "string",
      "certified_on": "2026-10-06",
      "certificate_ref": "string",
      "notes": "string",
      "created_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}/construction-stages

Certify a stage: every allotted booking’s instalments linked to it fall due and are demanded

BLD-03: with tower_id only that tower’s bookings are dated and demanded (CLP milestones are per tower); without it the whole project. A stage is certified per tower or for the whole project, never both.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

stagerequired: string
tower_id: Id or null
Opaque record id.
certified_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
name: string or null
certificate_ref: string or null
notes: string or null

Response · 201

datarequired: object
data.stagerequired: ConstructionStage
data.bookingsrequired: integer
data.demandsrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/construction-stages' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"stage":"string","tower_id":"cmusrceel0000q7kaafxqi1om","certified_on":"2026-10-06","name":"string","certificate_ref":"string","notes":"string"}'

Response example

{
  "data": {
    "stage": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "stage": "string",
      "tower": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "name": "string",
      "certified_on": "2026-10-06",
      "certificate_ref": "string",
      "notes": "string",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "bookings": 0,
    "demands": 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}/construction-stages/preview

How many allotted bookings (and instalments) certifying a stage would demand — before certifying

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

Parameters

idpathrequired: Id
Opaque record id.
stagequeryrequired: string
tower_idquery: Id
Opaque record id.

Response · 200

datarequired: object
data.bookingsrequired: integer
data.instalmentsrequired: integer
metarequired: object

Request

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

Response example

{
  "data": {
    "bookings": 0,
    "instalments": 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.