AgreementDocumentPanel

object

agreementrequired: object
agreement.idrequired: Id
Opaque record id.
agreement.statusrequired: string
agreement.start_daterequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
agreement.end_daterequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
agreement.term_monthsrequired: integer or null
agreement.rent_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
agreement.deposit_amountrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
agreement.agreement_typerequired: string or null
agreement.landlordrequired: object
agreement.landlord.idrequired: Id
Opaque record id.
agreement.landlord.namerequired: string
agreement.landlord.phonerequired: string or null
agreement.tenantrequired: object
agreement.tenant.idrequired: Id
Opaque record id.
agreement.tenant.namerequired: string
agreement.tenant.phonerequired: string or null
agreement.propertyrequired: object or null
agreement.property.idrequired: Id
Opaque record id.
agreement.property.titlerequired: string
agreement.property.staterequired: string or null
agreement.staterequired: string or null
templatesrequired: array of object
templates[].keyrequired: string
templates[].originrequired: "system" | "company"
templates[].system_keyrequired: string or null
templates[].kindrequired: AgreementDocumentKind
templates[].statesrequired: array of string
templates[].titlerequired: string
templates[].descriptionrequired: string or null
templates[].executionrequired: AgreementExecution
templates[].versionrequired: integer
templates[].statusrequired: "active" | "archived"
templates[].updated_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
templates[].fitsrequired: boolean
suggested_templaterequired: string or null
documentrequired: AgreementDocument or null
enveloperequired: ESignEnvelope or null
registrationrequired: AgreementRegistration or null
creditsrequired: array of object
credits[].denominationrequired: Paise
Money in paise (₹1 = 100), an exact integer.
credits[].availablerequired: integer
esign_configuredrequired: boolean
capabilitiesrequired: object
capabilities.editrequired: boolean
capabilities.sendrequired: boolean
capabilities.cancelrequired: boolean
capabilities.registerrequired: boolean

Example

