Rent collection

An agreement’s rent: the schedule (prorated, escalated, regenerated after amendments), UPI pay links to the landlord’s own UPI id with UTR capture, AutoPay / e-NACH mandates, payments, reversals and waivers, late fees with approval, HRA-ready receipts, the Rent board and the rent settings. Rent is never brokerage revenue.

GET/v1/rent/instalments

The Rent board

Instalments of the agreements you may see, by due date (oldest first): open by default; filter by status, due month or agreement. Keyset pagination.

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

Parameters

statusquery: "open" | "due" | "overdue" | "partially_paid" | "paid" | "waived" | …
monthquery: string
agreement_idquery: Id
Opaque record id.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of object
data[].idrequired: Id
Opaque record id.
data[].seqrequired: integer
data[].period_labelrequired: string
Nov 2026, or 12–30 Nov 2026 for a prorated period
data[].period_startrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
data[].period_endrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
data[].due_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
data[].amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data[].proratedrequired: boolean
data[].late_feerequired: Paise
Approved late fees (charged).
data[].paidrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data[].outstandingrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data[].statusrequired: "scheduled" | "due" | "overdue" | "partially_paid" | "paid" | "waived" | …
data[].waived_reasonrequired: string or null
data[].late_fee_proposedrequired: object or null
A late fee waiting for approval (not charged yet).
data[].late_fee_proposed.idrequired: Id
Opaque record id.
data[].late_fee_proposed.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
data[].agreementrequired: object
data[].agreement.idrequired: Id
Opaque record id.
data[].agreement.propertyrequired: string or null
data[].agreement.tenantrequired: string
data[].agreement.landlordrequired: string
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "seq": 0,
      "period_label": "string",
      "period_start": "2026-10-06",
      "period_end": "2026-10-06",
      "due_on": "2026-10-06",
      "amount": 850000000,
      "prorated": true,
      "late_fee": 850000000,
      "paid": 850000000,
      "outstanding": 850000000,
      "status": "scheduled",
      "waived_reason": "string",
      "late_fee_proposed": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000
      },
      "agreement": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "property": "string",
        "tenant": "string",
        "landlord": "string"
      }
    }
  ],
  "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/rent/instalments/{id}/pay-link

Send the tenant the pay link

Queues the pay link (UPI to the landlord’s own UPI id, then the UTR) through the messaging pipeline and returns the link to share by hand.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.statusrequired: "queued" | "blocked"
data.reasonrequired: string or null
data.urlrequired: string
metarequired: object

Request

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

Response example

{
  "data": {
    "status": "queued",
    "reason": "string",
    "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/rent/instalments/{id}/waive

Waive an instalment

An unpaid or part-paid instalment is waived with a reason; its open late-fee proposal goes with it.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

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

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "waived"
  },
  "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/rent/late-fees/{id}/decision

Approve or waive a late fee

An approved fee is charged with its instalment; a waiver needs a reason. Audited.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

decisionrequired: "approve" | "waive"
reason: string or null

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "approved" | "waived"
data.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "approved",
    "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/rent/payments/{id}/decision

Confirm, reject or reverse a payment

`confirm` / `reject` a tenant’s pending UTR claim (after checking the landlord’s statement); `reverse` a confirmed payment with a new reversal row (a bounced cheque, a wrong entry). Reasons are required for reject / reverse. Audited.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

No fields.

Response · 200

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

Request

curl -X POST 'https://api.propzolo.com/v1/rent/payments/{id}/decision' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"confirm"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "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.

GET/v1/rent/payments/{id}/receipt

A payment’s rent receipt (PDF)

HRA-ready: landlord name and PAN (needed above ₹1,00,000 a year), tenant, period, amount in words.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

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

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

A rent receipt by its signed link

The tenant’s link from the receipt message (180 days). Unknown, expired or reversed links answer 404.

Access: No authentication.

Parameters

tokenpathrequired: string

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/rent/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/rent/summary

This month’s rent figures

Due this month, overdue and collected (net of reversals) for a month (default: this month on the company clock), with the tenants’ UTR claims and the late fees waiting for a decision.

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

Parameters

monthquery: string

Response · 200

datarequired: RentSummary
metarequired: object

Request

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

Response example

{
  "data": {
    "month": "string",
    "due_this_month": {
      "amount": 850000000,
      "count": 0
    },
    "overdue": {
      "amount": 850000000,
      "count": 0
    },
    "collected": {
      "amount": 850000000,
      "count": 0
    },
    "pending_payments": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "payment",
        "status": "pending",
        "source": "member",
        "method": "upi",
        "amount": 850000000,
        "advance": 850000000,
        "utr": "string",
        "received_on": "2026-10-06",
        "receipt_number": "string",
        "notes": "string",
        "rejected_reason": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z",
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "agreement": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "property": "string",
          "tenant": "string",
          "landlord": "string"
        }
      }
    ],
    "late_fees": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "as_of": "2026-10-06",
        "instalment_id": "cmusrceel0000q7kaafxqi1om",
        "period_label": "string",
        "agreement": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "property": "string",
          "tenant": "string",
          "landlord": "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.
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/rental-agreements/{id}/rent

