RentalAgreement

object

idrequired: Id
Opaque record id.
statusrequired: AgreementStatus
propertyrequired: object or null
property.idrequired: Id
Opaque record id.
property.ref_coderequired: string
property.titlerequired: string
dealrequired: object or null
deal.idrequired: Id
Opaque record id.
deal.refrequired: string
deal.titlerequired: string
deal.ownerrequired: MemberRef or null
ownerrequired: MemberRef or null
The member who manages the let (own / team scopes).
leadrequired: object or null
lead.idrequired: Id
Opaque record id.
lead.refrequired: string
landlordrequired: DealContactRef
tenantrequired: DealContactRef
start_daterequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
end_daterequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
rent_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
deposit_amountrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
maintenancerequired: object or null
As agreed: copied from the listing when the agreement is recorded, editable after that.
maintenance.amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
maintenance.periodrequired: MaintenancePeriod or null
escalation_pctrequired: string or null
lock_in_monthsrequired: integer or null
lock_in_ends_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
notice_monthsrequired: integer or null
rent_due_dayrequired: integer or null
police_verificationrequired: PoliceVerificationStatus or null
agreement_typerequired: AgreementType or null
has_documentrequired: boolean
document_scan_statusrequired: FileScanStatus or null
renewal_reminder_onrequired: LocalDate or null
Date of the next renewal reminder.
days_leftrequired: integer
Days until the end date (negative once it has passed).
renewal_dealrequired: object or null
renewal_deal.idrequired: Id
Opaque record id.
renewal_deal.refrequired: string
renewal_deal.stagerequired: DealStage
offer_made, owner_review, accepted and move_in belong to rental deals only (R-01).
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
capabilitiesrequired: object
capabilities.editrequired: boolean
capabilities.deleterequired: boolean
capabilities.renewrequired: boolean

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "status": "draft",
  "property": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "string",
    "title": "string"
  },
  "deal": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "title": "string",
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    }
  },
  "owner": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "lead": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string"
  },
  "landlord": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "tenant": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "start_date": "2026-10-06",
  "end_date": "2026-10-06",
  "rent_amount": 850000000,
  "deposit_amount": 850000000,
  "maintenance": {
    "amount": 850000000,
    "period": "monthly"
  },
  "escalation_pct": "string",
  "lock_in_months": 0,
  "lock_in_ends_on": "2026-10-06",
  "notice_months": 0,
  "rent_due_day": 0,
  "police_verification": "pending",
  "agreement_type": "notarised",
  "has_document": true,
  "document_scan_status": "pending",
  "renewal_reminder_on": "2026-10-06",
  "days_left": 0,
  "renewal_deal": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "stage": "negotiation"
  },
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z",
  "capabilities": {
    "edit": true,
    "delete": true,
    "renew": true
  }
}

{ "id": "cmusrceel0000q7kaafxqi1om", "status": "draft", "property": { "id": "cmusrceel0000q7kaafxqi1om", "ref_code": "string", "title": "string" }, "deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "title": "string", "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string" }, "landlord": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "tenant": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "start_date": "2026-10-06", "end_date": "2026-10-06", "rent_amount": 850000000, "deposit_amount": 850000000, "maintenance": { "amount": 850000000, "period": "monthly" }, "escalation_pct": "string", "lock_in_months": 0, "lock_in_ends_on": "2026-10-06", "notice_months": 0, "rent_due_day": 0, "police_verification": "pending", "agreement_type": "notarised", "has_document": true, "document_scan_status": "pending", "renewal_reminder_on": "2026-10-06", "days_left": 0, "renewal_deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "stage": "negotiation" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "capabilities": { "edit": true, "delete": true, "renew": true } }