{
  "agreement": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "start_date": "2026-10-06",
    "end_date": "2026-10-06",
    "term_months": 0,
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "agreement_type": "string",
    "landlord": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "phone": "string"
    },
    "tenant": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "phone": "string"
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "state": "string"
    },
    "state": "string"
  },
  "templates": [
    {
      "key": "string",
      "origin": "system",
      "system_key": "string",
      "kind": "leave_licence",
      "states": [
        "string"
      ],
      "title": "string",
      "description": "string",
      "execution": "notarised",
      "version": 0,
      "status": "active",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "fits": true
    }
  ],
  "suggested_template": "string",
  "document": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "version": 0,
    "status": "draft",
    "template": {
      "key": "string",
      "version": 0,
      "title": "string",
      "current_version": 0
    },
    "kind": "leave_licence",
    "kind_label": "string",
    "state": "string",
    "execution": "notarised",
    "area": "string",
    "title": "string",
    "fields": {
      "place": "string",
      "execution_date": "2026-10-06",
      "landlord": {
        "relation": "string",
        "age": 0,
        "address": "string"
      },
      "tenant": {
        "relation": "string",
        "age": 0,
        "address": "string"
      },
      "property_address": "string",
      "property_description": "string",
      "city": "string",
      "inclusions": [
        "string"
      ],
      "special_conditions": "string",
      "non_refundable_amount": 850000000,
      "witnesses": [
        {
          "name": "string",
          "address": "string",
          "phone": "string"
        }
      ]
    },
    "clauses": [
      {
        "key": "string",
        "title": "string",
        "body": "string",
        "origin": "library",
        "version": 0
      }
    ],
    "slots": [
      {
        "key": "string",
        "required": true,
        "included": true
      }
    ],
    "changes": {
      "added": [
        {
          "key": "string",
          "title": "string"
        }
      ],
      "removed": [
        {
          "key": "string",
          "title": "string"
        }
      ],
      "moved": [
        {
          "key": "string",
          "title": "string",
          "from": 0,
          "to": 0
        }
      ],
      "edited": [
        {
          "key": "string",
          "title": "string",
          "diff": [
            {
              "op": null,
              "text": null
            }
          ]
        }
      ]
    },
    "library": [
      {
        "key": "string",
        "title": "string",
        "category": "string",
        "origin": "string",
        "version": 0,
        "applies": true,
        "body": "string"
      }
    ],
    "preview": {
      "title": "string",
      "blocks": [
        {
          "kind": "heading",
          "segments": [
            null
          ]
        }
      ],
      "missing": [
        {
          "key": "string",
          "label": "string"
        }
      ],
      "unknown": [
        "string"
      ]
    },
    "stamp": {
      "status": "estimated",
      "rule": {
        "id": "string",
        "label": "string",
        "effective_from": "2026-10-06",
        "source": {
          "title": "string",
          "url": "string",
          "retrieved_on": "2026-10-06"
        },
        "verified": true,
        "note": "string",
        "origin": "system"
      },
      "term": {
        "months": 0,
        "days": 0
      },
      "total_rent": 850000000,
      "average_annual_rent": 850000000,
      "base_lines": [
        {
          "label": "string",
          "amount": 850000000
        }
      ],
      "base": 850000000,
      "duty": 850000000,
      "registration_required": true,
      "registration_fee": 850000000,
      "extra": {
        "label": "string",
        "amount": 850000000
      },
      "total": 850000000,
      "e_stamp": true,
      "warnings": [
        "string"
      ]
    },
    "stamp_override": {
      "duty": 850000000,
      "registration_fee": 850000000,
      "reason": "string"
    },
    "stamp_certificate_no": "string",
    "registration_plan": "string",
    "signed_at": "2026-10-06T05:30:00.000Z",
    "has_signed_pdf": true,
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "envelope": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "preparing",
    "provider": "string",
    "signing_order": "string",
    "document_version": 0,
    "estamp": {
      "state": "string",
      "denomination": 850000000,
      "status": "string",
      "certificate_no": "string"
    },
    "expires_at": "2026-10-06T05:30:00.000Z",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "cancel_reason": "string",
    "has_signed_pdf": true,
    "has_audit_trail": true,
    "signers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "role": "string",
        "name": "string",
        "phone": "string",
        "sign_type": "string",
        "order": 0,
        "status": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "aadhaar_masked": "string",
        "certificate_name": "string",
        "link_status": "string",
        "invited_at": "2026-10-06T05:30:00.000Z",
        "opened_at": "2026-10-06T05:30:00.000Z",
        "blocked_reason": "string"
      }
    ],
    "events": [
      {
        "kind": "string",
        "source": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ]
  },
  "registration": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "plan": "string",
    "plan_label": "string",
    "status": "open",
    "steps": [
      {
        "key": "string",
        "title": "string",
        "detail": "string",
        "due_on": "2026-10-06",
        "task_id": "string",
        "task_status": "open"
      }
    ],
    "registration_no": "string",
    "registered_on": "2026-10-06",
    "office": "string",
    "assignee": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    }
  },
  "credits": [
    {
      "denomination": 850000000,
      "available": 0
    }
  ],
  "esign_configured": true,
  "capabilities": {
    "edit": true,
    "send": true,
    "cancel": true,
    "register": true
  }
}

