Rental deposits

The deposit ledger: who holds it (landlord, escrow partner, the brokerage in trust), money received, paid to the landlord and refunded (append-only), deductions from the comparison with the tenant’s answers, the settlement and the statement — never brokerage revenue.

POST/v1/rental-agreements/{id}/deductions

Add a deduction by hand

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

sourcerequired: "damage" | "missing_item" | "utilities" | "cleaning" | "keys" | "unpaid_rent" | …
labelrequired: string
detail: string or null
amountrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.

Response · 201

datarequired: RentalDepositPanel
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/deductions' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"source":"damage","label":"string","detail":"string","amount":0}'

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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}/deductions/propose

Add the comparison’s proposals as draft deductions

From the signed move-out compared with the signed move-in; once per difference.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

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

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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}/deductions/send

Send the deductions to the tenant

Drafts go to the tenant, who accepts or disputes each on their link (minted at delivery).

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

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

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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}/deductions/unpaid-rent

Recover unpaid rent from the deposit

Puts the outstanding rent instalments into one draft deduction (refreshed while it is a draft). Once the tenant accepts it, or a dispute is resolved, the decided amount is recorded on the rent ledger as paid from the deposit.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

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

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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.

GET/v1/rental-agreements/{id}/deposit

The deposit of a rental agreement

Holder, ledger, deductions and the settlement (refund due, refundable now, shortfall, landlord’s due).

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

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

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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}/deposit

The agreed deposit and who holds it

A holder change needs rentals.deposits (step-up); the brokerage holds deposits only when allowed.

Access: API key or member session. Permission rentals.edit or rentals.deposits.

Parameters

idpathrequired: Id
Opaque record id.

Request body

agreed_amount: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
holder: "owner" | "escrow" | "brokerage"
escrow_partner: string or null
escrow_reference: string or null

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/rental-agreements/{id}/deposit' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"agreed_amount":0,"holder":"owner","escrow_partner":"string","escrow_reference":"string"}'

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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}/deposit/entries

Record deposit money

Received from the tenant, paid to the landlord for agreed deductions (escrow / brokerage holders), or refunded. A refund is limited to what can be refunded now (open deductions stay held). Step-up; audited; never edited.

Access: API key or member session. Permission rentals.deposits.

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

kindrequired: "received" | "retained" | "refund"
amountrequired: PaiseInput
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
occurred_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
note: string or null
deduction_ids: array of Id or null
Opaque record id.

Response · 201

datarequired: RentalDepositPanel
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/deposit/entries' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"received","amount":0,"mode":"upi","reference":"string","occurred_on":"2026-10-06","note":"string","deduction_ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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}/deposit/escrow

Escrow account: open, release or check

open: ask the escrow partner for an account · release: pay out the settlement (deductions to the landlord, the rest to the tenant) · sync: check now. Queued; 409 without an escrow partner. Step-up.

Access: API key or member session. Permission rentals.deposits.

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "open" | "release" | "sync"

Response · 202

datarequired: RentalDepositPanel
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/deposit/escrow' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"open"}'

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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.

GET/v1/rental-agreements/{id}/deposit/statement

The deposit statement (PDF)

The ledger, the deductions and the settlement, for both parties. Never brokerage revenue.

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/rental-agreements/{id}/deposit/statement' \
  -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.

PATCH/v1/rental-deductions/{id}

Change a deduction

Drafts and deductions waiting for the tenant only.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

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

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/rental-deductions/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"label":"string","detail":"string","amount":0}'

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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-deductions/{id}/resolve

Resolve a disputed deduction

At the agreed amount (at most what was claimed; 0 drops it), with how it was agreed. Step-up.

Access: API key or member session. Permission rentals.deposits.

Parameters

idpathrequired: Id
Opaque record id.

Request body

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

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-deductions/{id}/resolve' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"final_amount":0,"note":"string"}'

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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-deductions/{id}/response

Record the tenant’s answer

Accept or dispute with a note saying how the tenant answered (in person, on a call). Deposit rights and step-up. Audited.

Access: API key or member session. Permission rentals.deposits.

Parameters

idpathrequired: Id
Opaque record id.

Request body

responserequired: "accept" | "dispute"
note: string or null

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

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

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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-deductions/{id}/waive

Waive a deduction

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

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

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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-deposit-entries/{id}/reverse

Reverse a deposit entry

A new entry cancels it (with the reason); escrow movements come from the partner and cannot be reversed.

Access: API key or member session. Permission rentals.deposits.

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: RentalDepositPanel
metarequired: object

