Skip to main content

Payments Overview

Introduction​

This guide explains how to use the Payments overview page in My Home Plan to review aggregated balances by account, create new payments, and initiate transfers for the selected company.

Accessing the Page​

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

Navigating the Page​

  • Breadcrumbs: Shows the current location as Payments.
  • Primary Actions (visible when a company is selected):
    • Add Payments — opens the payment form modal to create a new entry.
    • Transfer — opens the transfer modal to move funds between accounts.
  • Search Bar: Text input labeled “Search by account type” to filter results (updates after a short delay).
  • Clear Filters: Resets the search query and reloads results.
  • Loading Indicator: Spinner appears near the action buttons while data is loading.
  • Error Banner: Red alert appears at the top if an API error occurs.
  • Payments Table (Aggregated):
    • Account — account type (e.g., Cash, Bank Transfer).
    • Total Income — sum of income for the account.
    • Total Expense — sum of expense for the account.
    • Balance — income minus expense (green if positive, red if negative).
    • Company — associated company name.

Key Features​

  • Company‑Aware Data: Results are scoped to the currently selected company (when available).
  • Aggregation by Account: Rows display totals computed from all matching payments for each account type.
  • Inline Formatting: Currency is shown in AED with thousands separators.
  • Quick Actions: Create payments or transfers directly from the overview.
  • Filter as You Type: Search by account type (debounced to reduce unnecessary requests).

Common Tasks​

  1. Add a New Payment
    • Click Add Payments to open the payment modal.
    • Fill in the required fields and save.
  2. Initiate a Transfer
    • Click Transfer to open the transfer modal.
    • Enter source, destination, and amount, then confirm.
  3. Filter Accounts
    • Type an account name (e.g., Cash, Bank) in the search bar.
    • Click Clear filters to reset.

Troubleshooting​

  • No Company Selected
    • The page will show “Please Select Company to add records” and actions will be disabled. Choose a company first.
  • No Results After Filtering
    • Clear the search or try a different account name.
  • Error Banner Appears (red box)
    • The message comes from the API. Retry or contact support if it persists.
  • Spinner Keeps Spinning
    • Check your internet connection and try again.

Contact Support​

Reach out via: