Skip to main content

Installments

Introduction​

This guide explains how to use the Installments page in My Home Plan to search, filter, view, edit, and delete installment groups, and to create new installment schedules when authorized.

Accessing the Page​

  1. From the left sidebar, click Installments.
  2. You will be directed to the Installments list for the current company context.

Navigating the Page​

  • Breadcrumbs: Shows the current location as Installments.
  • Create Installment (role-gated): Visible when a company is selected and your role is admin, super-admin, or finance. Opens the creation screen.
  • Filters:
    • Search — free‑text filter on installment groups.
    • Client — searchable dropdown of clients.
    • Developer — searchable dropdown of developers.
    • Project — searchable dropdown of projects.
    • Clear filters — resets all filters to defaults.
  • Loading Indicator: Spinner appears near the Create Installment button while data is loading.
  • Error Banner: Red alert appears at the top if an API error occurs.
  • Installments Table (sortable):
    • Name — Click to open the client installment group page (/clientInstallments/:id). If the group is linked to a project, the project name is shown; otherwise the group name.
    • Client — One or more clients; each name links to /clients/:id. If an agent is assigned, it appears in parentheses.
    • Total due payments — If 0, displays Paid in green; otherwise shows the outstanding amount in red.
    • Unit Number — Unit reference or N/A.
    • City — City or N/A.
    • Attachments — Count of uploaded attachments for the group.
    • Created At — Creation date in DD/MM/YYYY format.
    • Actions — Edit, Delete, View.
  • Delete Confirmation: A modal asks for confirmation before removing a group.

Key Features​

  • Company‑Aware Data: Results are scoped to the currently selected company.
  • Rich Filters: Combine text search with Client/Developer/Project dropdowns to narrow results.
  • Sortable Table: Click column headers to sort when enabled.
  • Inline Navigation: Quick links to client details and installment group details.
  • Role‑Gated Creation: Only admin, super-admin, or finance can create installments (and only when a company is selected).
  • Status Cue: Immediate visual feedback for fully paid groups (Paid in green).

Common Tasks​

  1. Create a New Installment Group (admin / super-admin / finance)
    • Ensure a company is selected.
    • Click Create Installment.
    • Fill in the required fields on the creation screen and save.
  2. Filter Installment Groups
    • Use Search, Client, Developer, and Project to refine the list.
    • Click Clear filters to reset all selections.
  3. Open Group Details
    • Click Name or View to go to /clientInstallments/:id.
  4. Open a Client Profile
    • In the Client column, click the client name to open /clients/:id.
  5. Edit a Group
    • Click Edit in the Actions column to open the edit screen at /installments/:id.
  6. Delete a Group
    • Click Delete, then confirm in the dialog.

Troubleshooting​

  • “Please Select Company to add records”
    • You’re trying to create a group without an active company selected. Choose a company first.
  • No Results After Filtering
    • Clear filters and try again; expand your search terms.
  • Error Banner Appears (red box)
    • The message comes from the API. Retry the action or contact support if it persists.
  • Table Doesn’t Update
    • Wait a moment (results are debounced), or refresh the page.

Contact Support​

Reach out via: