RentSummary

object

monthrequired: string
due_this_monthrequired: object
due_this_month.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
due_this_month.countrequired: integer
overduerequired: object
overdue.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
overdue.countrequired: integer
collectedrequired: object
collected.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
collected.countrequired: integer
pending_paymentsrequired: array of object
pending_payments[].idrequired: Id
Opaque record id.
pending_payments[].kindrequired: "payment" | "reversal"
pending_payments[].statusrequired: "pending" | "confirmed" | "rejected"
pending_payments[].sourcerequired: "member" | "tenant_link" | "mandate" | "deposit"
pending_payments[].methodrequired: "upi" | "autopay" | "enach" | "cash" | "bank" | "cheque" | …
pending_payments[].amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
pending_payments[].advancerequired: Paise
Left over after allocation; kept as an advance, not auto-applied.
pending_payments[].utrrequired: string or null
pending_payments[].received_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
pending_payments[].receipt_numberrequired: string or null
pending_payments[].notesrequired: string or null
pending_payments[].rejected_reasonrequired: string or null
pending_payments[].reverses_idrequired: Id or null
Opaque record id.
pending_payments[].reversedrequired: boolean
pending_payments[].created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
pending_payments[].created_byrequired: object or null
pending_payments[].created_by.idrequired: Id
Opaque record id.
pending_payments[].created_by.namerequired: string
pending_payments[].agreementrequired: object
pending_payments[].agreement.idrequired: Id
Opaque record id.
pending_payments[].agreement.propertyrequired: string or null
pending_payments[].agreement.tenantrequired: string
pending_payments[].agreement.landlordrequired: string
late_feesrequired: array of object
late_fees[].idrequired: Id
Opaque record id.
late_fees[].amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
late_fees[].as_ofrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
late_fees[].instalment_idrequired: Id
Opaque record id.
late_fees[].period_labelrequired: string
late_fees[].agreementrequired: object
late_fees[].agreement.idrequired: Id
Opaque record id.
late_fees[].agreement.propertyrequired: string or null
late_fees[].agreement.tenantrequired: string
late_fees[].agreement.landlordrequired: string

Example

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

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