Skip to main content

Add Installment Group

Introduction​

This guide explains how to use the Add / Edit Installment Group screen in My Home Plan to create an installment schedule, manage installment items and fees, upload attachments, and assign clients and users.

Accessing the Page​

  1. From the left sidebar, click Installments.
  2. Click Create Installment to add a new group, or choose Edit from the list to modify an existing one.

Page States​

  • Create Mode: Header shows Add Installment Group and a button Add From Document Using AI.
  • Edit Mode: Header shows Edit Installment Group and loads existing data for the selected group.

Validation & Requirements​

  • Project is required.
  • At least one client is required.
  • Every installment item must have Amount > 0; non‑fee items must also have a Due Date.
  • Default fees (Administration Fee, SPA Registration Fee, Dubai Land Department Fee) cannot be deleted.

Layout & Sections​

1) Group Information​

  • Project Name (select) — choose an existing project; use + to create a project on the fly.
  • Description (optional)
  • City (optional)
  • Unit Number (optional)
  • Related Client (multi‑select) — pick one or more clients; in edit mode, this field is disabled unless you are a super‑admin.
  • Add Client button — opens the client creation form in a modal.
  • Allowed Users (super‑admin only, multi‑select) — when empty, all users are allowed; otherwise, only selected users.

2) Installments​

  • List of non‑fee installment rows, each with:
    • Due Date (with Post Handover toggle that locks the date field when enabled)
    • Amount (numbers only)
    • Percentage (0–100, decimals allowed)
    • Name (description)
    • Delete icon (disabled for default fees; available for custom items)
  • Add Installment button — append a new installment row.
  • Add Bulk — opens Bulk Generate modal to create many rows at once.

3) Fees​

  • List of fee rows (e.g., Administration Fee, SPA Registration Fee, Dubai Land Department Fee). These are treated as isFee = true.
  • Add Fee — append a custom fee row (custom fees can be removed; defaults cannot).

4) Attachments​

  • Shows existing attachments with View and Delete.
  • Drag & Drop / Browse / Paste to add files (max size 30 MB each).
  • Newly added files appear in a New Attachments list where you can set a Title and remove before saving.

AI Document Import (Create Mode)​

  • Click Add From Document Using AI to upload .pdf, .doc, or .docx.
  • The system parses the document and proposes installment rows (amount, description, due date, percentage, fee flag, status) which are inserted into the list.
  • While processing, a blurred overlay with a loading spinner is shown.

Bulk Generate Modal​

  • Date gap: choose 1/2/3/6 months.
  • Number of rows.
  • Start date.
  • Name (description for each generated row).
  • Percentage and Amount — at least one must be greater than zero.
  • Validation prevents the total percentage of existing plus generated rows from exceeding 100%.

Actions​

  • Create / Update (primary button at the bottom‑right): saves the group and items.
  • On Create, the group is posted first, then installments are created; attachments are uploaded last.
  • On Edit, only changed group fields are sent; installments are bulk updated when modified and bulk created for new items.
  • After successful save, you are redirected to /clientInstallments/:id.

Error Handling & Loading​

  • Inline red banner at the top shows validation or API errors.
  • Saving... state appears on the primary button during requests.
  • Spinners appear while fetching group data, clients, projects, existing installments, or attachments.

Role & Company Context​

  • The screen requires an active company context; if none is selected, a message appears and the form is not usable.
  • In Edit Mode, if the group belongs to a different company than the one selected, a notice is shown and the screen is blocked.

Common Tasks​

  1. Create a New Group
    • Open Create Installment, pick Project, select Client(s), and fill optional fields.
    • Add installments individually, via Add Bulk, or by AI import.
    • (Optional) add Fees and Attachments.
    • Click Create.
  2. Edit an Existing Group
    • Open Edit Installment Group.
    • Change details or items; remove custom items as needed.
    • Click Update.
  3. Upload Attachments
    • Drag & drop, browse, or paste files; set titles; save.
  4. Generate a Schedule Quickly
    • Use Add Bulk with gap and rows; ensure overall percentage does not exceed 100%.

Troubleshooting​

  • Project is required or Lead/Client is required: Select the missing fields in Group Information.
  • All installments must have a valid amount / due date: Ensure non‑fee items have a date and every item has a positive amount.
  • Default fee items cannot be deleted: You can only remove custom fees.
  • Total percentage would exceed 100%: Reduce rows or percentage in the Bulk Generate modal.
  • This group doesn’t belong to the selected company: Switch to the correct company.

Contact Support​

Reach out via: