RentalDepositPanel

object

todayrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
agreementrequired: object
agreement.idrequired: Id
Opaque record id.
agreement.statusrequired: string
agreement.deposit_amountrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
agreement.deal_idrequired: Id or null
Opaque record id.
depositrequired: object
deposit.idrequired: Id or null
null until someone first works with the deposit.
deposit.agreed_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.holderrequired: "owner" | "escrow" | "brokerage"
deposit.holder_labelrequired: string
deposit.escrowrequired: object or null
deposit.escrow.partnerrequired: string or null
deposit.escrow.referencerequired: string or null
deposit.escrow.providerrequired: string or null
deposit.escrow.account_openrequired: boolean
deposit.escrow.statusrequired: string or null
deposit.escrow.synced_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
deposit.statusrequired: "awaiting" | "held" | "settling" | "disputed" | "settled"
deposit.status_labelrequired: string
deposit.figuresrequired: object
deposit.figures.receivedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.retainedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.refundedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.decidedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.pendingrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.refund_duerequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.refundable_nowrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.shortfallrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.landlord_duerequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.figures.balance_heldrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit.settlement_startedrequired: boolean
deposit.refund_due_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
deposit.days_to_refundrequired: integer or null
Negative: overdue by that many days.
deposit.settled_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
deposit.reviewrequired: object
deposit.review.statusrequired: string
deposit.review.sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
deposit.review.expires_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
deposit.review.opened_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
deposit.review.blocked_reasonrequired: string or null
entriesrequired: array of DepositEntry
deductionsrequired: array of DepositDeduction
holdersrequired: object
holders.escrowrequired: boolean
holders.brokeragerequired: boolean
escrow_availablerequired: boolean
An escrow partner is set up (accounts opened through it).
capabilitiesrequired: object
capabilities.editrequired: boolean
capabilities.moneyrequired: boolean
capabilities.send_reviewrequired: boolean

Example

{
  "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
  }
}

{ "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 } }