Request

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

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "deposit_amount": 850000000,
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "deposit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreed_amount": 850000000,
      "holder": "owner",
      "holder_label": "string",
      "escrow": {
        "partner": "string",
        "reference": "string",
        "provider": "string",
        "account_open": true,
        "status": "string",
        "synced_at": "2026-10-06T05:30:00.000Z"
      },
      "status": "awaiting",
      "status_label": "string",
      "figures": {
        "received": 850000000,
        "retained": 850000000,
        "refunded": 850000000,
        "decided": 850000000,
        "pending": 850000000,
        "refund_due": 850000000,
        "refundable_now": 850000000,
        "shortfall": 850000000,
        "landlord_due": 850000000,
        "balance_held": 850000000
      },
      "settlement_started": true,
      "refund_due_on": "2026-10-06",
      "days_to_refund": 0,
      "settled_at": "2026-10-06T05:30:00.000Z",
      "review": {
        "status": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    },
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "received",
        "kind_label": "string",
        "amount": 850000000,
        "holder": "string",
        "mode": "string",
        "reference": "string",
        "occurred_on": "2026-10-06",
        "note": "string",
        "source": "string",
        "reversed": true,
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "recorded_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "can_reverse": true
      }
    ],
    "deductions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "source": "damage",
        "source_label": "string",
        "ref": "string",
        "inspection_id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "proposed_amount": 850000000,
        "amount": 850000000,
        "counted": 850000000,
        "status": "draft",
        "status_label": "string",
        "tenant_note": "string",
        "responded_at": "2026-10-06T05:30:00.000Z",
        "responded_via": "string",
        "final_amount": 850000000,
        "resolution_note": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "waive_reason": "string",
        "proposed_at": "2026-10-06T05:30:00.000Z",
        "needs_amount": true,
        "can": {
          "edit": true,
          "waive": true,
          "respond": true,
          "resolve": true
        }
      }
    ],
    "holders": {
      "escrow": true,
      "brokerage": true
    },
    "escrow_available": true,
    "capabilities": {
      "edit": true,
      "money": true,
      "send_review": 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.

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/deductions' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"source":"damage","label":"string","detail":"string","amount":0}'

{ "data": { "today": "2026-10-06", "agreement": { "id": "cmusrceel0000q7kaafxqi1om", "status": "string", "deposit_amount": 850000000, "deal_id": "cmusrceel0000q7kaafxqi1om" }, "deposit": { "id": "cmusrceel0000q7kaafxqi1om", "agreed_amount": 850000000, "holder": "owner", "holder_label": "string", "escrow": { "partner": "string", "reference": "string", "provider": "string", "account_open": true, "status": "string", "synced_at": "2026-10-06T05:30:00.000Z" }, "status": "awaiting", "status_label": "string", "figures": { "received": 850000000, "retained": 850000000, "refunded": 850000000, "decided": 850000000, "pending": 850000000, "refund_due": 850000000, "refundable_now": 850000000, "shortfall": 850000000, "landlord_due": 850000000, "balance_held": 850000000 }, "settlement_started": true, "refund_due_on": "2026-10-06", "days_to_refund": 0, "settled_at": "2026-10-06T05:30:00.000Z", "review": { "status": "string", "sent_at": "2026-10-06T05:30:00.000Z", "expires_at": "2026-10-06T05:30:00.000Z", "opened_at": "2026-10-06T05:30:00.000Z", "blocked_reason": "string" } }, "entries": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "received", "kind_label": "string", "amount": 850000000, "holder": "string", "mode": "string", "reference": "string", "occurred_on": "2026-10-06", "note": "string", "source": "string", "reversed": true, "reverses_id": "cmusrceel0000q7kaafxqi1om", "recorded_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "can_reverse": true } ], "deductions": [ { "id": "cmusrceel0000q7kaafxqi1om", "source": "damage", "source_label": "string", "ref": "string", "inspection_id": "cmusrceel0000q7kaafxqi1om", "label": "string", "detail": "string", "basis": "string", "proposed_amount": 850000000, "amount": 850000000, "counted": 850000000, "status": "draft", "status_label": "string", "tenant_note": "string", "responded_at": "2026-10-06T05:30:00.000Z", "responded_via": "string", "final_amount": 850000000, "resolution_note": "string", "resolved_at": "2026-10-06T05:30:00.000Z", "waive_reason": "string", "proposed_at": "2026-10-06T05:30:00.000Z", "needs_amount": true, "can": { "edit": true, "waive": true, "respond": true, "resolve": true } } ], "holders": { "escrow": true, "brokerage": true }, "escrow_available": true, "capabilities": { "edit": true, "money": true, "send_review": true } }, "meta": {} }

curl -X PUT 'https://api.propzolo.com/v1/rental-agreements/{id}/deposit' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"agreed_amount":0,"holder":"owner","escrow_partner":"string","escrow_reference":"string"}'

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/deposit/entries' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"kind":"received","amount":0,"mode":"upi","reference":"string","occurred_on":"2026-10-06","note":"string","deduction_ids":["cmusrceel0000q7kaafxqi1om"]}'

curl -X PATCH 'https://api.propzolo.com/v1/rental-deductions/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"label":"string","detail":"string","amount":0}'

curl -X POST 'https://api.propzolo.com/v1/rental-deductions/{id}/resolve' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"final_amount":0,"note":"string"}'

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