{ "agreement": { "id": "cmusrceel0000q7kaafxqi1om", "status": "string", "start_date": "2026-10-06", "end_date": "2026-10-06", "term_months": 0, "rent_amount": 850000000, "deposit_amount": 850000000, "agreement_type": "string", "landlord": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "phone": "string" }, "tenant": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "phone": "string" }, "property": { "id": "cmusrceel0000q7kaafxqi1om", "title": "string", "state": "string" }, "state": "string" }, "templates": [ { "key": "string", "origin": "system", "system_key": "string", "kind": "leave_licence", "states": [ "string" ], "title": "string", "description": "string", "execution": "notarised", "version": 0, "status": "active", "updated_at": "2026-10-06T05:30:00.000Z", "fits": true } ], "suggested_template": "string", "document": { "id": "cmusrceel0000q7kaafxqi1om", "version": 0, "status": "draft", "template": { "key": "string", "version": 0, "title": "string", "current_version": 0 }, "kind": "leave_licence", "kind_label": "string", "state": "string", "execution": "notarised", "area": "string", "title": "string", "fields": { "place": "string", "execution_date": "2026-10-06", "landlord": { "relation": "string", "age": 0, "address": "string" }, "tenant": { "relation": "string", "age": 0, "address": "string" }, "property_address": "string", "property_description": "string", "city": "string", "inclusions": [ "string" ], "special_conditions": "string", "non_refundable_amount": 850000000, "witnesses": [ { "name": "string", "address": "string", "phone": "string" } ] }, "clauses": [ { "key": "string", "title": "string", "body": "string", "origin": "library", "version": 0 } ], "slots": [ { "key": "string", "required": true, "included": true } ], "changes": { "added": [ { "key": "string", "title": "string" } ], "removed": [ { "key": "string", "title": "string" } ], "moved": [ { "key": "string", "title": "string", "from": 0, "to": 0 } ], "edited": [ { "key": "string", "title": "string", "diff": [ { "op": null, "text": null } ] } ] }, "library": [ { "key": "string", "title": "string", "category": "string", "origin": "string", "version": 0, "applies": true, "body": "string" } ], "preview": { "title": "string", "blocks": [ { "kind": "heading", "segments": [ null ] } ], "missing": [ { "key": "string", "label": "string" } ], "unknown": [ "string" ] }, "stamp": { "status": "estimated", "rule": { "id": "string", "label": "string", "effective_from": "2026-10-06", "source": { "title": "string", "url": "string", "retrieved_on": "2026-10-06" }, "verified": true, "note": "string", "origin": "system" }, "term": { "months": 0, "days": 0 }, "total_rent": 850000000, "average_annual_rent": 850000000, "base_lines": [ { "label": "string", "amount": 850000000 } ], "base": 850000000, "duty": 850000000, "registration_required": true, "registration_fee": 850000000, "extra": { "label": "string", "amount": 850000000 }, "total": 850000000, "e_stamp": true, "warnings": [ "string" ] }, "stamp_override": { "duty": 850000000, "registration_fee": 850000000, "reason": "string" }, "stamp_certificate_no": "string", "registration_plan": "string", "signed_at": "2026-10-06T05:30:00.000Z", "has_signed_pdf": true, "updated_at": "2026-10-06T05:30:00.000Z" }, "envelope": { "id": "cmusrceel0000q7kaafxqi1om", "status": "preparing", "provider": "string", "signing_order": "string", "document_version": 0, "estamp": { "state": "string", "denomination": 850000000, "status": "string", "certificate_no": "string" }, "expires_at": "2026-10-06T05:30:00.000Z", "sent_at": "2026-10-06T05:30:00.000Z", "completed_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "cancel_reason": "string", "has_signed_pdf": true, "has_audit_trail": true, "signers": [ { "id": "cmusrceel0000q7kaafxqi1om", "role": "string", "name": "string", "phone": "string", "sign_type": "string", "order": 0, "status": "string", "signed_at": "2026-10-06T05:30:00.000Z", "aadhaar_masked": "string", "certificate_name": "string", "link_status": "string", "invited_at": "2026-10-06T05:30:00.000Z", "opened_at": "2026-10-06T05:30:00.000Z", "blocked_reason": "string" } ], "events": [ { "kind": "string", "source": "string", "created_at": "2026-10-06T05:30:00.000Z" } ] }, "registration": { "id": "cmusrceel0000q7kaafxqi1om", "plan": "string", "plan_label": "string", "status": "open", "steps": [ { "key": "string", "title": "string", "detail": "string", "due_on": "2026-10-06", "task_id": "string", "task_status": "open" } ], "registration_no": "string", "registered_on": "2026-10-06", "office": "string", "assignee": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "credits": [ { "denomination": 850000000, "available": 0 } ], "esign_configured": true, "capabilities": { "edit": true, "send": true, "cancel": true, "register": true } }