Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

Edit Payment Plan provides a form for updating an existing payment plan’s details, including name, customer, linked invoice, amount, installment count, payment frequency, and dates. Route: /fa/payment-plans/:id/edit.

​
Overview

The Edit Payment Plan page is accessible at /fa/payment-plans/:id/edit and requires permission fa.payment_plans.edit. The component (PaymentPlanEditPage) fetches the existing plan via usePaymentPlan(id, organizationId). It renders PaymentPlanForm pre-populated with current values. On submit, useUpdatePaymentPlan is called with updated fields: plan_name, customer_id, invoice_id, total_amount, number_of_installments, payment_frequency, start_date, end_date, and updated_by. On success the page navigates to /fa/payment-plans/:id. The breadcrumb shows Edit <plan_number>.

​
Who it’s for

Requires permission fa.payment_plans.edit.

​
Before you start

  • You must have fa.payment_plans.edit permission.
  • The payment plan must be in a status that permits editing (SME: confirm).

​
Steps

  1. Navigate to the Receivables Hub (/fa/receivables?tab=payment-plans) and open the payment plan.
  2. Click Edit to go to /fa/payment-plans/:id/edit.
  3. Update the relevant fields in PaymentPlanForm.
  4. Click Save to submit.
  5. On success, the page navigates to the payment plan detail.

​
Key concepts

ConceptDescription
PaymentPlanFormShared form for payment plan create and edit workflows
usePaymentPlanHook fetching the existing plan, scoped to organizationId
useUpdatePaymentPlanMutation hook persisting payment plan edits
payment_frequencySME: confirm allowed values and billing cadence

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/PaymentPlanEditPage.tsx