An agreement’s rent

The drawer’s Rent section: profile, schedule with statuses and open late fees, payments, mandate, totals.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AgreementRent
metarequired: object

Request

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

Response example

{
  "data": {
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "set_up": true,
    "problem": "string",
    "rent_amount": 850000000,
    "due_day": 0,
    "pan_required": true,
    "profile": {
      "payee_name": "string",
      "upi_vpa": "string",
      "landlord_pan": "string",
      "reminders_enabled": true,
      "late_fees_enabled": true,
      "generated_at": "2026-10-06T05:30:00.000Z"
    },
    "instalments": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "seq": 0,
        "period_label": "string",
        "period_start": "2026-10-06",
        "period_end": "2026-10-06",
        "due_on": "2026-10-06",
        "amount": 850000000,
        "prorated": true,
        "late_fee": 850000000,
        "paid": 850000000,
        "outstanding": 850000000,
        "status": "scheduled",
        "waived_reason": "string",
        "late_fee_proposed": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "amount": 850000000
        }
      }
    ],
    "payments": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "payment",
        "status": "pending",
        "source": "member",
        "method": "upi",
        "amount": 850000000,
        "advance": 850000000,
        "utr": "string",
        "received_on": "2026-10-06",
        "receipt_number": "string",
        "notes": "string",
        "rejected_reason": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z",
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "mandate": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "autopay",
      "status": "created",
      "max_amount": 850000000,
      "setup_url": "string",
      "failure_reason": "string",
      "activated_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "totals": {
      "outstanding": 850000000,
      "overdue": 850000000,
      "collected": 850000000,
      "advance": 850000000,
      "pending_claims": 0
    },
    "capabilities": {
      "manage": true,
      "late_fees": true,
      "autopay": true,
      "reveal_pan": 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/rental-agreements/{id}/rent

Set up rent collection

The landlord’s UPI id and PAN, the due day (1–28; changing it needs `rentals.edit`), reminders and late fees on / off; (re)generates the schedule without touching rows with money. Audited.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

due_day: integer or null
payee_name: string or null
upi_vpa: string or null
landlord_pan: string or null
reminders_enabled: boolean
late_fees_enabled: boolean

Response · 200

datarequired: AgreementRent
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/rental-agreements/{id}/rent' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"due_day":1,"payee_name":"string","upi_vpa":"string","landlord_pan":"string","reminders_enabled":true,"late_fees_enabled":true}'

Response example

{
  "data": {
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "set_up": true,
    "problem": "string",
    "rent_amount": 850000000,
    "due_day": 0,
    "pan_required": true,
    "profile": {
      "payee_name": "string",
      "upi_vpa": "string",
      "landlord_pan": "string",
      "reminders_enabled": true,
      "late_fees_enabled": true,
      "generated_at": "2026-10-06T05:30:00.000Z"
    },
    "instalments": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "seq": 0,
        "period_label": "string",
        "period_start": "2026-10-06",
        "period_end": "2026-10-06",
        "due_on": "2026-10-06",
        "amount": 850000000,
        "prorated": true,
        "late_fee": 850000000,
        "paid": 850000000,
        "outstanding": 850000000,
        "status": "scheduled",
        "waived_reason": "string",
        "late_fee_proposed": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "amount": 850000000
        }
      }
    ],
    "payments": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "payment",
        "status": "pending",
        "source": "member",
        "method": "upi",
        "amount": 850000000,
        "advance": 850000000,
        "utr": "string",
        "received_on": "2026-10-06",
        "receipt_number": "string",
        "notes": "string",
        "rejected_reason": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z",
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "mandate": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "autopay",
      "status": "created",
      "max_amount": 850000000,
      "setup_url": "string",
      "failure_reason": "string",
      "activated_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "totals": {
      "outstanding": 850000000,
      "overdue": 850000000,
      "collected": 850000000,
      "advance": 850000000,
      "pending_claims": 0
    },
    "capabilities": {
      "manage": true,
      "late_fees": true,
      "autopay": true,
      "reveal_pan": 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.
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/rental-agreements/{id}/rent/mandate

Set up AutoPay / e-NACH

UPI AutoPay up to ₹15,000 per debit, e-NACH above (default cap: the rent the mandate will debit; widen it to cover an escalation). The worker sets it up at the provider and stores the tenant’s setup link; statuses follow the provider’s verified webhooks.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

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

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.kindrequired: "autopay" | "enach"
data.statusrequired: string
data.max_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/rent/mandate' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"max_amount":0}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "autopay",
    "status": "string",
    "max_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/rental-agreements/{id}/rent/mandate/revoke

Revoke the mandate

Recorded at once; the worker tells the provider.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

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

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/rent/mandate/revoke' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "revoked"
  },
  "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/rental-agreements/{id}/rent/payments

