Skip to main content

Payments Breakdown

Introduction​

This guide explains how to use the Breakdown page in My Home Plan to view and manage individual payment transactions for a selected account type and company. You can review running balances, inspect details, edit or delete transactions, and (for super‑admins) approve or decline pending items.

Accessing the Page​

  1. From the left sidebar, click Payments.
  2. Choose Breakdown.
  3. You can also deep‑link with URL parameters:
    • ?company=<companyId> — scope data to a specific company.
    • &accountType=<name> — preselect an account type by name.
    • &status=pending|approved|declined — filter by status.

Navigating the Page​

  • Breadcrumbs: Shows the current location as Break Down.
  • Account Type Selector:
    • Dropdown listing available account types for the active company.
    • Disabled if accountType is provided via URL.
  • Loading Indicator: Spinner appears while fetching account types or transactions.
  • Balance Header: Displays the current balance for the selected scope (sum of income minus expense across the loaded rows).
  • Transactions Table:
    • Service — Service type of the transaction.
    • Related Lead — Client name and (if available) the assigned agent.
    • Amount — Shown in AED with thousands separators; green for income and red for expense.
    • Description — Free‑text notes for the transaction.
    • Transaction Date — Relative time (e.g., “2 hours ago”).
    • Company — The company associated with the transaction.
    • Created By — The user who recorded the transaction.
    • Balance — Running balance from this row to the end of the list (positive in green, negative in red).
    • Actions — Contextual buttons (see below).
  • Transaction Details Modal: Opens when you click View, showing full transaction details and attachments. For client‑facing views, the type label is adjusted (e.g., Buy/Return).

Key Features​

  • Company & Account‑Aware Filtering: Data is scoped by company and account type. You can use query params or the selector.
  • Status Filter (URL): Optionally narrow results by status=pending|approved|declined when deep‑linking.
  • Running Balance Column: Quickly see how each row affects the cumulative balance going forward.
  • Role‑Gated Actions (only for super‑admin and when a row is pending):
    • Approve — Marks the payment as approved.
    • Decline — Marks the payment as declined.
  • Edit / Delete: Update or remove a transaction (shows a confirmation modal for deletes).
  • View Details: Open a modal to see all metadata and any uploaded attachments.

Common Tasks​

  1. Select an Account Type
    • Use the Account Type dropdown.
    • If provided via URL (accountType=), the dropdown is locked to that value.
  2. Review Running Balance
    • Check the Balance column to see the cumulative effect starting from a given transaction.
  3. Inspect a Transaction
    • Click View to open the details modal and review attachments.
  4. Edit or Delete a Transaction
    • Click Edit to modify.
    • Click Delete to remove (confirm in the dialog).
  5. Approve or Decline (Super‑Admin)
    • For pending rows, use Approve or Decline to change status.

Troubleshooting​

  • No Transactions Displayed
    • Ensure a valid company and account type are selected (or provided in the URL).
    • There may simply be no transactions matching the current filters.
  • Account Type Dropdown Disabled
    • The page was opened with an accountType query param. Remove it from the URL to change the selection.
  • Actions Disabled While Loading
    • The page is fetching data or processing an update; try again once the spinner disappears.
  • Cannot Approve/Decline
    • Only super‑admins see these buttons and only for pending transactions.

Contact Support​

Reach out via: