Skip to main content
The Payment Plans list is part of the Accounts Receivable hub (/fa/receivables?tab=payment-plans; the legacy /fa/payment-plans route redirects there). It supports filtering by status and customer, displays summary cards, and provides actions to create, submit for approval, and delete plans.

​
Who it’s for

Access follows your organization’s role and module configuration. The Payment Plans tab within the AR hub is accessible to users who can reach /fa/receivables. Viewing a plan requires fa.payment_plans.view; creating requires fa.payment_plans.create; editing requires fa.payment_plans.edit.

​
Finding a plan

  1. Navigate to Finance & Revenue → Accounts Receivable → Payment Plans, or go to /fa/receivables?tab=payment-plans.
  2. Use filters (status, customer) and search to locate plans.
  3. Select a plan to view its details.
  4. Use New Payment Plan to create a plan.

​
Viewing a payment plan

Selecting a plan opens its detail view at /fa/payment-plans/:id (permission: fa.payment_plans.view): plan header fields (customer, total amount, paid amount, status), a progress bar, and tabbed views including the installment schedule. Available actions — submit for approval, approve/reject, cancel, delete, edit — depend on the plan’s current status.
  1. Review the plan summary: customer, total, amount paid, and status.
  2. View the installment schedule in the installments tab.
  3. Use action buttons to submit for approval, approve/reject, cancel, or edit as appropriate for the plan’s current status.
Status lifecycle — draft → pending_approval → approved → active → completed (or cancelled / defaulted). Installment statuses — pending, paid, partial, overdue, skipped. Progress bar — Reflects the proportion of total_paid to total plan amount.

​
Creating a payment plan

The New Payment Plan form (/fa/payment-plans/new, permission: fa.payment_plans.create) creates a structured repayment agreement; the platform generates installment records automatically on save. Before you start: confirm the customer record exists, and know the total amount, number of installments, payment frequency, and start date. An optional linked invoice may be provided.
  1. From the Payment Plans tab, select New Payment Plan, or go to /fa/payment-plans/new.
  2. Complete the form fields: plan name, customer, invoice (optional), total amount, number of installments, payment frequency, and start date.
  3. Optionally enter an end date.
  4. Select Create. The plan is saved as draft and installments are generated automatically.
  5. You are redirected to the plan’s detail view to review the installment schedule.

​
Editing a payment plan

The edit form (/fa/payment-plans/:id/edit, permission: fa.payment_plans.edit) updates an existing plan’s name, customer, linked invoice, amount, installment count, payment frequency, and dates. The plan must be in a status that permits editing.
  1. Open the payment plan and click Edit.
  2. Update the relevant fields.
  3. Click Save. On success you return to the plan’s detail view.

Finance & Revenue

Finance & Revenue core overview.

Governance & parity

This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/fa.tsx
  • src/cores/fa/pages/PaymentPlansPage.tsx
  • src/cores/fa/pages/ReceivablesHubPage.tsx
  • src/cores/fa/pages/PaymentPlanDetailPage.tsx
  • src/cores/fa/pages/PaymentPlanCreatePage.tsx
  • src/cores/fa/pages/PaymentPlanEditPage.tsx
  • src/cores/fa/hooks/usePaymentPlans.ts
  • src/cores/fa/components/PaymentPlanApprovalDialog.tsx
  • src/cores/fa/components/PaymentPlanForm.tsx