Record rent received

Cash, cheque, UPI or bank transfer to the landlord. UPI and bank need the UTR; a UTR already on another live payment of the company is refused (409). Allocated oldest first (approved late fees included) unless an instalment is named; a surplus is kept as an advance. Numbers a receipt. Audited.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

amountrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
methodrequired: "upi" | "cash" | "bank" | "cheque"
received_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
utr: string or null
instalment_id: Id or null
Opaque record id.
notes: string or null

Response · 201

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

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/rent/payments' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"amount":0,"method":"upi","received_on":"2026-10-06","utr":"string","instalment_id":"cmusrceel0000q7kaafxqi1om","notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "receipt_number": "string",
    "advance": 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/rental-agreements/{id}/rent/regenerate

Regenerate the rent schedule

After an amendment (the daily scan also does it): paid, part-paid and waived rows stay as they are.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AgreementRent
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/rent/regenerate' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "set_up": true,
    "problem": "string",
    "rent_amount": 850000000,
    "due_day": 0,
    "pan_required": true,
    "profile": {
      "payee_name": "string",
      "upi_vpa": "string",
      "landlord_pan": "string",
      "reminders_enabled": true,
      "late_fees_enabled": true,
      "generated_at": "2026-10-06T05:30:00.000Z"
    },
    "instalments": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "seq": 0,
        "period_label": "string",
        "period_start": "2026-10-06",
        "period_end": "2026-10-06",
        "due_on": "2026-10-06",
        "amount": 850000000,
        "prorated": true,
        "late_fee": 850000000,
        "paid": 850000000,
        "outstanding": 850000000,
        "status": "scheduled",
        "waived_reason": "string",
        "late_fee_proposed": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "amount": 850000000
        }
      }
    ],
    "payments": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "payment",
        "status": "pending",
        "source": "member",
        "method": "upi",
        "amount": 850000000,
        "advance": 850000000,
        "utr": "string",
        "received_on": "2026-10-06",
        "receipt_number": "string",
        "notes": "string",
        "rejected_reason": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z",
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "mandate": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "autopay",
      "status": "created",
      "max_amount": 850000000,
      "setup_url": "string",
      "failure_reason": "string",
      "activated_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "totals": {
      "outstanding": 850000000,
      "overdue": 850000000,
      "collected": 850000000,
      "advance": 850000000,
      "pending_claims": 0
    },
    "capabilities": {
      "manage": true,
      "late_fees": true,
      "autopay": true,
      "reveal_pan": 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/rental-agreements/{id}/rent/reveal-pan

The landlord’s full PAN (audited)

RENT-14: needs a fresh second factor; every reveal is written to the audit log.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.panrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/rent/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/settings/rent

Rent settings

Reminder cadence with quiet weekdays and holidays, the late-fee rule and receipt options.

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

Response · 200

datarequired: RentSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "reminders": {
      "enabled": true,
      "before_days": [
        1
      ],
      "on_due": true,
      "overdue_days": [
        1
      ],
      "quiet_weekdays": [
        0
      ],
      "holidays": [
        "2026-10-06"
      ]
    },
    "late_fee": {
      "kind": "none",
      "amount": 850000000,
      "bps": 0,
      "grace_days": 0,
      "cap": 850000000
    },
    "receipts": {
      "show_company": true,
      "footer": "string",
      "send_to_tenant": true,
      "notify_landlord": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/rent

Save the rent settings

Replaces the settings (422 on a bad value; at least one working weekday). Audited.

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

Request body

remindersrequired: object
reminders.enabledrequired: boolean
reminders.before_daysrequired: array of integer
reminders.on_duerequired: boolean
reminders.overdue_daysrequired: array of integer
reminders.quiet_weekdaysrequired: array of integer
reminders.holidaysrequired: array of LocalDate
Calendar date YYYY-MM-DD in the company time zone.
late_feerequired: object
late_fee.kindrequired: "none" | "flat_per_day" | "percent_per_day" | "flat_once"
late_fee.amountrequired: Paise
Per day (flat_per_day) or once (flat_once).
late_fee.bpsrequired: integer
Basis points per day of the overdue rent.
late_fee.grace_daysrequired: integer
late_fee.caprequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
receiptsrequired: object
receipts.show_companyrequired: boolean
receipts.footerrequired: string
receipts.send_to_tenantrequired: boolean
receipts.notify_landlordrequired: boolean

Response · 200

datarequired: RentSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/rent' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reminders":{"enabled":true,"before_days":[1],"on_due":true,"overdue_days":[1],"quiet_weekdays":[0],"holidays":["2026-10-06"]},"late_fee":{"kind":"none","amount":850000000,"bps":0,"grace_days":0,"cap":850000000},"receipts":{"show_company":true,"footer":"string","send_to_tenant":true,"notify_landlord":true}}'

Response example

{
  "data": {
    "reminders": {
      "enabled": true,
      "before_days": [
        1
      ],
      "on_due": true,
      "overdue_days": [
        1
      ],
      "quiet_weekdays": [
        0
      ],
      "holidays": [
        "2026-10-06"
      ]
    },
    "late_fee": {
      "kind": "none",
      "amount": 850000000,
      "bps": 0,
      "grace_days": 0,
      "cap": 850000000
    },
    "receipts": {
      "show_company": true,
      "footer": "string",
      "send_to_tenant": true,
      "notify_landlord": 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.
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.

Rent collection

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "seq": 0, "period_label": "string", "period_start": "2026-10-06", "period_end": "2026-10-06", "due_on": "2026-10-06", "amount": 850000000, "prorated": true, "late_fee": 850000000, "paid": 850000000, "outstanding": 850000000, "status": "scheduled", "waived_reason": "string", "late_fee_proposed": { "id": "cmusrceel0000q7kaafxqi1om", "amount": 850000000 }, "agreement": { "id": "cmusrceel0000q7kaafxqi1om", "property": "string", "tenant": "string", "landlord": "string" } } ], "meta": { "next_cursor": "string", "has_more": true } }

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

{ "data": { "month": "string", "due_this_month": { "amount": 850000000, "count": 0 }, "overdue": { "amount": 850000000, "count": 0 }, "collected": { "amount": 850000000, "count": 0 }, "pending_payments": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "payment", "status": "pending", "source": "member", "method": "upi", "amount": 850000000, "advance": 850000000, "utr": "string", "received_on": "2026-10-06", "receipt_number": "string", "notes": "string", "rejected_reason": "string", "reverses_id": "cmusrceel0000q7kaafxqi1om", "reversed": true, "created_at": "2026-10-06T05:30:00.000Z", "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "agreement": { "id": "cmusrceel0000q7kaafxqi1om", "property": "string", "tenant": "string", "landlord": "string" } } ], "late_fees": [ { "id": "cmusrceel0000q7kaafxqi1om", "amount": 850000000, "as_of": "2026-10-06", "instalment_id": "cmusrceel0000q7kaafxqi1om", "period_label": "string", "agreement": { "id": "cmusrceel0000q7kaafxqi1om", "property": "string", "tenant": "string", "landlord": "string" } } ] }, "meta": {} }

{ "data": { "agreement_id": "cmusrceel0000q7kaafxqi1om", "set_up": true, "problem": "string", "rent_amount": 850000000, "due_day": 0, "pan_required": true, "profile": { "payee_name": "string", "upi_vpa": "string", "landlord_pan": "string", "reminders_enabled": true, "late_fees_enabled": true, "generated_at": "2026-10-06T05:30:00.000Z" }, "instalments": [ { "id": "cmusrceel0000q7kaafxqi1om", "seq": 0, "period_label": "string", "period_start": "2026-10-06", "period_end": "2026-10-06", "due_on": "2026-10-06", "amount": 850000000, "prorated": true, "late_fee": 850000000, "paid": 850000000, "outstanding": 850000000, "status": "scheduled", "waived_reason": "string", "late_fee_proposed": { "id": "cmusrceel0000q7kaafxqi1om", "amount": 850000000 } } ], "payments": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "payment", "status": "pending", "source": "member", "method": "upi", "amount": 850000000, "advance": 850000000, "utr": "string", "received_on": "2026-10-06", "receipt_number": "string", "notes": "string", "rejected_reason": "string", "reverses_id": "cmusrceel0000q7kaafxqi1om", "reversed": true, "created_at": "2026-10-06T05:30:00.000Z", "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } } ], "mandate": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "autopay", "status": "created", "max_amount": 850000000, "setup_url": "string", "failure_reason": "string", "activated_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" }, "totals": { "outstanding": 850000000, "overdue": 850000000, "collected": 850000000, "advance": 850000000, "pending_claims": 0 }, "capabilities": { "manage": true, "late_fees": true, "autopay": true, "reveal_pan": true } }, "meta": {} }

curl -X PUT 'https://api.propzolo.com/v1/rental-agreements/{id}/rent' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"due_day":1,"payee_name":"string","upi_vpa":"string","landlord_pan":"string","reminders_enabled":true,"late_fees_enabled":true}'

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/rent/payments' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"amount":0,"method":"upi","received_on":"2026-10-06","utr":"string","instalment_id":"cmusrceel0000q7kaafxqi1om","notes":"string"}'

{ "data": { "reminders": { "enabled": true, "before_days": [ 1 ], "on_due": true, "overdue_days": [ 1 ], "quiet_weekdays": [ 0 ], "holidays": [ "2026-10-06" ] }, "late_fee": { "kind": "none", "amount": 850000000, "bps": 0, "grace_days": 0, "cap": 850000000 }, "receipts": { "show_company": true, "footer": "string", "send_to_tenant": true, "notify_landlord": true } }, "meta": {} }

curl -X PUT 'https://api.propzolo.com/v1/settings/rent' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"reminders":{"enabled":true,"before_days":[1],"on_due":true,"overdue_days":[1],"quiet_weekdays":[0],"holidays":["2026-10-06"]},"late_fee":{"kind":"none","amount":850000000,"bps":0,"grace_days":0,"cap":850000000},"receipts":{"show_company":true,"footer":"string","send_to_tenant":true,"notify_landlord":true}}'